Skip to main content

Create ticket pair for WebSocket

POST 
/session/websocket

Creates a connection ticket and authorisation ticket for establishing a WebSocket connection. The connection ticket is used by the client to connect to the WebSocket endpoint, while the authorisation ticket is used to verify the client's identity once the connection is established. Both tickets are only valid for 30 seconds.

Websockets are used to receive notifications of updates to sessions in near real-time, such as for asynchronous document processing or open banking connections. It is not required for typical synchronous document extraction operations.

Requires a valid session ID to be supplied as a header. The session must be active and the session key (if applicable) must be valid. The request must be authenticated with the 'websockets:initiate' scope.

Request​

Responses​

Ticket pair created successfully