List Sessions

curl --request GET \
  --url https://api.deepidv.com/v1/sessions

import requests

url = "https://api.deepidv.com/v1/sessions"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.deepidv.com/v1/sessions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.deepidv.com/v1/sessions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.deepidv.com/v1/sessions"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.deepidv.com/v1/sessions")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.deepidv.com/v1/sessions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "sessions": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "organization_id": "org_abc123",
      "user_id": "usr_def456",
      "sender_user_id": "usr_ghi789",
      "status": "VERIFIED",
      "type": "session",
      "session_progress": "COMPLETED",
      "created_at": "2025-01-15T10:30:00.000Z",
      "updated_at": "2025-01-15T10:45:00.000Z"
    }
  ],
  "next_token": "eyJpZCI6ImFiYzEyMyJ9"
}

GET

sessions

List Sessions

curl --request GET \
  --url https://api.deepidv.com/v1/sessions

import requests

url = "https://api.deepidv.com/v1/sessions"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.deepidv.com/v1/sessions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.deepidv.com/v1/sessions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.deepidv.com/v1/sessions"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.deepidv.com/v1/sessions")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.deepidv.com/v1/sessions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "sessions": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "organization_id": "org_abc123",
      "user_id": "usr_def456",
      "sender_user_id": "usr_ghi789",
      "status": "VERIFIED",
      "type": "session",
      "session_progress": "COMPLETED",
      "created_at": "2025-01-15T10:30:00.000Z",
      "updated_at": "2025-01-15T10:45:00.000Z"
    }
  ],
  "next_token": "eyJpZCI6ImFiYzEyMyJ9"
}

GET /v1/sessions

Returns a paginated list of verification sessions. By default, returns sessions created by the authenticated user. Use query parameters to list by organization or filter by external ID.

Request

Headers

Header	Required	Description
`x-api-key`	Yes	Your API key

Query parameters

Parameter	Type	Required	Default	Description
`limit`	number	No	`50`	Number of sessions to return (1–500)
`next_token`	string	No	—	Pagination token from a previous response
`start_date`	string	No	—	Filter sessions created on or after this date (ISO 8601)
`end_date`	string	No	—	Filter sessions created on or before this date (ISO 8601)
`by_organization`	boolean	No	`false`	When `true`, returns all sessions for your organization instead of only those you created
`external_id`	string	No	—	Filter sessions by your external reference ID
`workflow_id`	string	No	—	Filter sessions by workflow ID

Query modes are evaluated in priority order: external_id > workflow_id > by_organization > default sender-based query.

Example requests

List your sessions (default)

curl -X GET "https://api.deepidv.com/v1/sessions?limit=25&start_date=2025-01-01T00:00:00Z" \
  -H "x-api-key: YOUR_API_KEY"

const params = new URLSearchParams({
  limit: "25",
  start_date: "2025-01-01T00:00:00Z",
});

const response = await fetch(
  `https://api.deepidv.com/v1/sessions?${params}`,
  {
    headers: { "x-api-key": "YOUR_API_KEY" },
  }
);

const data = await response.json();

import requests

response = requests.get(
    "https://api.deepidv.com/v1/sessions",
    headers={"x-api-key": "YOUR_API_KEY"},
    params={
        "limit": 25,
        "start_date": "2025-01-01T00:00:00Z",
    },
)

List all organization sessions

curl -X GET "https://api.deepidv.com/v1/sessions?by_organization=true&limit=100" \
  -H "x-api-key: YOUR_API_KEY"

const params = new URLSearchParams({
  by_organization: "true",
  limit: "100",
});

const response = await fetch(
  `https://api.deepidv.com/v1/sessions?${params}`,
  {
    headers: { "x-api-key": "YOUR_API_KEY" },
  }
);

const data = await response.json();

import requests

response = requests.get(
    "https://api.deepidv.com/v1/sessions",
    headers={"x-api-key": "YOUR_API_KEY"},
    params={
        "by_organization": "true",
        "limit": 100,
    },
)

Filter by workflow ID

curl -X GET "https://api.deepidv.com/v1/sessions?workflow_id=wf_abc123" \
  -H "x-api-key: YOUR_API_KEY"

const params = new URLSearchParams({
  workflow_id: "wf_abc123",
});

const response = await fetch(
  `https://api.deepidv.com/v1/sessions?${params}`,
  {
    headers: { "x-api-key": "YOUR_API_KEY" },
  }
);

const data = await response.json();

import requests

response = requests.get(
    "https://api.deepidv.com/v1/sessions",
    headers={"x-api-key": "YOUR_API_KEY"},
    params={"workflow_id": "wf_abc123"},
)

Filter by external ID

curl -X GET "https://api.deepidv.com/v1/sessions?external_id=user-12345" \
  -H "x-api-key: YOUR_API_KEY"

const params = new URLSearchParams({
  external_id: "user-12345",
});

const response = await fetch(
  `https://api.deepidv.com/v1/sessions?${params}`,
  {
    headers: { "x-api-key": "YOUR_API_KEY" },
  }
);

const data = await response.json();

import requests

response = requests.get(
    "https://api.deepidv.com/v1/sessions",
    headers={"x-api-key": "YOUR_API_KEY"},
    params={"external_id": "user-12345"},
)

Response

200 — Success

Field	Type	Description
`sessions`	array	Array of session objects (see Retrieve Session for full field reference)
`next_token`	string \| null	Pagination token to fetch the next page. `null` when no more results

The user, sender_user, and resource_links fields are only returned when retrieving a single session by ID. List responses include the session_record fields only.

Pagination

To fetch the next page of results, pass the next_token from the response as a query parameter:

curl -X GET "https://api.deepidv.com/v1/sessions?limit=25&next_token=eyJpZCI6ImFiYzEyMyJ9" \
  -H "x-api-key: YOUR_API_KEY"

Continue paginating until next_token is null.

Error responses

Status	Description
`400 Bad Request`	Invalid query parameters (e.g., limit out of range, invalid date format, invalid next_token)
`401 Unauthorized`	Missing or invalid API key
`429 Too Many Requests`	Rate limit exceeded

{
  "sessions": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "organization_id": "org_abc123",
      "user_id": "usr_def456",
      "sender_user_id": "usr_ghi789",
      "status": "VERIFIED",
      "type": "session",
      "session_progress": "COMPLETED",
      "created_at": "2025-01-15T10:30:00.000Z",
      "updated_at": "2025-01-15T10:45:00.000Z"
    }
  ],
  "next_token": "eyJpZCI6ImFiYzEyMyJ9"
}

Retrieve Session Update Session Status

Specifications

Sessions

Credit Check

Financial

Management API 🔧

Silent Screening

Async Jobs

Server-to-Server

Sandbox

List Sessions

Request

Headers

Query parameters

Example requests

List your sessions (default)

List all organization sessions

Filter by workflow ID

Filter by external ID

Response

200 — Success

Error responses

​Request

​Headers

​Query parameters

​Example requests

​List your sessions (default)

​List all organization sessions

​Filter by workflow ID

​Filter by external ID

​Response

​200 — Success

​Pagination

​Error responses

Request

Headers

Query parameters

Example requests

List your sessions (default)

List all organization sessions

Filter by workflow ID

Filter by external ID

Response

200 — Success

Pagination

Error responses