Docs › API reference › Hosted SDK data

List IDV provider sessions

Lists the identity verification provider sessions that this check used. One ID check is billed per session ID, so reading the same session twice still counts as one.

GEThttps://api.screenlyyid.com/api/v1/document/sessions

Headers#

Name	Type	Required	Description
`x-api-key`	string	Yes	Your ScreenlyyID API key
`x-correlation-id`	string (uuid)	Yes	Correlation ID for this customer check

Responses#

Status	Description
`200`	Successful response

Code samples#

curl --request GET \
  --url 'https://api.screenlyyid.com/api/v1/document/sessions' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'x-correlation-id: YOUR_CORRELATION_ID'

const response = await fetch(
  "https://api.screenlyyid.com/api/v1/document/sessions",
  {
    "method": "GET",
    "headers": {
      "x-api-key": "YOUR_API_KEY",
      "x-correlation-id": "YOUR_CORRELATION_ID"
    }
  }
);

const result = await response.json();

import requests

response = requests.get(
    'https://api.screenlyyid.com/api/v1/document/sessions',
    headers={
        "x-api-key": "YOUR_API_KEY",
        "x-correlation-id": "YOUR_CORRELATION_ID"
    }
)
result = response.json()

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("x-api-key", "YOUR_API_KEY");
client.DefaultRequestHeaders.Add("x-correlation-id", "YOUR_CORRELATION_ID");
var response = await client.GetAsync("https://api.screenlyyid.com/api/v1/document/sessions");
response.EnsureSuccessStatusCode();
var result = await response.Content.ReadAsStringAsync();