---
title: "Create an Address Document Verification"
method: POST
path: "/v2/address-document-verifications"
tags: ["Address document verifications (Coming soon)"]
---

# Create an Address Document Verification

`POST /v2/address-document-verifications`

## Request

- Base URL: `https://api.ubble.ai`
- URL: `https://api.ubble.ai/v2/address-document-verifications`
- Auth: none declared
- TypeScript: <https://skmtc.dev/ubble/apis/checkout-com-identity-verification/docs/v2/address-document-verifications/post.ts> (a function with typed inputs; its response is checked against the schema)

Creates an Address Document Verification

## Request body

- AddressDocumentVerificationInputPost
  - `user_journey_id` string: User journey unique identifier.
  - `applicant_id` string: Applicant unique identifier.
  - `webhook_url` string, uri
  - `declared_data` DeclaredData
    - `name` string, required
    - `birth_date` string, date

## Response `201`

Address Document Verification created successfully

- AddressDocumentVerificationOutputPost
  - `id` string: Address Document Verification unique identifier.
  - `status` 'created' | 'quality_checks_in_progress' | 'checks_in_progress' | 'approved' | 'declined' | 'retry_required' | 'inconclusive': Address Document Verification status.
  - `response_codes` ResponseCodes[]
    - `code` integer, required: The numeric code of the response code.
    - `summary` string, required: A descriptive code of the response code.
  - `risk_labels` RiskLabel[]: Risk assessment labels
  - `address_document` ProofOfAddressDocument
    - `document_type` string
    - `issuer` string
    - `full_names` string[]
    - `address` Address
      - `address_line1` string
      - `address_line2` string
      - `city` string
      - `state` string
      - `zip` string
      - `country` string, ISO 3166-1 alpha-2
    - `issue_date` string, date
  - `_links` AddressDocumentVerificationLinks
    - `self` HalLink, required
      - `href` string, uri, required
  - `user_journey_id` string: User journey unique identifier.
  - `applicant_id` string: Applicant unique identifier.
  - `webhook_url` string, uri
  - `declared_data` DeclaredData
    - `name` string, required
    - `birth_date` string, date
  - `created_on` string, date-time, required: UTC Date time when the resource was created
  - `modified_on` string, date-time, required: UTC Date time when the resource was modified

## Other responses

- `400`: Bad request
- `401`: Unauthorized
- `422`: Unprocessable entity
- `500`: Internal server error
- `503`: Service unavailable

---

[API](https://skmtc.dev/ubble/apis/checkout-com-identity-verification.md) - [All operations](https://skmtc.dev/ubble/apis/checkout-com-identity-verification/llms.txt) - [OpenAPI document](https://skmtc.dev/ubble/apis/checkout-com-identity-verification/revisions/739e9da12584?raw)