Applicants

​
Applicants Operations

Create an applicant

​

Create a profile for an Identities applicant.

Body·
application/json
  • Type: object
    • external_applicant_id
      Type: string Pattern: ^ext_\w+$

      Your reference for the applicant.

    • email
      Type: string Format: email

      The applicant's email address.

    • external_applicant_name
      Type: string
      max length:  
      255

      The applicant's full name.

Responses
  • application/json
  • application/json
Request Example for post/applicants
curl https://identity-verification.checkout.com/applicants \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "external_applicant_id": "ext_osdfdfdb4hryu5cei5vwoabrk5k",
  "email": "hannah.bret@example.com",
  "external_applicant_name": "Hannah Bret"
}'

{
  "id": "aplt_tkoi5db4hryu5cei5vwoabr7we",
  "created_on": {},
  "modified_on": {},
  "external_applicant_id": "ext_osdfdfdb4hryu5cei5vwoabrk5k",
  "email": "hannah.bret@example.com",
  "external_applicant_name": "Hannah Bret",
  "_links": {
    "self": {
      "href": "https://identity-verification.checkout.com/applicants/aplt_tkoi5db4hryu5cei5vwoabr7we"
    }
  }
}

Applicant created successfully

Get an applicant

​

Get the details of an applicant profile.

Path Parameters
  • applicant_id
    Type: string · Pattern: ^aplt_\w+$
    read-only
    required

    The applicant profile's unique identifier.

    The applicant's unique identifier.

Responses
  • application/json
  • 404

    Not Found

Request Example for get/applicants/{applicant_id}
Shell Curl
curl https://identity-verification.checkout.com/applicants/aplt_tkoi5db4hryu5cei5vwoabr7we \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "id": "aplt_tkoi5db4hryu5cei5vwoabr7we",
  "created_on": {},
  "modified_on": {},
  "external_applicant_id": "ext_osdfdfdb4hryu5cei5vwoabrk5k",
  "email": "hannah.bret@example.com",
  "external_applicant_name": "Hannah Bret",
  "_links": {
    "self": {
      "href": "https://identity-verification.checkout.com/applicants/aplt_tkoi5db4hryu5cei5vwoabr7we"
    }
  }
}

Applicant profile retrieved successfully

Update an applicant

​

Update the details of an applicant profile.

Path Parameters
  • applicant_id
    Type: string · Pattern: ^aplt_\w+$
    read-only
    required

    The applicant profile's unique identifier.

    The applicant's unique identifier.

Body·
application/json
  • Type: object
    • external_applicant_id
      Type: string Pattern: ^ext_\w+$

      Your reference for the applicant.

    • email
      Type: string Format: email

      The applicant's email address.

    • external_applicant_name
      Type: string
      max length:  
      255

      The applicant's full name.

Responses
  • application/json
  • 400

    Bad Request

  • 404

    Not Found

  • 500

    Internal Server Error

Request Example for patch/applicants/{applicant_id}
curl https://identity-verification.checkout.com/applicants/aplt_tkoi5db4hryu5cei5vwoabr7we \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "email": "hannah.bret@example.com",
  "external_applicant_name": "Hannah Bret"
}'

{
  "id": "aplt_tkoi5db4hryu5cei5vwoabr7we",
  "created_on": {},
  "modified_on": {},
  "external_applicant_id": "ext_osdfdfdb4hryu5cei5vwoabrk5k",
  "email": "hannah.bret@example.com",
  "external_applicant_name": "Hannah Bret",
  "_links": {
    "self": {
      "href": "https://identity-verification.checkout.com/applicants/aplt_tkoi5db4hryu5cei5vwoabr7we"
    }
  }
}

Applicant profile updated successfully

Anonymize an applicant

​

Remove the personal data in an applicant profile.

Path Parameters
  • applicant_id
    Type: string · Pattern: ^aplt_\w+$
    read-only
    required

    The applicant profile's unique identifier.

    The applicant's unique identifier.

Responses
  • application/json
  • 400

    Bad Request

  • 404

    Not Found

  • 500

    Internal Server Error

Request Example for post/applicants/{applicant_id}/anonymize
Shell Curl
curl https://identity-verification.checkout.com/applicants/aplt_tkoi5db4hryu5cei5vwoabr7we/anonymize \
  --request POST \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "id": "aplt_tkoi5db4hryu5cei5vwoabr7we",
  "created_on": {},
  "modified_on": {},
  "external_applicant_id": "ext_osdfdfdb4hryu5cei5vwoabrk5k",
  "_links": {
    "self": {
      "href": "https://identity-verification.checkout.com/applicants/aplt_tkoi5db4hryu5cei5vwoabr7we"
    }
  }
}

Personal data removed successfully