Manage applicants
Beta
Last updated: June 4, 2025
The Identities solutions require a profile for each physical person applying to use your services. You can then use this profile to manage the applicant's identity across Identity Verification, AML Screening, and Face Authentication.
Information
To enable Identities, contact your account manager or [email protected].
- You need a Checkout.com test account, with Identities enabled.
- Set up an authentication mechanism for your API requests, using OAuth 2.0 or API keys.
You create a profile for the applicant, which you can later retrieve or update.
You can also delete the applicant's personal data from the profile if necessary. For example, to comply with a GDPR request.
Call the Create an applicant endpoint. Optionally, provide the following fields:
external_applicant_id– Your identifier for the applicant, prefixed withext_email– The applicant's email address
post
https://identity-verification.sandbox.checkout.com/applicants
The response returns the applicant ID in the id field, prefixed with aplt_. You need this to create verifications, screenings, and authentications for the applicant.
Call the Retrieve an applicant endpoint, and provide the applicant ID as the {applicant_id} path parameter.
get
https://identity-verification.sandbox.checkout.com/applicants/{applicant_id}
Call the Update an applicant endpoint, and provide the applicant ID as the {applicant_id} path parameter.
patch
https://identity-verification.sandbox.checkout.com/applicants/{applicant_id}
Call the Anonymize an applicant endpoint, and provide the applicant ID as the {applicant_id} path parameter.
post
https://identity-verification.sandbox.checkout.com/applicants/{applicant_id}/anonymize