Skip to content
rigid.fi

List the KYC levels of a programme

GET/v1/kyc/levels

Requires an API client bearer token.

The programme's reusable level definitions, archived ones included, ordered by display name. `used_by` lists the flow keys whose draft or active workflow references the level.

Parameters

Query parameters

NameRequiredDescription
programme_idrequired

Example

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

Responses

200

The programme's levels.

dataarray of objectrequired
+ show properties
level_keystringrequired
display_namestringrequired
archived_atstring
screensintegerrequired
fieldsintegerrequired
used_byarray of stringrequired
updated_atstringrequired
400

Validation error

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
401

Authentication required

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
403

Forbidden

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
500

Internal server error

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring