List applicants
GET/v1/applicants
Parameters
| Field | Type | Required |
|---|---|---|
cursorquery | string | no |
limitquery | integer | no |
Responses
200ApplicantList400401403404409412413415422428429503
API reference
The individuals and companies you verify.
GET/v1/applicants
| Field | Type | Required |
|---|---|---|
cursorquery | string | no |
limitquery | integer | no |
200ApplicantList400401403404409412413415422428429503POST/v1/applicants
ApplicantCreate| Field | Type | Required |
|---|---|---|
type | enum: person, company | yes |
external_id | string | yes |
person | PersonInput | no |
company | CompanyInput | no |
metadata | Metadata | no |
processing_context_id | string (uuid) | yes |
201Applicant400401403404409412413415422428429503GET/v1/applicants/{applicant_id}
| Field | Type | Required |
|---|---|---|
applicant_idpath | string (uuid) | yes |
viewqueryfull (default) or masked: the masked projection of personal data of a person; the console reads applicants masked. | enum: full, masked | no |
200Applicant400401403404409412413415422428429503PATCH/v1/applicants/{applicant_id}
| Field | Type | Required |
|---|---|---|
applicant_idpath | string (uuid) | yes |
ApplicantUpdate| Field | Type | Required |
|---|---|---|
person | PersonInput | no |
company | CompanyInput | no |
metadata | Metadata | no |
200Applicant400401403404409412413415422428429503POST/v1/applicants/{applicant_id}/reveal
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.
| Field | Type | Required |
|---|---|---|
applicant_idpath | string (uuid) | yes |
EvidenceReveal| Field | Type | Required |
|---|---|---|
reason_code | enum: case_review, appeal_review, quality_assurance, customer_support, legal_obligation | yes |
200ApplicantReveal400401403404409412413415422428429503