Sessions

Each transaction is associated with a session. You can start a session manually and then use the session ID to link transactions within a unified group. You can pass the session ID to the transaction endpoint to associate the transaction with a session. For example, you can start a session and then use the session ID to link Consent, Enrollment and Process Video transactions together and all transactions will be represented in the same session in the Dashboard.

Tip

Make sure to end a session as soon as you are done with it. If you don’t end a session, it will be stated as abandoned in the Dashboard.

Note

x-request-id (id that returned in the response header) is not the id of the session. x-request-id is the ID of the transaction.

Start a session

Authorization

This endpoint requires an API token as Bearer in the Authorization header. Go to Authorization guide for details.

Request

POST https://api.biometrysolutions.com/api-gateway/sessions/start

Parameters

• No parameters are required for this endpoint.

Headers

• Authorization* - Your API Token.

Responses

200

The object with data and message fields.

• data - Contains the session ID

• message - Message with the status of the operation.

Consists of response headers: - X-Request-Id - equivalent of transaction_id and can be used to get the data provided by user using Get samples and Result tagging

Response sample:

{
  "data": "string",
  "message": "string"
}

Sample

Request

curl --location 'https://api.biometrysolutions.com/api-gateway/sessions/start' \
     --request POST \
     --header 'Authorization: Bearer eyJhbGciO...ANYea8r2xOG-Urc'

Response

{
  "data": "sess_fe402c29-b543-4413-8624-af1a2a0b2f2c",
  "message": "session started successfully"
}

Response header

X-Request-Id: fc5605c5-...-87cc-979cd72564d4

End a session

Authorization

This endpoint requires an API token as Bearer in the Authorization header. Go to Authorization guide for details.

Request

POST https://api.biometrysolutions.com/api-gateway/sessions/end/{session_id}

Parameters

• No parameters are required for this endpoint.

Headers

• Authorization* - Your API Token.

Response

{
  "message": "session ended successfully"
}