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.

Parameters

Query parameters

NameRequiredDescription
programme_idrequired

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.

refer_onarray of stringrequired
reject_onarray of stringrequired
ttl_secondsintegerrequired
retention_secondsintegerrequired
created_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