Get proof of address verification results via Webhooks

Webhooks provide an efficient way to get notified when a proof of address verification has been completed, and to retrieve the related verification results.
For more details on setting up and managing Webhooks, please refer to this dedicated section.

To receive those notifications, subscribe to the following event:

Event	Description
`verification.proof_of_address.done`	Triggered when a proof of address verification is completed

Example Webhook payload for a verified proof of address verification:

{
    "event_id": "d09f0367-d80a-309c-a2ed-7083991fc564",
    "event_name": "verification.identity_document.done",
    "event_time": "1348177752",
    "subscription_id": "d09f0367-d80a-309c-a2ed-7083991fc564",
    "subscription_description": "A great webhook",
    "sandbox": false,
    "data": {
        "proof_of_address": {
            "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:46+00:00",
            "status": "failed",
            "status_codes": [
                "POAV_1611",
                "POAV_1612"
            ],
            "data_anonymized": false,
            "data": {
                "extracted_from_document": {
                    "first_name": "JOHN",
                    "last_name": "DOE",
                    "full_address": "13 RUE SAINT MARCELIN\nMARSEILLE 10E (13)",
                    "issued_on": "2025-03-18",
                    "2d_doc": {
                        "full_name": "/DOE/JOHN",
                        "address": {
                            "line1": "13 RUE SAINT MARCELIN",
                            "postal_code": "81000",
                            "city": "MARSEILLE",
                            "country_code": "FR"
                }
            }
        }
    }
}

For more information on the statuses and status codes, refer to this section.

Retrieve detailed proof of address verification results

You can also obtain detailed verification results by calling a dedicated endpoint, with the id returned when requesting a proof of address verification:

GET /verifications/proofs_of_address/{id}

{
    "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:46+00:00",
    "status": "failed",
    "status_codes": [
        "POAV_1611",
        "POAV_1612"
    ],
    "data_anonymized": false,
    "data": {
        "extracted_from_document": {
            "first_name": "JOHN",
            "last_name": "DOE",
            "full_address": "13 RUE SAINT MARCELIN\nMARSEILLE 10E (13)",
            "issued_on": "2025-03-18",
            "2d_doc": {
                "full_name": "/DOE/JOHN",
                "address": {
                    "line1": "13 RUE SAINT MARCELIN",
                    "postal_code": "81000",
                    "city": "MARSEILLE",
                    "country_code": "FR"
                }
            }
        }
    }
}

Similar to the webhook, you will receive the verification status and any associated status codes if the verification was failed and/or inconclusive. For more information on the statuses and status codes, refer to this section.

This endpoint returns also the matched inputs and extracted data from the proof of address document and 2d-doc, such as the holder's name, the address and issuance date. Not all information listed in the example above is always available in the proof of address document. When a piece of information is missing, the endpoint will return null for that field.

After 7 days, proof of address verification records are anonymized, meaning all personal or sensitive data associated with the verification request is permanently deleted.

If you attempt to retrieve any verification details beyond this retention period, fields containing sensitive data will return null, and the data_anonymized parameter will be set to true.

List all proof of address verification requests

To retrieve a list of all verification requests, you can call the following endpoint. You can filter by status or paginate the results based on your needs:

GET /verifications/proofs_of_address

{
    "meta": {
        "next_cursor": "string"
    },
    "data": [
        {
            "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:46+00:00",
            "status": "pending",
            "status_codes": [],
            "data_anonymized": false
        }
    ]
}