List applicants
GET/v1/applicants
Parameters
| Field | Type | Required |
|---|---|---|
cursorquery | string | no |
limitquery | integer | no |
Responses
200ApplicantList400401403404409412413415422428429503
API reference
Applicants
The individuals and companies you verify.
Create an applicant
POST/v1/applicants
Request bodyApplicantCreate
| 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 |
Responses
201Applicant400401403404409412413415422428429503
Get an applicant
GET/v1/applicants/{applicant_id}
Parameters
| Field | Type | Required |
|---|---|---|
applicant_idpath | string (uuid) | yes |
Responses
200Applicant400401403404409412413415422428429503
Update an applicant
PATCH/v1/applicants/{applicant_id}
Parameters
| Field | Type | Required |
|---|---|---|
applicant_idpath | string (uuid) | yes |
Request bodyApplicantUpdate
| Field | Type | Required |
|---|---|---|
person | PersonInput | no |
company | CompanyInput | no |
metadata | Metadata | no |
Responses
200Applicant400401403404409412413415422428429503