Skip to content
rigid.fi

List the KYC flows for a programme

GET/v1/kyc/flows

Requires an API client bearer token.

Returns the flows index for a programme: the constructive default flow first, then every registered flow (`kyc_flows`) ordered by created_at ascending. Archived flows are included — the console filters them client-side. Requires the programme_admin role: flow existence is admin knowledge, not a plain console member's read.

Parameters

Query parameters

NameRequiredDescription
programme_idrequired

Example

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

Responses

200

The flows index for the programme.

dataarray of objectrequired
+ show properties
flow_keystringrequired
display_namestringrequired
is_defaultbooleanrequired
archived_atstring
active_versionintegerrequired
has_draftbooleanrequired
flowobjectrequired
+ show properties
stepsarray of "details" | "document" | "selfie"required
fieldsarray of objectrequired
+ show properties
keystringrequired
requiredbooleanrequired
locked_byarray of string
input"text" | "dropdown" | "date"
hintstring
optionsarray of object
+ show properties
valuestringrequired
labelstring
rulesobjectrequired
+ show properties
min_ageinteger
allowed_nationalitiesarray of string
brandingobject
+ show properties
display_namestring
accent_lightstring
accent_darkstring
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