API reference

Applicants

The individuals and companies you verify.

List applicants

GET/v1/applicants

Scopes
applicants:read

Parameters

FieldTypeRequired
cursorquerystringno
limitqueryintegerno

Responses

  • 200ApplicantList
  • 400
  • 401
  • 403
  • 404
  • 409
  • 412
  • 413
  • 415
  • 422
  • 428
  • 429
  • 503

Create an applicant

POST/v1/applicants

Scopes
applicants:write
Required header
Idempotency-Key

Request bodyApplicantCreate

FieldTypeRequired
typeenum: person, companyyes
external_idstringyes
personPersonInputno
companyCompanyInputno
metadataMetadatano
processing_context_idstring (uuid)yes

Responses

  • 201Applicant
  • 400
  • 401
  • 403
  • 404
  • 409
  • 412
  • 413
  • 415
  • 422
  • 428
  • 429
  • 503

Get an applicant

GET/v1/applicants/{applicant_id}

Scopes
applicants:read

Parameters

FieldTypeRequired
applicant_idpathstring (uuid)yes
viewqueryfull (default) or masked: the masked projection of personal data of a person; the console reads applicants masked.enum: full, maskedno

Responses

  • 200Applicant
  • 400
  • 401
  • 403
  • 404
  • 409
  • 412
  • 413
  • 415
  • 422
  • 428
  • 429
  • 503

Update an applicant

PATCH/v1/applicants/{applicant_id}

Scopes
applicants:write
Required header
If-Match

Parameters

FieldTypeRequired
applicant_idpathstring (uuid)yes

Request bodyApplicantUpdate

FieldTypeRequired
personPersonInputno
companyCompanyInputno
metadataMetadatano

Responses

  • 200Applicant
  • 400
  • 401
  • 403
  • 404
  • 409
  • 412
  • 413
  • 415
  • 422
  • 428
  • 429
  • 503

Reveal applicant

POST/v1/applicants/{applicant_id}/reveal

Scopes
applicants:readevidence:download
Required header
Idempotency-Key

Reveals the full personal data of an applicant with a reason code: requires evidence:download in addition to applicants:read; the reveal is written to the audit log (applicant.reveal) with the reason; the response carries the display deadline.

Parameters

FieldTypeRequired
applicant_idpathstring (uuid)yes

Request bodyEvidenceReveal

FieldTypeRequired
reason_codeenum: case_review, appeal_review, quality_assurance, customer_support, legal_obligationyes

Responses

  • 200ApplicantReveal
  • 400
  • 401
  • 403
  • 404
  • 409
  • 412
  • 413
  • 415
  • 422
  • 428
  • 429
  • 503