CHcheckout
Address Document Verification

Create an address document verification

<span style="font-size: 12px; font-weight: 500; color: rgb(0, 0, 0); background-color: rgb(255, 176, 97); border-radius: 4px; padding: 2px 6px" >Beta</span><p></p> Create an address document verification for an applicant.

post/address-document-verifications

Request

Request body

applicant_idstring

The applicant's unique identifier.

user_journey_idstring

Your configuration ID.

Example request

{
  "applicant_id": "aplt_tkoi5db4hryu5cei5vwoabr7we",
  "user_journey_id": "usj_tkoi5db4hryu5cei5vwoabr7we",
  "declared_data": {
    "name": "Hannah Bret",
    "birth_date": "1994-10-15T00:00:00.0000000"
  }
}

Response

Address document verification created successfully

created_onstring date-time required

The date and time when the resource was created, in UTC. <br/>Format – yyyy-mm-ddThh:mm:ss.sss

modified_onstring date-time required

The date and time when the resource was modified, in UTC. <br/>Format – yyyy-mm-ddThh:mm:ss.sss

applicant_idstring required

The applicant's unique identifier.

user_journey_idstring required

Your configuration ID.

idstring required

The address document verification's unique identifier.

status'created' | 'quality_checks_in_progress' | 'checks_in_progress' | 'approved' | 'declined' | 'retry_required' | 'inconclusive' required

The address document verification status.

risk_labelsIdvRiskLabel[]

One or more codes that provide more information about risks associated with the verification.

Example response

{
  "created_on": "2025-07-21T17:32:28.0000000+00:00",
  "modified_on": "2025-07-21T17:40:32.0000000+00:00",
  "applicant_id": "aplt_tkoi5db4hryu5cei5vwoabr7we",
  "user_journey_id": "usj_tkoi5db4hryu5cei5vwoabr7we",
  "declared_data": {
    "name": "Hannah Bret",
    "birth_date": "1994-10-15T00:00:00.0000000"
  },
  "id": "adv_tkoi5db4hryu5cei5vwoabr7we",
  "address_document": {
    "document_type": "utility_bill",
    "issuer": "EDF Energy",
    "full_names": [
      "Hannah Bret"
    ],
    "issue_date": "2024-01-15T00:00:00.0000000",
    "address": {
      "address_line1": "123 Main Street",
      "address_line2": "Apt 4B",
      "city": "London",
      "state": "Greater London",
      "zip": "SW1A 1AA",
      "country": "GB"
    }
  },
  "response_codes": [
    {
      "summary": "document_front_not_captured"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.