Skip to content

Batch-resolve applicant display names for KYC checks

GET/v1/kyc/checks/applicants

Requires an API client bearer token.

Resolves display names (given + family name, nothing else) for up to 100 checks by id — the review queue's row labels. Reads run under the narrow custody `queue_display` purpose and every resolved row is reported to pii-vault's audit pipeline on the same best-effort basis as `getCheckApplicant`. A check that cannot be resolved — unknown, outside the caller's programme-admin role, no submission yet, or crypto-erased — is omitted from `data` rather than failing the batch.

Parameters

Query parameters

NameRequiredDescription
idsrequired

Example

curl https://api.rigid.fi/v1/kyc/checks/applicants \
  -H "Authorization: Bearer $RIGID_API_TOKEN"

Responses

200

Display names for every resolvable requested check.

dataarray of objectrequired
+ show properties
check_idstringrequired
display_namestringrequired
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
500

Internal server error

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring