v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB

KYC/KYB Verifications

Get Document Verification Session

Get document verification session by ID.

get/verifications/docv_session/{document_verification_session_id}

Path parameters

document_verification_session_idstring uuid required

Example:7d943c51-e4ff-4e57-9558-08cab6b963c7

Unique identifier for the document verification session.

Response

Document Verification Session representation.

idstring uuid

Unique ID for this document verification session.

person_idstring uuid required

Unique ID for the person. Exactly one of person_id or business_id must be set.

session_tokenstring required

ID of the document verification session to be used in /verifications/verify request.

status'COMPLETE' | 'PENDING' required

The current state of the document verification session. One of the following:

PENDING – the session is pending verification.
COMPLETE – the end-customer has submitted the requested documents.

urlstring required

URL of the document verification session which can be shared with the end-customer.

Example response

{
  "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "person_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "session_token": "907ce33a-c564-454e-a538-804efe31e6ac",
  "status": "PENDING",
  "url": "https://verify.socure.com/session/907ce33a-c564-454e-a538-804efe31e6ac"
}