Address Document Verification

​

Verify your users' addresses by checking their address documents.

Address Document Verification Operations

Create an address document verification

​

Beta

Create an address document verification for an applicant.

Body·
required
application/json
  • 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/address-document-verifications
Shell Curl
curl https://identity-verification.checkout.com/address-document-verifications \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "applicant_id": "aplt_tkoi5db4hryu5cei5vwoabr7we",
  "user_journey_id": "usj_tkoi5db4hryu5cei5vwoabr7we",
  "declared_data": {
    "name": "Hannah Bret"
  }
}'

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

Address document verification created successfully

Get an address document verification

​

Beta

Get the details of an existing address document verification.

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

    The address document verification's unique identifier.

Responses
  • application/json
  • 401

    Unauthorized

  • 404

    Not Found

  • 500

    Internal Server Error

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

{
  "id": "adv_tkoi5db4hryu5cei5vwoabr7we",
  "created_on": "2025-07-21T17:32:28Z",
  "modified_on": "2025-07-21T17:40:32Z",
  "applicant_id": "aplt_tkoi5db4hryu5cei5vwoabr7we",
  "user_journey_id": "usj_tkoi5db4hryu5cei5vwoabr7we",
  "declared_data": {
    "name": "Hannah Bret"
  },
  "status": "approved",
  "response_codes": [
    {
      "code": 10000,
      "summary": "approved"
    }
  ],
  "risk_labels": [
    "risky_document_format"
  ],
  "address_document": {
    "document_type": "utility_bill",
    "issuer": "EDF Energy",
    "full_names": [
      "Hannah Bret"
    ],
    "issue_date": "2025-01-15",
    "address": {
      "address_line1": "123 Main Street",
      "address_line2": "Apt 4B",
      "city": "London",
      "state": "Greater London",
      "zip": "SW1A 1AA",
      "country": "GB"
    }
  },
  "_links": {
    "self": {
      "href": "https://identity-verification.checkout.com/address-document-verifications/adv_tkoi5db4hryu5cei5vwoabr7we"
    },
    "applicant": {
      "href": "https://identity-verification.checkout.com/applicants/aplt_tkoi5db4hryu5cei5vwoabr7we"
    }
  }
}

Address document verification retrieved successfully

Anonymize an address document verification

​

Beta

Remove the personal data from an address document verification.

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

    The address document verification's unique identifier.

Responses
  • application/json
  • 401

    Unauthorized

  • 404

    Not Found

  • 500

    Internal Server Error

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

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

Personal data removed successfully

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
Path Parameters
  • address_document_verification_id
    Type: string · Pattern: ^adv_\w+$
    read-only
    required

    The address document verification's unique identifier.

Body
application/json
Responses
  • application/json
  • 404

    Not Found

  • 409

    Conflict

  • 500

    Internal Server Error

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

{
  "id": "adva_tkoi5db4hryu5cei5vwoabr7we",
  "created_on": "2025-07-21T17:32:28Z",
  "modified_on": "2025-07-21T17:40:32Z",
  "status": "quality_checks_in_progress",
  "response_codes": [],
  "_links": {
    "self": {
      "href": "https://identity-verification.checkout.com/address-document-verifications/adv_tkoi5db4hryu5cei5vwoabr7we/attempts/adva_tkoi5db4hryu5cei5vwoabr7we"
    }
  }
}

Address document verification attempt created successfully

Get address document verification attempts

​

Beta

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

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

    The address 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/address-document-verifications/{address_document_verification_id}/attempts
Shell Curl
curl https://identity-verification.checkout.com/address-document-verifications/adv_tkoi5db4hryu5cei5vwoabr7we/attempts \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "total_count": 1,
  "skip": 0,
  "limit": 10,
  "data": [
    {
      "id": "adva_tkoi5db4hryu5cei5vwoabr7we",
      "created_on": "2025-07-21T17:32:28Z",
      "modified_on": "2025-07-21T17:40:32Z",
      "status": "completed",
      "response_codes": [
        {
          "code": 10000,
          "summary": "approved"
        }
      ],
      "_links": {
        "self": {
          "href": "https://identity-verification.checkout.com/address-document-verifications/adv_tkoi5db4hryu5cei5vwoabr7we/attempts/adva_tkoi5db4hryu5cei5vwoabr7we"
        }
      }
    }
  ],
  "_links": {
    "self": {
      "href": "https://identity-verification.checkout.com/address-document-verifications/adv_tkoi5db4hryu5cei5vwoabr7we/attempts?skip=0&limit=10"
    },
    "next": {
      "href": "https://identity-verification.checkout.com/address-document-verifications/adv_tkoi5db4hryu5cei5vwoabr7we/attempts?skip=10&limit=10"
    },
    "previous": {
      "href": "https://identity-verification.checkout.com/address-document-verifications/adv_tkoi5db4hryu5cei5vwoabr7we/attempts?skip=0&limit=10"
    }
  }
}

Address document verification attempts retrieved successfully

Get an address document verification attempt

​

Beta

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

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

    The address document verification's unique identifier.

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

    The attempt's unique identifier.

Responses
  • application/json
  • 404

    Not Found

  • 500

    Internal Server Error

Request Example for get/address-document-verifications/{address_document_verification_id}/attempts/{attempt_id}
Shell Curl
curl https://identity-verification.checkout.com/address-document-verifications/adv_tkoi5db4hryu5cei5vwoabr7we/attempts/adva_tkoi5db4hryu5cei5vwoabr7we \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "id": "adva_tkoi5db4hryu5cei5vwoabr7we",
  "created_on": "2025-07-21T17:32:28Z",
  "modified_on": "2025-07-21T17:40:32Z",
  "status": "completed",
  "response_codes": [
    {
      "code": 10000,
      "summary": "approved"
    }
  ],
  "_links": {
    "self": {
      "href": "https://identity-verification.checkout.com/address-document-verifications/adv_tkoi5db4hryu5cei5vwoabr7we/attempts/adva_tkoi5db4hryu5cei5vwoabr7we"
    }
  }
}

Address document verification attempt retrieved successfully

Get address document verification attempt assets

​

Beta

Get the assets (the document image) uploaded for an address document verification attempt.

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

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

    The address document verification's unique identifier.

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

    The attempt's unique identifier.

    The unique identifier for the address 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/address-document-verifications/{address_document_verification_id}/attempts/{attempt_id}/assets
Shell Curl
curl https://identity-verification.checkout.com/address-document-verifications/adv_tkoi5db4hryu5cei5vwoabr7we/attempts/adva_tkoi5db4hryu5cei5vwoabr7we/assets \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

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

Address document verification attempt assets retrieved successfully

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.

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

    The address document verification's unique identifier.

Responses
  • application/json
  • 404

    Not Found

  • 500

    Internal Server Error

  • 503

    Service Unavailable

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

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

Address document verification report retrieved successfully