Skip to main content
GET
/
v1
/
prior-authorizations
/
{authorization_id}
/
live-session
Retrieve live session
curl --request GET \
  --url https://api.sandbox.trycollate.ai/v1/prior-authorizations/{authorization_id}/live-session \
  --header 'Authorization: Bearer <token>'
{
  "priorAuthorizationId": "<string>",
  "priorAuthorizationVersion": 123,
  "state": "live",
  "access": {
    "available": false,
    "supportedModes": [
      "read_only"
    ]
  },
  "handoff": {
    "allowed": false,
    "state": "unavailable",
    "reason": "<string>",
    "manualHandoffId": "<string>"
  },
  "safety": {
    "irreversibleBoundaryState": "unknown",
    "finalSubmitCapable": false,
    "requiresReviewApprovalForSubmit": false,
    "reviewSnapshotId": "<string>"
  },
  "channel": "<string>",
  "owner": {
    "type": "automation",
    "manualHandoffId": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.trycollate.ai/llms.txt

Use this file to discover all available pages before exploring further.

Use this endpoint while status = processing to show a read-only view of the current payer-channel session, or while manual handoff is active to understand whether interactive access is available. LiveSession is a transparency surface. It is not payer receipt, payer decision, or requirement truth. It never returns raw runtime-provider access URLs; create a live-session access grant when access.available = true.

​
Returns

Returns the current live-session projection. If no session has started, returns state = not_live with 200 OK.

Authorizations

​
Authorization
string
header
default:your-api-key
required

API key passed as Authorization: Bearer <API_KEY>.

Path Parameters

​
authorization_id
string
required

Authorization ID returned by POST /v1/prior-authorizations.

Response

Successful Response

​
priorAuthorizationId
string
required
​
priorAuthorizationVersion
integer
required
​
state
enum<string>
required
Available options:
live,
not_live
​
access
LiveSessionAccess · object
required
​
handoff
LiveSessionHandoff · object
required
​
safety
LiveSessionSafety · object
required
​
channel
string | null
​
owner
LiveSessionOwner · object