v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB

KYC/KYB Verifications

List Document Verification Sessions

List of document verification sessions available for customers.

get/verifications/docv_session

Query parameters

idstring[]

Unique identifier for the resource. Multiple IDs can be provided as a comma-separated list.

statusDocumentVerificationSessionStatus[]

The status of available verification sessions. Multiple values can be provided as a comma-separated list.

[
  "PENDING"
]

page_tokenstring

Optional pagination token to be provided to retrieve subsequent pages, returned from previous get

Example:a8937a0d

person_idstring[]

Unique identifier for the person. Multiple IDs can be provided as a comma-separated list.

limitinteger

Maximum number of objects to return per page. If the limit is greater than 100, then it will be set to 100.

Example:100

Response

List of available document verification sessions.

next_page_tokenstring

If returned, use the next_page_token to query for the next page of results. Not returned if there are no more rows.

Example response

{
  "document_verification_sessions": [
    {
      "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"
    }
  ],
  "next_page_token": "a8937a0d"
}