Request a proof of address verification

To initiate a new proof of address verification, send the file containing the document using the following endpoint:

POST /verifications/proofs_of_address

curl --location --request POST '{baseUrl}/verifications/proof_of_address' \
--header 'Authorization: Bearer {apiKey}' \
--form 'file=@"/path/to/the/document/proof_of_address.jpeg"' 

{
    "id": "9a93d3b5-fb3b-4abf-9e70-26315b33506c",
    "workspace_id": "090b4f7e-25e8-423d-9387-741f6188ba7a",
    "created_at": "2025-03-24T13:32:26+00:00",
    "updated_at": "2025-03-24T13:32:26+00:00",
    "status": "pending",
    "status_codes": [],
    "data_anonymized": false,
    "data": {
        "extracted_from_document": {
            "first_name": null,
            "last_name": null,
            "full_address": null,
            "issued_on": null,
            "2d_doc": {
                "full_name": null,
                "address": {
                    "line1": null,
                    "postal_code": null,
                    "city": null,
                    "country_code": null
                }
            }
        }
    }
}

Query param rules

To ensure optimal verification performance and reduce the risk of false positives, please follow the recommendations below when configuring query parameters for your API requests:

1. Accept the following document types only:

• Electricity and gas bills or certificates
• Water bills
• Telephone and internet bills
• Housing tax notices (taxe d’habitation)
• Property tax notices (taxe foncière)
• Income tax assessments (avis d’imposition)

ℹ️ Please note that:

• If an unsupported document is submitted, the API will return a failed status with the status code POAV_1509 (please refer to this section)
• Accommodation certificates (attestations d’hébergement) are not supported at this time.

2. Prefer documents with a 2D-Doc

When requesting a verification, prioritize proof of address documents that contain a 2D-Doc.
The verification will automatically read and extract the information from the 2D-Doc and cross-check it with the provided document content for a higher-confidence result.

ℹ️ Note: The extracted information depends on what’s embedded in the 2D-DOC. Not all fields may be available.

3. Fill the optional query parameters

To improve the accuracy of matching and strengthen the verification process, we strongly recommend providing the following optional query parameters:
• first_name
• last_name
• address, postal code and city

Providing this contextual data allows the verification to perform targeted matching against document content.

In the response, you'll find the id. This value is required to retrieve the verification results.