ID Document Verification

​
ID Document Verification Operations

Create an ID document verification

​

Beta

Create an ID document verification for an applicant.

Ensure you use your ID Document Verification configuration ID.

Body·
required
application/json
  • Type: object
    • applicant_id
      Type: string · Pattern: ^aplt_\w+$
      required

      The applicant's unique identifier.

    • user_journey_id
      Type: string · Pattern: ^usj_[a-z2-7]{26}$
      required

      Your configuration ID.

    • declared_data
      Type: object ·

      The personal details provided by the applicant.

Responses
  • application/json
  • application/json
  • 401

    Unauthorized

  • application/json
  • 500

    Internal Server Error

  • 503

    Service Unavailable

Request Example for post/id-document-verifications
curl https://identity-verification.checkout.com/id-document-verifications \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "user_journey_id": "usj_tkoi5db4hryu5cei5vwoabr7we",
  "applicant_id": "aplt_tkoi5db4hryu5cei5vwoabr7we",
  "declared_data": {
    "name": "Hannah Bret"
  }
}'

{
  "id": "iddv_tkoi5db4hryu5cei5vwoabr7we",
  "created_on": "2025-07-21T17:32:28Z",
  "modified_on": "2025-07-21T17:40:32Z",
  "user_journey_id": "usj_tkoi5db4hryu5cei5vwoabr7we",
  "applicant_id": "aplt_tkoi5db4hryu5cei5vwoabr7we",
  "status": "approved",
  "response_codes": [
    {
      "code": 10000,
      "summary": "approved"
    }
  ],
  "declared_data": {
    "name": "Hannah Bret"
  },
  "document": {
    "full_name": "Hannah Bret",
    "birth_date": {},
    "document_type": "ID",
    "document_issuing_country": "US",
    "address": "123 Main Street, London, SW1A 1AA",
    "front_image_signed_url": "https://storage-b.env/NDYOOVHGZPAQ/a54b3393-f02a-47c9-a9c5-2f6ee73560e1/bb603e2f-5de9-40f2-9631-8285a33c24c0/tight_crops/FRA-I5-Front-bb603e2f-5de9-40f2-9631-8285a33c24c0-1679921906596.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=V9jgOdpOdeVSFTkA4ZsG%2F20230327%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20230327T163228Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=87d8467ab92cbad7c00171af28e613d495f3ff441ce0ea59dd013d68abc50555"
  },
  "_links": {
    "self": {
      "href": "https://identity-verification.checkout.com/id-document-verifications/iddv_tkoi5db4hryu5cei5vwoabr7we"
    },
    "applicant": {
      "href": "https://identity-verification.checkout.com/applicants/aplt_tkoi5db4hryu5cei5vwoabr7we"
    }
  }
}

ID document verification created successfully

Get an ID document verification

​

Beta

Get the details of an existing ID document verification.

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

    The ID document verification's unique identifier.

Responses
  • application/json
  • 404

    Not Found

  • 500

    Internal Server Error

Request Example for get/id-document-verifications/{id_document_verification_id}
Shell Curl
curl https://identity-verification.checkout.com/id-document-verifications/iddv_tkoi5db4hryu5cei5vwoabr7we \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "id": "iddv_tkoi5db4hryu5cei5vwoabr7we",
  "created_on": "2025-07-21T17:32:28Z",
  "modified_on": "2025-07-21T17:40:32Z",
  "user_journey_id": "usj_tkoi5db4hryu5cei5vwoabr7we",
  "applicant_id": "aplt_tkoi5db4hryu5cei5vwoabr7we",
  "status": "approved",
  "response_codes": [
    {
      "code": 10000,
      "summary": "approved"
    }
  ],
  "declared_data": {
    "name": "Hannah Bret"
  },
  "document": {
    "full_name": "Hannah Bret",
    "birth_date": {},
    "document_type": "ID",
    "document_issuing_country": "US",
    "address": "123 Main Street, London, SW1A 1AA",
    "front_image_signed_url": "https://storage-b.env/NDYOOVHGZPAQ/a54b3393-f02a-47c9-a9c5-2f6ee73560e1/bb603e2f-5de9-40f2-9631-8285a33c24c0/tight_crops/FRA-I5-Front-bb603e2f-5de9-40f2-9631-8285a33c24c0-1679921906596.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=V9jgOdpOdeVSFTkA4ZsG%2F20230327%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20230327T163228Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=87d8467ab92cbad7c00171af28e613d495f3ff441ce0ea59dd013d68abc50555"
  },
  "_links": {
    "self": {
      "href": "https://identity-verification.checkout.com/id-document-verifications/iddv_tkoi5db4hryu5cei5vwoabr7we"
    },
    "applicant": {
      "href": "https://identity-verification.checkout.com/applicants/aplt_tkoi5db4hryu5cei5vwoabr7we"
    }
  }
}

ID document verification retrieved successfully

Anonymize an ID document verification

​

Beta

Remove the personal data from an ID document verification.

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

    The ID document verification's unique identifier.

Responses
  • application/json
  • 401

    Unauthorized

  • 404

    Not Found

  • 500

    Internal Server Error

Request Example for post/id-document-verifications/{id_document_verification_id}/anonymize
Shell Curl
curl https://identity-verification.checkout.com/id-document-verifications/iddv_tkoi5db4hryu5cei5vwoabr7we/anonymize \
  --request POST \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "id": "iddv_tkoi5db4hryu5cei5vwoabr7we",
  "created_on": "2025-07-21T17:32:28Z",
  "modified_on": "2025-07-21T17:40:32Z",
  "user_journey_id": "usj_tkoi5db4hryu5cei5vwoabr7we",
  "applicant_id": "aplt_tkoi5db4hryu5cei5vwoabr7we",
  "status": "approved",
  "response_codes": [
    {
      "code": 10000,
      "summary": "approved"
    }
  ],
  "declared_data": {
    "name": "Hannah Bret"
  },
  "_links": {
    "self": {
      "href": "https://identity-verification.checkout.com/identity-verifications/iddv_tkoi5db4hryu5cei5vwoabr7we"
    },
    "applicant": {
      "href": "https://identity-verification.checkout.com/applicants/aplt_tkoi5db4hryu5cei5vwoabr7we"
    }
  }
}

Personal data removed successfully

Create an ID document verification attempt

​

Beta

Create an ID document verification attempt.

If you've previously created an attempt for this verification, the verification status must be one of the following:

  • created
  • retry_required

If you create a new attempt while the status is any other value, you receive a 409 Conflict response.

Images must not exceed 10MB in size and must be in one of the following formats:

  • JPEG
  • PDF
  • PNG
Path Parameters
  • id_document_verification_id
    Type: string · Pattern: ^iddv_\w+$
    read-only
    required

    The ID document verification's unique identifier.

Body
application/json
Responses
  • application/json
  • 404

    Not Found

  • 409

    Conflict

  • 500

    Internal Server Error

Request Example for post/id-document-verifications/{id_document_verification_id}/attempts
Shell Curl
curl https://identity-verification.checkout.com/id-document-verifications/iddv_tkoi5db4hryu5cei5vwoabr7we/attempts \
  --request POST \
  --header 'Content-Type: multipart/form-data' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --form 'document_front=data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD…
'

{
  "id": "datp_tkoi5db4hryu5cei5vwoabr7we",
  "created_on": {},
  "modified_on": {},
  "status": "completed",
  "response_codes": [],
  "_links": {
    "self": {
      "href": "https://identity-verification.sandbox.checkout.com/id-document-verifications/datp_tkoi5db4hryu5cei5vwoabr7we"
    }
  }
}

ID document verification attempt created successfully

Get ID document verification attempts

​

Beta

Get the details of all attempts for a specific ID document verification.

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

    The ID document verification's unique identifier.

Query Parameters
  • skip
    Type: integer

    The number of attempts to skip.

  • limit
    Type: integer

    The maximum number of attempts to return.

Responses
  • application/json
  • 404

    Not Found

  • 500

    Internal Server Error

Request Example for get/id-document-verifications/{id_document_verification_id}/attempts
Shell Curl
curl https://identity-verification.checkout.com/id-document-verifications/iddv_tkoi5db4hryu5cei5vwoabr7we/attempts \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "total_count": 2,
  "skip": 10,
  "limit": 10,
  "data": [
    {
      "id": "datp_tkoi5db4hryu5cei5vwoabr7we",
      "created_on": {},
      "modified_on": {},
      "status": "completed",
      "response_codes": [],
      "_links": {
        "self": {
          "href": "https://idv.checkout.com/iddv_tkoi5db4hryu5cei5vwoabr7we"
        }
      }
    }
  ],
  "_links": {
    "self": {
      "href": "https://identity-verification.sandbox.checkout.com/id-document-verifications/iddv_tkoi5db4hryu5cei5vwoabr7we/attempts"
    },
    "next": {
      "href": "https://identity-verification.sandbox.checkout.com/id-document-verifications/iddv_tkoi5db4hryu5cei5vwoabr7we/attempts?..."
    },
    "previous": {
      "href": "https://identity-verification.sandbox.checkout.com/id-document-verifications/iddv_tkoi5db4hryu5cei5vwoabr7we/attempts?..."
    }
  }
}

ID document verification attempts retrieved successfully

Get an ID document verification attempt

​

Beta

Get the details of a specific attempt for an ID document verification.

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

    The ID document verification's unique identifier.

  • attempt_id
    Type: string Pattern: ^datp_\w+$
    required

    The attempt's unique identifier.

Responses
  • application/json
  • 404

    Not Found

  • 500

    Internal Server Error

Request Example for get/id-document-verifications/{id_document_verification_id}/attempts/{attempt_id}
Shell Curl
curl https://identity-verification.checkout.com/id-document-verifications/iddv_tkoi5db4hryu5cei5vwoabr7we/attempts/datp_tkoi5db4hryu5cei5vwoabraio \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "id": "datp_tkoi5db4hryu5cei5vwoabr7we",
  "created_on": {},
  "modified_on": {},
  "status": "completed",
  "response_codes": [],
  "_links": {
    "self": {
      "href": "https://idv.checkout.com/datp_tkoi5db4hryu5cei5vwoabr7we"
    }
  }
}

ID document verification attempt retrieved successfully

Get ID document verification attempt assets

​

Beta

Get the assets (the front and back images of the document) uploaded for an ID document verification attempt.

Results are paginated. Use the skip and limit query parameters to navigate through pages.

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

    The ID document verification's unique identifier.

  • attempt_id
    Type: string · Pattern: ^datp_\w+$
    read-only
    required

    The attempt's unique identifier.

    The unique identifier for the ID document verification attempt.

Query Parameters
  • skip
    Type: integer

    The number of assets to skip.

  • limit
    Type: integer

    The maximum number of assets to return.

Responses
  • application/json
  • 404

    Not Found

  • 500

    Internal Server Error

Request Example for get/id-document-verifications/{id_document_verification_id}/attempts/{attempt_id}/assets
Shell Curl
curl https://identity-verification.checkout.com/id-document-verifications/iddv_tkoi5db4hryu5cei5vwoabr7we/attempts/datp_tkoi5db4hryu5cei5vwoabraio/assets \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "total_count": 2,
  "skip": 0,
  "limit": 10,
  "data": [
    {
      "type": "document_front_image",
      "_links": {
        "asset_url": {
          "href": "https://storage-b.env.ubble.ai/ubble-ai/NDYOOVHGZPAQ/a54b3393-f02a-47c9-a9c5-2f6ee73560e1/bb603e2f-5de9-40f2-9631-8285a33c24c0/document_front.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Expires=3600"
        }
      }
    },
    {
      "type": "document_back_image",
      "_links": {
        "asset_url": {
          "href": "https://storage-b.env.ubble.ai/ubble-ai/NDYOOVHGZPAQ/a54b3393-f02a-47c9-a9c5-2f6ee73560e1/bb603e2f-5de9-40f2-9631-8285a33c24c0/document_back.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Expires=3600"
        }
      }
    }
  ],
  "_links": {
    "self": {
      "href": "https://identity-verification.checkout.com/id-document-verifications/iddv_tkoi5db4hryu5cei5vwoabr7we/attempts/datp_tkoi5db4hryu5cei5vwoabraio/assets"
    },
    "next": {
      "href": "https://identity-verification.checkout.com/id-document-verifications/iddv_tkoi5db4hryu5cei5vwoabr7we/attempts/datp_tkoi5db4hryu5cei5vwoabraio/assets?..."
    },
    "previous": {
      "href": "https://identity-verification.checkout.com/id-document-verifications/iddv_tkoi5db4hryu5cei5vwoabr7we/attempts/datp_tkoi5db4hryu5cei5vwoabraio/assets?..."
    }
  }
}

ID document verification attempt assets retrieved successfully

Get ID document verification report

​

Beta

Get the report for an ID document verification in PDF format.

The report is only available when the verification status is approved or declined, and you've received a ID document verification report created webhook.

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

    The ID document verification's unique identifier.

Responses
  • application/json
  • 404

    Not Found

  • 500

    Internal Server Error

  • 503

    Service Unavailable

Request Example for get/id-document-verifications/{id_document_verification_id}/pdf-report
Shell Curl
curl https://identity-verification.checkout.com/id-document-verifications/iddv_tkoi5db4hryu5cei5vwoabr7we/pdf-report \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "pdf_report": "https://www.example.com/reports/idv_tkoi5db4hryu5cei5vwoabr7we.pdf"
}

ID document verification report retrieved successfully