Skip to content
rigid.fi

List KYC checks

GET/v1/kyc/checks

Requires an API client bearer token.

Lists KYC checks for the authenticated tenant, newest first. Filter by public state, programme, and flow_key; cursor-paginated. flow_key is a plain equality filter on the stamped flow — an unmatched value returns an empty page, never a 400. Ageing against the case TTL is visible via created_at and expires_at. reason_codes is sourced from each case's latest decision and present only once a decision exists.

Parameters

Query parameters

NameRequiredDescription
stateoptional
programme_idoptional
flow_keyoptional
cursoroptional
limitoptional

Example

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

Responses

200

A page of KYC checks.

dataarray of objectrequired
+ show properties
idstringrequired
cardholder_idstringrequired
state"pending" | "in_review" | "passed" | "failed" | "expired"required
completed_atstring | nullrequired
created_atstringrequired
expires_atstring | nullrequired
reason_codesarray of string
awaitingarray of string
document_type"passport" | "national_id" | "residence_permit" | "driving_licence"
flow_keystringrequired
has_morebooleanrequired
next_cursorstring | nullrequired
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