Getting started
Core resources
Other

Verification result via Status API

Partners can check verification status through our verification status API endpoint (GET /api/partner/v2/verify/requests/{id}). This endpoint returns both verification result and credential information for a specific verification request.
Authentication requires a JWT token from our OAuth token endpoint, and the API needs a request ID that was created when the original verification request was submitted.

Statuses

StatusDescription
incompleteThe verification is in progress. There are no results available at this stage.
canceled The verification is no longer proceeding and there is no result available.
verified

The verification is successfully completed and the result is available.

revokedThe verification result is not valid. All copies of the result should be deleted.
unshared The verification result is not available. This happens when the user requests the sharing to end, or has not yet consented to share an updated credential.
Please refer to our OpenAPI Specification V2 for more details on the request and response formats.

Sample requests

Sample verification result: Verified credential
# GET /api/partner/v2/verify/requests/7cbc7e51-82f5-43ec-8d63-b7cdf1170425

{
    "request_id": "7cbc7e51-82f5-43ec-8d63-b7cdf1170425",
    "created_at": "2026-03-11T23:44:03.863583Z",
    "results": [
        {
            "credential_type": "digital_identity",
            "status": "verified",
            "verified_at": "2026-03-12T00:27:46.657218Z",
            "digital_identity": {
                "full_name": "John Smith"
            }
        }
    ]
}
Sample verification result: Incomplete verification
{
    "request_id": "9a98ba28-cd63-43d4-9959-9c593700c7da",
    "created_at": "2026-01-20T02:43:09.440220Z",
    "results": [
        {
            "credential_type": "digital_identity",
            "status": "incomplete"
        }
    ]
}
Sample verification result: Canceled verification
{
    "request_id": "793a798c-92ac-4b5f-9866-ef73e6b4c6d9",
    "created_at": "2026-01-20T02:43:09.440220Z",
    "results": [
        {
            "credential_type": "digital_identity",
            "status": "canceled"
        }
    ]
}

Bulk Status API

A bulk status API is also available for querying the status of multiple verification requests simultaneously. Up to 30 request IDs can be included in a single query.
Info
Due to maximum query size restrictions, depending on the length of the IDs provided, you might receive a 403 Forbidden response if your query string is longer than 2048 bytes. If you reach this limit, please reduce the number of query IDs passed in your request and try again.
# GET /api/partner/v2/verify/requests?request_id[]=25055614-f707-47cc-b7ed-1724c04dcd05&request_id[]=9a98ba28-cd63-43d4-9959-9c593700c7da
{
    "requests": [
        {
            "request_id": "9a98ba28-cd63-43d4-9959-9c593700c7da",
            "created_at": "2026-01-20T02:43:09.440220Z",
            "results": [
                {
                    "credential_type": "digital_identity",
                    "status": "incomplete"
                }
            ]
        },
        {
            "request_id": "25055614-f707-47cc-b7ed-1724c04dcd05",
            "created_at": "2025-12-18T06:34:34.338171Z",
            "results": [
                {
                    "credential_type": "digital_identity",
                    "status": "verified",
                    "verified_at": "2025-12-18T07:26:01.571197Z",
                    "digital_identity": {
                        "full_name": "John Smith"
                    }
                }
            ]
        }
    ]
}