Archive or restore a KYC level
/v1/kyc/levels/{level_key}Requires an API client bearer token.
Archives (`archived: true`) or restores (`archived: false`) a level. Archiving is soft and reversible; there is no delete. A level that a DRAFT workflow references cannot be archived: 409 `level_in_use` with `workflows`, the flow keys to fix first. Published policies keep their own snapshot and are unaffected. Requires Idempotency-Key and the programme_admin role.
Parameters
Path parameters
| Name | Required | Description |
|---|---|---|
| level_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/levels/{level_key} \
-H "Authorization: Bearer $RIGID_API_TOKEN" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"programme_id": "uuid",
"archived": true
}'Responses
200The level after the change.
+ show properties− hide properties
+ show properties− hide properties
+ show properties− hide properties
One of
typed
+ show properties− hide properties
block
untyped
+ show properties− hide properties
400Validation error
401Authentication required
403Forbidden
404No level with this key for this programme
409A draft workflow references the level (code `level_in_use`, with `workflows`), or the Idempotency-Key was reused with a different payload
429Too many policy writes from this caller — see Retry-After
500Internal server error