Checkout.com API logo

Applicants

Create an applicant

Create a profile for an Identities applicant.

SecurityOAuth2: OAuth or API Key: ApiSecretKey
Request
Request Body schema: application/json
external_applicant_id
string^ext_\w+$

Your reference for the applicant.

email
string <email>

The applicant's email address.

external_applicant_name
string <= 255 characters

The applicant's full name.

Responses
201

Applicant created successfully

400

Bad Request

post/applicants
Request samples
application/json
{
  • "external_applicant_id": "ext_osdfdfdb4hryu5cei5vwoabrk5k",
  • "email": "hannah.bret@example.com",
  • "external_applicant_name": "Hannah Bret"
}
Response samples
application/json
{}

Get an applicant

Get the details of an applicant profile.

SecurityOAuth2: OAuth or API Key: ApiSecretKey
Request
path Parameters
applicant_id
required
string (ApplicantId) ^aplt_\w+$

The applicant profile's unique identifier.

Example: aplt_tkoi5db4hryu5cei5vwoabr7we
Responses
200

Applicant profile retrieved successfully

404

Not Found

get/applicants/{applicant_id}
Request samples 
Response samples 
application/json
{}
Update an applicant
Update the details of an applicant profile.


SecurityOAuth2: OAuth or API Key: ApiSecretKey 
Request 
path Parameters
applicant_id
required
string (ApplicantId) ^aplt_\w+$
The applicant profile's unique identifier.


 
 Example:  aplt_tkoi5db4hryu5cei5vwoabr7we
Request Body schema: application/json
email
string <email> 
The applicant's email address.


 
external_applicant_name
string  <= 255 characters 
The applicant's full name.


 
Responses 
200
Applicant profile updated successfully


400
Bad Request


404
Not Found


500
Internal Server Error


patch/applicants/{applicant_id}
Request samples 
application/json
{
  • "email": "hannah.bret@example.com",
  • "external_applicant_name": "Hannah Bret"
}
Response samples 
application/json
{}
Anonymize an applicant
Remove the personal data in an applicant profile.


SecurityOAuth2: OAuth or API Key: ApiSecretKey 
Request 
path Parameters
applicant_id
required
string (ApplicantId) ^aplt_\w+$
The applicant profile's unique identifier.


 
 Example:  aplt_tkoi5db4hryu5cei5vwoabr7we
Responses 
200
Personal data removed successfully


400
Bad Request


404
Not Found


500
Internal Server Error


post/applicants/{applicant_id}/anonymize
Request samples 
Response samples 
application/json
{}
➔ Next to Identity Verification