Get identity Document Analysis results via Webhooks

Webhooks provide an efficient way to get notified when an Document Analysis has been completed, and to retrieve the related 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
`document_analysis.done`	Triggered when an document analysis is completed

Example Webhook payload for a Document Analysis with a status : done

{
    "id": "@uuid@",
    "workspace_id": "@uuid@",
    "status": "done",
    "type": "social_security",
    "data_anonymized": false,
    "created_at": "@datetime@",
    "updated_at": "@datetime@",
    "extracted_from_document": {
        "first_name": "John",
        "last_name": "Doe",
        "social_security_number": "1234567890123",
        "full_name": "John Doe"
    }
}

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

Retrieve detailed Document Analysis results

You can also obtain detailed Document Analysis results by calling a dedicated endpoint, with the id returned when requesting a Document Analysis :

GET /document_analyses/{id}

{
    "id": "@uuid@",
    "workspace_id": "@uuid@",
    "status": "done",
    "type": "social_security",
    "data_anonymized": false,
    "created_at": "@datetime@",
    "updated_at": "@datetime@",
    "extracted_from_document": {
        "first_name": "John",
        "last_name": "Doe",
        "social_security_number": "1234567890123",
        "full_name": "John Doe"
    }
}

Similar to the webhook, you will receive the Document Analysis status if the status was failed. For more information on the statuses, refer to this section .

After 7 days, Document Analysis results are anonymized, meaning all personal or sensitive data associated with the Document Analysis 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:

{
    "id": "@uuid@",
    "workspace_id": "@uuid@",
    "status": "done",
    "type": "social_security",
    "data_anonymized": true,
    "created_at": "@datetime@",
    "updated_at": "@datetime@",
    "extracted_from_document": {
        "first_name": null,
        "last_name": null,
        "social_security_number": null,
        "full_name": null
    }
}

List all Document Analysis requests

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

GET /document_analyses

{
    "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",
            "data_anonymized": false
        }
    ]
}