Manage applicants using the API
Beta
Last updated: January 21, 2026
To perform Identities checks, you need a profile for each physical person applying to use your services. You can then use this profile to create Identity Verification, Face Authentication, AML Screening, and ID Document Verification checks for the applicant.
Ensure Identities is enabled for your account. Contact your account manager or request support.
Create a profile for the applicant and receive an applicant ID, prefixed with aplt_.
Use the ID to request checks for the applicant.
You can then:
- View a profile.
- Update a profile.
- Remove an applicant's personal details from their profile, if requested.
Using the API, you create the applicant profile before creating their first identity verification.
Call the Create an applicant endpoint.
Optionally, provide the following fields in the request body:
external_applicant_name– The applicant's name.external_applicant_id– Your identifier for the applicant.email– The applicant's email address.
post
https://identity-verification.checkout.com/applicants
The response returns the applicant ID, prefixed with aplt_ in the id field.
Call the Get an applicant endpoint, and provide the applicant ID as the {applicant_id} path parameter.
get
https://identity-verification.checkout.com/applicants/{applicant_id}
Call the Update an applicant endpoint, and provide the applicant ID as the {applicant_id} path parameter.
Make the required changes in the request body.
patch
https://identity-verification.checkout.com/applicants/{applicant_id}
If requested by an applicant under the General Data Protection Regulation (GDPR), you can remove the following personally identifiable information (PII) from their profile:
- External applicant name – The name you have on record for the applicant.
- Applicant email – The applicant's email address.
Note
Call the Anonymize an applicant endpoint, and provide the applicant ID as the {applicant_id} path parameter.
Make the required changes in the request body.
post
https://identity-verification.checkout.com/applicants/{applicant_id}/anonymize