Checkout.com API logo

ID Document Verification

Create an ID document verification

Beta

Create an ID document verification for an applicant.

Ensure you use your ID Document Verification configuration ID.

SecurityOAuth2: OAuth or API Key: ApiSecretKey
Request
Request Body schema: application/json
required
applicant_id
required
string^aplt_\w+$

The applicant's unique identifier.

user_journey_id
required
string^usj_[a-z2-7]{26}$

Your configuration ID.

object (IdvDeclaredData)

The personal details provided by the applicant.

Responses
201

ID document verification created successfully

400

Bad Request

401

Unauthorized

422

Unprocessable Content

500

Internal Server Error

503

Service Unavailable

post/id-document-verifications
Request samples
application/json
{
  • "user_journey_id": "usj_tkoi5db4hryu5cei5vwoabr7we",
  • "applicant_id": "aplt_tkoi5db4hryu5cei5vwoabr7we",
  • "declared_data": {
    }
}
Response samples
application/json
{}

Get an ID document verification

Beta

Get the details of an existing ID document verification.

SecurityOAuth2: OAuth or API Key: ApiSecretKey
Request
path Parameters
id_document_verification_id
required
string (IddvIdDocumentVerificationId) ^iddv_\w+$

The ID document verification's unique identifier.

Example: iddv_tkoi5db4hryu5cei5vwoabr7we
Responses
200

ID document verification retrieved successfully

404

Not Found

500

Internal Server Error

get/id-document-verifications/{id_document_verification_id}
Request samples 
Response samples 
application/json
{}
Anonymize an ID document verification
Beta

Remove the personal data from an ID document verification.


SecurityOAuth2: OAuth or API Key: ApiSecretKey 
Request 
path Parameters
id_document_verification_id
required
string (IddvIdDocumentVerificationId) ^iddv_\w+$
The ID document verification's unique identifier.


 
 Example:  iddv_tkoi5db4hryu5cei5vwoabr7we
Responses 
200
Personal data removed successfully


401
Unauthorized


404
Not Found


500
Internal Server Error


post/id-document-verifications/{id_document_verification_id}/anonymize
Request samples 
Response samples 
application/json
{}
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
    • 



SecurityOAuth2: OAuth or API Key: ApiSecretKey 
Request 
path Parameters
id_document_verification_id
required
string (IddvIdDocumentVerificationId) ^iddv_\w+$
The ID document verification's unique identifier.


 
 Example:  iddv_tkoi5db4hryu5cei5vwoabr7we
Request Body schema: application/json
document_front
required
string <binary> 
The image of the front of the document to upload.


 
document_back
string <binary> 
The image of the back of the document to upload.


 
Responses 
201
ID document verification attempt created successfully


404
Not Found


409
Conflict


500
Internal Server Error


post/id-document-verifications/{id_document_verification_id}/attempts
Request samples 
application/json
{
  • "document_front": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD…\n"
}
Response samples 
application/json
{}
Get ID document verification attempts
Beta

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


SecurityOAuth2: OAuth or API Key: ApiSecretKey 
Request 
path Parameters
id_document_verification_id
required
string (IddvIdDocumentVerificationId) ^iddv_\w+$
The ID document verification's unique identifier.


 
 Example:  iddv_tkoi5db4hryu5cei5vwoabr7we
Responses 
200
ID document verification attempts retrieved successfully


404
Not Found


500
Internal Server Error


get/id-document-verifications/{id_document_verification_id}/attempts
Request samples 
Response samples 
application/json
{}
Get an ID document verification attempt
Beta

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


SecurityOAuth2: OAuth or API Key: ApiSecretKey 
Request 
path Parameters
id_document_verification_id
required
string (IddvIdDocumentVerificationId) ^iddv_\w+$
The ID document verification's unique identifier.


 
 Example:  iddv_tkoi5db4hryu5cei5vwoabr7we
attempt_id
required
string^datp_\w+$
The attempt's unique identifier.


 
 Example:  datp_tkoi5db4hryu5cei5vwoabraio
Responses 
200
ID document verification attempt retrieved successfully


404
Not Found


500
Internal Server Error


get/id-document-verifications/{id_document_verification_id}/attempts/{attempt_id}
Request samples 
Response samples 
application/json
{}
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.


SecurityOAuth2: OAuth or API Key: ApiSecretKey 
Request 
path Parameters
id_document_verification_id
required
string (IddvIdDocumentVerificationId) ^iddv_\w+$
The ID document verification's unique identifier.


 
 Example:  iddv_tkoi5db4hryu5cei5vwoabr7we
Responses 
200
ID document verification report retrieved successfully


404
Not Found


500
Internal Server Error


503
Service Unavailable


get/id-document-verifications/{id_document_verification_id}/pdf-report
Request samples 
Response samples 
application/json
{}
➔ Next to Reports