Skip to content
rigid.fi

Get the active KYC policy for a programme

GET/v1/kyc/policy

Requires an API client bearer token.

Returns the current (highest-version) policy for the given programme, seeding version 1 from the platform default on first read. Policy is scoped per (tenant, mode, programme) — test and live modes carry independent histories. The response includes `flow`, the composed, ready-to-render flow view for this policy. Accepts an optional `flow_key` selector (default `'default'`); an unknown key 400s `unknown_flow`. The resolved key is echoed back as `flow_key`. Requires membership of the programme: the selector's 400-vs-200 split is programme knowledge, not a tenant-wide read, so a caller pinned to another programme in the tenant 403s.

Parameters

Query parameters

NameRequiredDescription
programme_idrequired
flow_keyoptional

Example

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

Responses

200

The active policy for the programme.

idstringrequired
versionintegerrequired
definitionobjectrequired
+ show properties
required_inputsarray of stringrequired
required_signalsarray of stringrequired
bandsobjectrequired
+ show properties
approve_at_or_abovenumberrequired
reject_belownumberrequired
weightsobjectrequired
+ show properties

No properties.

provenance_weightsobject
+ show properties
face_matchobjectrequired
+ show properties
controllednumberrequired
submittednumberrequired
selfie_capture"any" | "controlled_only"
accepted_document_typesarray of "passport" | "national_id" | "residence_permit" | "driving_licence"
refer_onarray of stringrequired
reject_onarray of stringrequired
ttl_secondsintegerrequired
retention_secondsintegerrequired
step_orderarray of "details" | "document" | "selfie"
required_fieldsarray of string
optional_fieldsarray of string
field_orderarray of string
field_configobject
+ show properties

No properties.

rulesobject
+ show properties
min_ageinteger
allowed_nationalitiesarray of string
created_atstringrequired
capabilitiesobject
+ show properties
controlled_capturebooleanrequired
document_extractionbooleanrequired
flowobject
+ 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
flow_keystring
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