Skip to content
rigid.fi

Read a file an applicant uploaded to a KYC check

GET/v1/kyc/checks/{id}/files/{field_id}

Requires an API client bearer token.

The bytes of one file the applicant uploaded in the hosted flow (a proof-of-address image or an untyped upload field), revealed under the custody `review` purpose. Every read is reported to pii-vault's audit pipeline on a best-effort basis. Requires the programme_admin role. The 200 carries `Cache-Control: no-store`.

Parameters

Path parameters

NameRequiredDescription
idrequired
field_idrequired

Example

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

Responses

200

The file.

content_typestringrequired
image_base64stringrequired
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 such file for it

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
410

The file was crypto-erased under the retention policy

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
429

Too many reveals from this caller — see Retry-After

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
500

Internal server error

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring