Skip to content

Read a KYC check’s captured document image

GET/v1/kyc/checks/{id}/document-image

Requires an API client bearer token.

The case's captured document image, narrowed to the custody `review` purpose — the same human-adjudication slice `getCheckApplicant` reads from, extended (S9) to include the retained image. Every read is reported to pii-vault's audit pipeline (`access_recorded: true`) on a best-effort basis — an audit-publish failure never fails the read itself, so this is not an unconditional guarantee — attributed to the identity-kyc service principal, not to the individual console user who made the request.

Parameters

Path parameters

NameRequiredDescription
idrequired

Example

curl https://api.rigid.fi/v1/kyc/checks/{id}/document-image \
  -H "Authorization: Bearer $RIGID_API_TOKEN"

Responses

200

The check's captured document image.

document_image_base64stringrequired
content_typestringrequired
access_recordedtruerequired
400

Validation error

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
401

Authentication required

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
403

Forbidden

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
404

KYC check not found, or no document image has been captured yet

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
410

Document image crypto-erased under the retention policy

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
500

Internal server error

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring