Skip to main content
GET
Read session status

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

session_id
string
required

session_id from the initiate-session response

Pattern: ^[A-Za-z0-9_-]{8,64}$

Response

Successful Response

Response to reading a session's status.

code
integer
required

HTTP status code of the response

timestamp
integer
required

Unix millisecond timestamp of when the response was produced

transaction_id
string
required

Identifier for this call. Quote it when raising a query about one

data
SessionStatus · object
required

Live state of a consent session.

status is created until the user finishes granting consent and succeeded once they have; read the documents only after it reports succeeded.