Skip to content

Attach a selfie image to a KYC check

POST/v1/kyc/checks/{id}/selfie-image

Requires an API client bearer token.

Attaches a selfie image to a case for face-match comparison against its retained document image (S5a) — the API-population intake path, called by a programme manager’s own backend on the applicant’s behalf (no capture widget, no operator supervision). The image is stored under purpose-bound custody and referenced by token, exactly like the document image; a replacement selfie erases the one it supersedes. If the case is already evaluating and the active policy requires `face_match`, a fresh evaluation is enqueued. Requires an Idempotency-Key header. Callable by `user` or `admin` callers, which includes API clients (OAuth2 client-credentials).

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

selfie_image_base64stringrequired

Example

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

Responses

200

The selfie image was attached.

case_idstringrequired
selfie_attachedtruerequired
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

The case is in a terminal state and can no longer accept a selfie image, or the Idempotency-Key was 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