Skip to content
rigid.fi

Read one KYC level

GET/v1/kyc/levels/{level_key}

Requires an API client bearer token.

One level of the programme, with its full definition and the flows that reference it.

Parameters

Path parameters

NameRequiredDescription
level_keyrequired

Query parameters

NameRequiredDescription
programme_idrequired

Example

curl https://api.rigid.fi/v1/kyc/levels/{level_key} \
  -H "Authorization: Bearer $RIGID_API_TOKEN"

Responses

200

The level.

level_keystringrequired
display_namestringrequired
archived_atstring
screensintegerrequired
fieldsintegerrequired
used_byarray of stringrequired
updated_atstringrequired
definitionobjectrequired
+ show properties
screensarray of objectrequired
+ show properties
idstringrequired
titlestring
skip_if_knownboolean
fieldsarray of one ofrequired
+ show properties

One of

typed

idstringrequired
kind"typed"required
key"given_name" | "family_name" | "date_of_birth" | "nationality" | "document_number" | "document_expiry" | "document_issuing_state" | "address_line1" | "address_postcode" | "address_country"required
requiredbooleanrequired
input"text" | "dropdown" | "date"
hintstring
optionsarray of object
+ show properties
idstringrequired
valuestringrequired
labelstringrequired
visible_whenstring
patternstring
skip_if_knownboolean

block

idstringrequired
kind"block"required
block"document" | "selfie" | "proof_of_address"required

untyped

idstringrequired
kind"untyped"required
input"text" | "number" | "dropdown" | "checkbox" | "radio" | "upload"required
labelstringrequired
requiredbooleanrequired
hintstring
optionsarray of object
+ show properties
idstringrequired
valuestringrequired
labelstringrequired
visible_whenstring
patternstring
400

Validation error

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
401

Authentication required

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
403

Forbidden

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
404

No level with this key for this programme

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
500

Internal server error

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring