# Manage applicants using the API

To perform [Identities](https://www.checkout.com/docs/business-operations/manage-identities.md) checks, you need a profile for each physical person applying to use your services.
You can then use this profile to create [Identity Verification](https://www.checkout.com/docs/business-operations/manage-identities/verify-identities.md), [Face Authentication](https://www.checkout.com/docs/business-operations/manage-identities/authenticate-with-biometrics.md), [AML Screening](https://www.checkout.com/docs/business-operations/manage-identities/screen-aml-databases.md), and [ID Document Verification](https://www.checkout.com/docs/business-operations/manage-identities/verify-id-documents.md) checks for the applicant.

---

## Before you start

Ensure Identities is enabled for your account. Contact your account manager or [request support](https://dashboard.checkout.com/support/new?topic=case_account_management_and_access&issue=issue_account_changes).

---

## How it works

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.

---

## Create an applicant

Using the API, you create the applicant profile before creating their first identity verification.

Call the [Create an applicant](https://api-reference.checkout.com/tag/Applicants/#operation/create_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.

**Production**

`POST` `https://identity-verification.checkout.com/applicants`

**Sandbox**

`POST` `https://identity-verification.sandbox.checkout.com/applicants`

### Request example

```json
{
  "external_applicant_name": "Hannah Bret",
  "external_applicant_id": "ext_osdfdfdb4hryu5cei5vwoabrk5k",
  "email": "hannah.bret@example.com"
}
```

### Response example

```json
{
  "id": "aplt_tkoi5db4hryu5cei5vwoabr7we",
  "created_on": "2025-07-21T17:32:28Z",
  "modified_on": "2025-08-21T17:40:32Z",
  "external_applicant_name": "Hannah Bret",
  "external_applicant_id": "ext_osdfdfdb4hryu5cei5vwoabrk5k",
  "email": "hannah.bret@example.com",
  "_links": {
    "self": {
      "href": "https://identity-verification.sandbox.checkout.com/applicants/aplt_tkoi5db4hryu5cei5vwoabr7we"
    }
  }
}
```

The response returns the applicant ID, prefixed with `aplt_` in the `id` field.

---

## Retrieve a profile

Call the [Get an applicant](https://api-reference.checkout.com/tag/Applicants/#operation/retrieve_applicant) endpoint, and provide the applicant ID as the `{applicant_id}` path parameter.

**Production**

`GET` `https://identity-verification.checkout.com/applicants/{applicant_id}`

**Sandbox**

`GET` `https://identity-verification.sandbox.checkout.com/applicants/{applicant_id}`

### Response example

```json
{
  "id": "aplt_tkoi5db4hryu5cei5vwoabr7we",
  "created_on": "2025-07-21T17:32:28Z",
  "modified_on": "2025-08-21T17:40:32Z",
  "external_applicant_name": "Hannah Bret",
  "external_applicant_id": "ext_osdfdfdb4hryu5cei5vwoabrk5k",
  "email": "hannah.bret@example.com",
  "_links": {
    "self": {
      "href": "https://identity-verification.checkout.com/applicants/aplt_tkoi5db4hryu5cei5vwoabr7we"
    }
  }
}
```

---

## Update a profile

Call the [Update an applicant](https://api-reference.checkout.com/tag/Applicants/#operation/update_applicant) endpoint, and provide the applicant ID as the `{applicant_id}` path parameter.

Make the required changes in the request body.

**Production**

`PATCH` `https://identity-verification.checkout.com/applicants/{applicant_id}`

**Sandbox**

`PATCH` `https://identity-verification.sandbox.checkout.com/applicants/{applicant_id}`

### Response example

```json
{
  "id": "aplt_tkoi5db4hryu5cei5vwoabr7we",
  "created_on": "2025-07-21T17:32:28Z",
  "modified_on": "2025-08-21T17:40:32Z",
  "external_applicant_name": "Hannah Bret",
  "external_applicant_id": "ext_osdfdfdb4hryu5cei5vwoabrk5k",
  "email": "hannah.bret@example.com",
  "_links": {
    "self": {
      "href": "https://identity-verification.checkout.com/applicants/aplt_tkoi5db4hryu5cei5vwoabr7we"
    }
  }
}
```

---

## Remove personal details

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**
>
> Removing an applicant's PII is permanent. You cannot undo this action.
> Any information from the applicant's checks that is not linked to their personal identity is retained for your records.

Call the [Anonymize an applicant](https://api-reference.checkout.com/tag/Applicants/#operation/anonymize_applicant) endpoint, and provide the applicant ID as the `{applicant_id}` path parameter.
Make the required changes in the request body.

**Production**

`POST` `https://identity-verification.checkout.com/applicants/{applicant_id}/anonymize`

**Sandbox**

`POST` `https://identity-verification.sandbox.checkout.com/applicants/{applicant_id}/anonymize`

### Response example

```json
{
  "id": "aplt_tkoi5db4hryu5cei5vwoabr7we",
  "created_on": "2025-07-21T17:32:28Z",
  "modified_on": "2025-08-21T17:40:32Z",
  "external_applicant_id": "ext_osdfdfdb4hryu5cei5vwoabrk5k",
  "_links": {
    "self": {
      "href": "https://identity-verification.checkout.com/applicants/aplt_tkoi5db4hryu5cei5vwoabr7we"
    }
  }
}
```

---

## Next steps

**[Verify identities](https://www.checkout.com/docs/business-operations/manage-identities/verify-identities.md)**

Verify the identity of people applying to use your services.