Skip to main content
POST
/
v1
/
prior-authorizations
/
{authorization_id}
/
manual-handoffs
Create a manual handoff
curl --request POST \
  --url https://api.sandbox.trycollate.ai/v1/prior-authorizations/{authorization_id}/manual-handoffs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'If-Match: <if-match>' \
  --data '
{
  "acceptedReviewSnapshotId": "<string>"
}
'
{
  "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 only when the current nextAction.type is complete_payer_interaction and nextAction.resolution.kind is manual_handoff. Customer calls during processing are rejected with manual_handoff_not_allowed. Creating a handoff does not prove payer submission or receipt. Once active, mutating automation does not resume for that interaction lineage.

​
Returns

Returns the durable ManualHandoff.

Authorizations

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

API key passed as Authorization: Bearer <API_KEY>.

Headers

​
If-Match
string
required

Current authorization version as a quoted entity tag, for example "17". Required on mutable authorization operations to prevent overwriting concurrent changes.

​
Idempotency-Key
string
required

Unique key used to retry command requests safely. Reusing the same key with a different request body returns 409 idempotency_key_reused.

Path Parameters

​
authorization_id
string
required

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

Body

application/json
​
acceptedReviewSnapshotId
string | null

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