Sign in

v1

latestOpenAPI 3.0.0proprietary2026-07-261695971.5 MB
Proof of Address Verification

Initiate a new Proof of Address Verification

Ask for a Proof of Address Verification by sending a supported document type (see our guide for more info).

ℹ️ This endpoint accepts two request body formats — pick the one that matches your use case:

  • 📁 multipart/form-data — upload a binary file containing the proof of address.
  • 📝 application/json — reference an existing Workflow Session Applicant by ID.

🔓 Endpoint access

  • Environments: production, sandbox
  • API key scopes: organization, workspace
  • Plans: pro, scale
  • Add-ons (for production access): Verify - Proof of address check
post/verifications/proofs_of_address

Request body

applicant_idstring uuid required

The Applicant ID linked to the Workflow Session.

Example request

{
  "applicant_id": "9a93d3b5-fb3b-4abf-9e70-26315b33506c"
}

Response

Created

idstring uuid required

The unique identifier for a resource.

workspace_idstring uuid required

The Workspace ID in which the Proof of Address Verification has been created.

created_atstring date-time required

Creation date of the Proof of Address Verification.

updated_atstring date-time required

Update date of the Proof of Address Verification.

status'pending' | 'awaiting_data' | 'verified' | 'failed' | 'inconclusive' required

Status of the verification

status_codesstring[] required

List of status codes. Indicates the cause when the status is failed or inconclusive.

data_anonymizedboolean required

Indicates if the data related to the ProofOfAddress Verification has been anonymized. If set to true, the data are removed and most fields will be NULL.

workflow_session_idstring uuid nullable required

Unique identifier of a Workflow Session. When provided, an Action is created in the Workflow Session, and this resource is associated with that Action.

previous_attempt_idstring uuid nullable required

ID of the previous attempt within the same workflow_session_id. Allows continuity between multiple attempts of the same Action. Null if this is the first attempt.

applicant_idstring uuid nullable required

Unique identifier of an Applicant.

Example response

{
  "id": "9a93d3b5-fb3b-4abf-9e70-26315b33506c",
  "workspace_id": "9a93d3b5-fb3b-4abf-9e70-26315b33506c",
  "created_at": "2025-02-12T23:59:59Z",
  "updated_at": "2025-02-12T23:59:59Z",
  "status": "failed",
  "status_codes": [
    "POAV_1611",
    "POAV_1612"
  ],
  "workflow_session_id": "0ef334d2-7f36-4643-8a2a-4283b4a3e4a4",
  "previous_attempt_id": "9412b83b-b4b9-4a94-97b5-2b43dfa4cde4",
  "applicant_id": "0ef334d2-7f36-4643-8a2a-4283b4a3e4a4",
  "data": {
    "extracted_from_document": {
      "first_name": "John",
      "last_name": "Doe",
      "full_address": "Rue De Suède Av Pierre Berthelot 14000 CAEN",
      "issued_on": "2022-01-01",
      "document_type": "tax_notice",
      "2d_doc": {
        "full_name": "John Doe",
        "address": {
          "line1": "18 rue de Londres",
          "postal_code": "75008",
          "city": "Paris",
          "country_code": "FR"
        }
      }
    }
  }
}