GET
/api/v1/verification/api/status/{verification_id}/

Returns the current state and result of a verification you submitted earlier. Use it to poll a verification that has not completed, and to retrieve the result afterwards.

The identifier can be any of the references a submission hands back:

  • an SDK session id, like sdk_session_6c8e3f94...
  • a verification UUID, with hyphens or underscores
  • a reference id, like ver_document_w_face_jba9xnk8r1

Not billed — checking a status does not re-run the verification, so poll as often as you need.

Older integrations may call this on other paths, or by passing the identifier as a session_id, verification_id or reference_id query parameter instead of in the path. Those still work and are not documented; new integrations should use this path.

Authorization

ApiKeyAuth
X-API-Key<token>

In: header

Path Parameters

verification_id*string

SDK session id, verification UUID, or reference id.

Response Body

application/json

curl -X GET "https://example.com/api/v1/verification/api/status/ver_document_w_face_jba9xnk8r1/"
{  "data": {},  "status": true,  "message": "Request successful.",  "errors": {},  "meta": {    "timestamp": "2019-08-24T14:15:22Z",    "version": "v1",    "request_id": "string"  },  "pagination": {    "page": 0,    "page_size": 0,    "total_pages": 0,    "total_items": 0  }}
Response Codes & Statuses: Prembly API responses include custom response_code values (e.g., 00 Success, 01 Not Found, 02 Unavailable).
View Response Codes Guide
Prembly Slack Community

Join our developer Slack channel for real-time integration support, engineering updates, and direct Q&A with the Prembly team.

Join Slack Channel