Start a KYC check
/v1/kyc/checksRequires an API client bearer token.
Opens a verification case for a cardholder in `collecting`, pinned to the programme's active policy version. Requires an Idempotency-Key header. The case advances once the required applicant data and signals are in place; completion is signalled via the kyc.check.completed event. Accepts an optional `flow_key` selector (default 'default'), pinning the case to that flow's policy lineage ONCE, at creation; an unknown key 400s `unknown_flow` before any storage is touched, so the Idempotency-Key is never consumed by a rejected flow.
Parameters
Header parameters
| Name | Required | Description |
|---|---|---|
| Idempotency-Key | required | Client-chosen. An identical retry with the same key returns the stored response; reusing the key with a different payload returns 409. |
Request body
Example
curl -X POST https://api.rigid.fi/v1/kyc/checks \
-H "Authorization: Bearer $RIGID_API_TOKEN" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"cardholder_id": "string"
}'Responses
201Check started (pending).
400Validation error
401Authentication required
403Forbidden
409Idempotency-Key reused with a different payload
429Too many KYC writes from this caller — see Retry-After
500Internal server error