Skip to content

Request a document re-capture on a referred KYC check

POST/v1/kyc/checks/{id}/recapture

Requires an API client bearer token.

Reopens a referred case for one more document scan instead of forcing an approve/reject decision on what it already has: transitions referred -> evaluating, opens the case's re-capture window, records a recapture_requested decision naming the human reviewer, and mints a fresh capture-session token for the applicant. Emits no kyc.check.completed — nothing has completed. Only a referred case may be re-captured.

Parameters

Path parameters

NameRequiredDescription
idrequired

Header parameters

NameRequiredDescription
Idempotency-Keyrequired

Client-chosen. An identical retry with the same key returns the stored response; reusing the key with a different payload returns 409.

Request body

reviewer_namestringrequired
rationalestring

Example

curl -X POST https://api.rigid.fi/v1/kyc/checks/{id}/recapture \
  -H "Authorization: Bearer $RIGID_API_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "reviewer_name": "string"
}'

Responses

200

The re-capture window is open; a fresh capture session was minted.

checkobjectrequired
+ show properties
idstringrequired
cardholder_idstringrequired
state"pending" | "in_review" | "passed" | "failed" | "expired"required
completed_atstring | nullrequired
created_atstringrequired
expires_atstring | nullrequired
reason_codesarray of string
awaitingarray of string
document_type"passport" | "national_id" | "residence_permit" | "driving_licence"
flow_keystringrequired
tokenstringrequired
expires_atstring (date-time)required
session_idstringrequired
capture_urlstring (uri)required
400

Validation error

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
401

Authentication required

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
403

Forbidden

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
404

No such check

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
409

Idempotency-Key reused with a different payload

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
429

Too many KYC writes from this caller — see Retry-After

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
500

Internal server error

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring