Rename, archive or unarchive a KYC flow
/v1/kyc/flows/{flow_key}Requires an API client bearer token.
Updates a flow's display identity and archived state. `display_name` and `archived` are both optional and at least one must be present (400 otherwise); each present field is applied and audited separately, so one call may do both. `flow_key` is PERMANENT and cannot be changed — it is stamped into every policy version, case and branding row the flow has produced. ARCHIVING IS SOFT AND REVERSIBLE, and there is no delete: `archived: true` retires the flow from selection (starting a check, minting a preview, or writing policy/branding under it all refuse with `flow_archived`) while every existing case keeps reading the policy version it is pinned to; `archived: false` restores it. The reserved `default` flow can be neither renamed nor archived (400 `flow_key_reserved`). An unknown flow key is a 404, and does NOT consume the Idempotency-Key — the same key may be retried once the flow exists. Requires Idempotency-Key and the programme_admin role. Returns the same `KycFlowSummary` row `GET /v1/kyc/flows` returns, ready to drop straight back into the flows index.
Parameters
Path parameters
| Name | Required | Description |
|---|---|---|
| flow_key | required |
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 PATCH https://api.rigid.fi/v1/kyc/flows/{flow_key} \
-H "Authorization: Bearer $RIGID_API_TOKEN" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"programme_id": "uuid"
}'Responses
200The updated flow, as one row of the flows index.
+ show properties− hide properties
+ show properties− hide properties
+ show properties− hide properties
+ show properties− hide properties
+ show properties− hide properties
400Validation error
401Authentication required
403Forbidden
404No flow with this `flow_key` for this programme
409Idempotency-Key reused with a different payload
429Too many KYC writes from this caller — see Retry-After
500Internal server error