Skip to content

Read submitted applicant data for a KYC check

GET/v1/kyc/checks/{id}/applicant

Requires an API client bearer token.

The case's submitted applicant data, narrowed to the custody `review` purpose — the human-adjudication slice, including contact fields the evaluation engines never see. 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}/applicant \
  -H "Authorization: Bearer $RIGID_API_TOKEN"

Responses

200

The check's submitted applicant data.

dataobjectrequired
+ show properties

No properties.

fields_grantedarray of stringrequired
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 applicant data has been submitted yet

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
410

Applicant data crypto-erased under the retention policy

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
500

Internal server error

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring