Skip to main content
GET
/
v1
/
prior-authorizations
/
{authorization_id}
/
manual-handoffs
/
{handoff_id}
Retrieve a manual handoff
curl --request GET \
  --url https://api.sandbox.trycollate.ai/v1/prior-authorizations/{authorization_id}/manual-handoffs/{handoff_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "version": 123,
  "priorAuthorizationId": "<string>",
  "state": "offered",
  "createdAt": "2023-11-07T05:31:56Z",
  "result": "completed_reported",
  "accessAvailable": false,
  "finalSubmitCapable": false,
  "activatedAt": "2023-11-07T05:31:56Z",
  "closedAt": "2023-11-07T05:31:56Z",
  "message": "<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 to inspect handoff state, result, and the operator-reported completion claim. Authorization truth remains on the PriorAuthorization response.

​
Returns

Returns the ManualHandoff.

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.

​
handoff_id
string
required

Manual handoff ID returned by POST /manual-handoffs.

Response

Successful Response

​
id
string
required
​
version
integer
required
​
priorAuthorizationId
string
required
​
state
enum<string>
required
Available options:
offered,
active,
closing,
closed
​
createdAt
string<date-time>
required
​
result
enum<string> | null
Available options:
completed_reported,
unable_to_complete,
expired,
revoked,
interaction_lost_unrecoverable,
canceled
​
accessAvailable
boolean
default:false
​
finalSubmitCapable
boolean
default:false
​
activatedAt
string<date-time> | null
​
closedAt
string<date-time> | null
​
message
string | null