CHcheckout
Applicants

Create an applicant

Create a profile for an Identities applicant.

post/applicants

Request

Request body

created_onstring date-time required

The date and time when the resource was created, in UTC. <br/>Format – yyyy-mm-ddThh:mm:ss.sss

modified_onstring date-time required

The date and time when the resource was modified, in UTC. <br/>Format – yyyy-mm-ddThh:mm:ss.sss

external_applicant_idstring

Your reference for the applicant.

emailstring email

The applicant's email address.

external_applicant_namestring

The applicant's full name.

idstring required

The applicant's unique identifier.

Example request

{
  "created_on": "2025-07-21T17:32:28.0000000+00:00",
  "modified_on": "2025-07-21T17:40:32.0000000+00:00",
  "external_applicant_id": "ext_osdfdfdb4hryu5cei5vwoabrk5k",
  "email": "hannah.bret@example.com",
  "external_applicant_name": "Hannah Bret",
  "id": "aplt_tkoi5db4hryu5cei5vwoabr7we"
}

Response

Applicant created successfully

created_onstring date-time required

The date and time when the resource was created, in UTC. <br/>Format – yyyy-mm-ddThh:mm:ss.sss

modified_onstring date-time required

The date and time when the resource was modified, in UTC. <br/>Format – yyyy-mm-ddThh:mm:ss.sss

external_applicant_idstring

Your reference for the applicant.

emailstring email

The applicant's email address.

external_applicant_namestring

The applicant's full name.

idstring required

The applicant's unique identifier.

Example response

{
  "created_on": "2025-07-21T17:32:28.0000000+00:00",
  "modified_on": "2025-07-21T17:40:32.0000000+00:00",
  "external_applicant_id": "ext_osdfdfdb4hryu5cei5vwoabrk5k",
  "email": "hannah.bret@example.com",
  "external_applicant_name": "Hannah Bret",
  "id": "aplt_tkoi5db4hryu5cei5vwoabr7we"
}

Changes

No recorded changes to this operation across all 1 revision of this API.