Checkout.com API logo

Address Document Verification

Verify your users' addresses by checking their address documents.

Create an address document verification

Beta

Create an address document verification for an applicant.

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

Address document verification created successfully

400

Bad Request

401

Unauthorized

422

Unprocessable Content

500

Internal Server Error

503

Service Unavailable

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

Get an address document verification

Beta

Get the details of an existing address document verification.

SecurityOAuth2: OAuth or API Key: ApiSecretKey
Request
path Parameters
address_document_verification_id
required
string (AdvAddressDocumentVerificationId) ^adv_\w+$

The address document verification's unique identifier.

Example: adv_tkoi5db4hryu5cei5vwoabr7we
Responses
200

Address document verification retrieved successfully

401

Unauthorized

404

Not Found

500

Internal Server Error

get/address-document-verifications/{address_document_verification_id}
Request samples 
Response samples 
application/json
{}
Anonymize an address document verification
Beta

Remove the personal data from an address document verification.


SecurityOAuth2: OAuth or API Key: ApiSecretKey 
Request 
path Parameters
address_document_verification_id
required
string (AdvAddressDocumentVerificationId) ^adv_\w+$
The address document verification's unique identifier.


 
 Example:  adv_tkoi5db4hryu5cei5vwoabr7we
Responses 
200
Personal data removed successfully


401
Unauthorized


404
Not Found


500
Internal Server Error


post/address-document-verifications/{address_document_verification_id}/anonymize
Request samples 
Response samples 
application/json
{}
Create an address document verification attempt
Beta

Create an address 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
address_document_verification_id
required
string (AdvAddressDocumentVerificationId) ^adv_\w+$
The address document verification's unique identifier.


 
 Example:  adv_tkoi5db4hryu5cei5vwoabr7we
Request Body schema: multipart/form-data
document
required
string <binary> 
The address document image to upload.


 
Responses 
201
Address document verification attempt created successfully


404
Not Found


409
Conflict


500
Internal Server Error


post/address-document-verifications/{address_document_verification_id}/attempts
Request samples 
multipart/form-data
{
  "document": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD…\n"
}
Response samples 
application/json
{}
Get address document verification attempts
Beta

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


SecurityOAuth2: OAuth or API Key: ApiSecretKey 
Request 
path Parameters
address_document_verification_id
required
string (AdvAddressDocumentVerificationId) ^adv_\w+$
The address document verification's unique identifier.


 
 Example:  adv_tkoi5db4hryu5cei5vwoabr7we
Responses 
200
Address document verification attempts retrieved successfully


404
Not Found


500
Internal Server Error


get/address-document-verifications/{address_document_verification_id}/attempts
Request samples 
Response samples 
application/json
{}
Get an address document verification attempt
Beta

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


SecurityOAuth2: OAuth or API Key: ApiSecretKey 
Request 
path Parameters
address_document_verification_id
required
string (AdvAddressDocumentVerificationId) ^adv_\w+$
The address document verification's unique identifier.


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


 
 Example:  adva_tkoi5db4hryu5cei5vwoabr7we
Responses 
200
Address document verification attempt retrieved successfully


404
Not Found


500
Internal Server Error


get/address-document-verifications/{address_document_verification_id}/attempts/{attempt_id}
Request samples 
Response samples 
application/json
{}
Get address document verification report
Beta

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


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


SecurityOAuth2: OAuth or API Key: ApiSecretKey 
Request 
path Parameters
address_document_verification_id
required
string (AdvAddressDocumentVerificationId) ^adv_\w+$
The address document verification's unique identifier.


 
 Example:  adv_tkoi5db4hryu5cei5vwoabr7we
Responses 
200
Address document verification report retrieved successfully


404
Not Found


500
Internal Server Error


503
Service Unavailable


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