Skip to content

Getting Session Data via API

This article describes how to retrieve session data from the IDV Platform using the API.

Authentication

To access session data, you must use an authentication method supported by the IDV Platform. You can use either Basic authentication or API key authentication.

For API-based integrations, we recommend using API keys for a more seamless and secure experience. To retrieve session data, it is sufficient to use an API key with the All Sessions:Read permission.

You can create an API key using one of the methods described in the API key documentation.

API Request

Use the following cURL request structure to fetch session data:

curl '<base_url>/api/sessions/<id>' \
  -H 'accept: application/json' \
  -H 'authorization: ApiKey <apikey>'

Replace the placeholders as follows:

  • base_url — the base URL of your IDV Platform instance.
  • id — the IDV session ID.
  • apikey — your application key.

Session Data Structure

A session serves as a container for all information collected during the verification process. It consists of a set of structured and unstructured data elements.

While the exact contents of a session depend on the workflow used for data capture, the overall session container structure remains consistent across different workflows.

The most common types of data available in the session container are listed below:

Data type Key Description Retrieval method
Session ID id Unique identifier assigned to the session by the IDV Platform at session start. Directly available in the session JSON response.
Status status Current session status represented as an integer. To interpret the value, see the Session Statuses article. Directly available in the session JSON response.
Session properties properties Structured data collected in form fields during the session. Directly available in the session JSON response.
Session files files Unstructured data such as images, binary files, or HTTP request/response data. Each file is referenced by a unique URL in the session response. Files are stored in the Platform file storage.
Metadata metadata Values included in the session at the time it was started. Directly available in the session JSON response.