Get sessions

Retrieves a list of Identity Verification sessions performed in a tenant, along with their results and metadata.

Operation parameters

Note

For the purpose of retrieving a list of Identity Verification sessions, the following fields should be set as follows:

Credentials to connect with : The Client ID and Client Secret of any application in your tenant. Retrieve the credentials from any application in your tenant (available in the application settings ). These credentials are not scoped to a specific app—they grant access to the entire tenant. Once saved, the credentials are stored as a Transmit Security account and can be updated at any time.
Resource : Identity Verification
Operation : Get sessions

Return all : Retrieves all Identity Verification sessions performed in the tenant in the last 24 hours. The response always includes the following default metadata:
- Time
- Session Id
- Status
- Recommendations
- Rejection Description
Limit : Defines the maximum number of sessions to return. If not specified, the default is 1000.
Add filter : Narrows down the query results by excluding entries that do not meet the selected criteria. Filters control which results are returned, while the default output format — which includes only Time , Session Id , Status , Recommendations , and Rejection Description — remains unchanged. To extend the output with personally identifiable information, the "Include PII" filter must be explicitly set to TRUE .
- Application ID Names or IDs : Includes sessions related to specific applications. Choose from the list or specify IDs using an expression.
- End Date : Sets the latest date in the custom time range.
- Start Date : Sets the earliest date in the custom time range.
  Note
  The total lookback period cannot exceed 30 days. To avoid duplicate results and manage load, we recommend using a backward time window and scheduling the workflow accordingly.
- Verification Status : Filters by one or more document verification outcomes:
  - Error
  - Pending
  - Rejected
  - Resubmit
  - Success
  - Uncertain
- Session Status : Filters by one or more session lifecycle states:
  - Capturing
  - Complete
  - Error
  - Expired
  - Pending
  - Processing
  - Recapture
- Rejection Reason Names or IDs : Includes sessions with selected rejection reasons. Choose from the list or specify their IDs using an expression.
  - Data Extraction Failed
  - Data Validation Failed
  - Data Comparison Failed
  - Mrz Check Digits Invalid
  - Face Tampering
  - Face Not Found
  - Missing Security Features
  - Document Tampering
  - Wrong Font
  - Document Damaged
  - Document Template Mismatch
  - Presentation Attack
  - Biometric Mismatch
  - Age Mismatch
  - Gender Mismatch
  - Screen Capture
  - Printed Copy Capture
  - Printed Cutout
  - Mask Detected
  - Injection Attack Detected
  - Selfie Liveness Attack
  - Multiple Faces Detected
  - Multiple Same Identity Attempts
  - Previous Document Fraud
  - Previous Face Fraud
  - Repeated Face Fraud
- Include PII : If enabled, includes personally identifiable information (PII) in the response. When this is selected, the default session metadata is omitted from the results. Data includes:
  - Full Name
  - Date Of Birth
  - Give Name
  - Surname
  - National Id
  - Gender
  - Address
  - Country
  - Region
  - Document Id
  - Type
  - Valid From
  - Valid Until
  - Document Name

Result

When the node is executed, it retrieves a list of Identity Verification sessions that match the selected filters. Each session is returned as a table row, a JSON object within an array, or a schema item—depending on how the data is used downstream. The output includes the default metadata (if Include PII is not selected) and any additional metadata specified through filters.