Skip to main content
POST
/
v1
/
prior-authorizations
/
{authorization_id}
/
manual-handoffs
/
{handoff_id}
/
revoke
Revoke a manual handoff
curl --request POST \
  --url https://api.sandbox.trycollate.ai/v1/prior-authorizations/{authorization_id}/manual-handoffs/{handoff_id}/revoke \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'If-Match: <if-match>' \
  --data '
{
  "reason": "<string>"
}
'
{
  "manualHandoffId": "<string>",
  "state": "offered",
  "authorization": {
    "id": "<string>",
    "version": 123,
    "status": "requires_action"
  },
  "result": "completed_reported",
  "reconciliation": {
    "id": "<string>",
    "state": "pending"
  }
}

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.

Revocation closes the handoff and revokes active interactive grants. If payer submit may have happened, Collate must reconcile before projecting payer truth.

​
Returns

Returns handoff closure state.

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.

​
handoff_id
string
required

Manual handoff ID returned by POST /manual-handoffs.

Body

application/json
​
reason
string
required
​
notes
string | null

Response

Successful Response

​
manualHandoffId
string
required
​
state
enum<string>
required
Available options:
offered,
active,
closing,
closed
​
authorization
ManualHandoffAuthorizationRef · object
required
​
result
enum<string> | null
Available options:
completed_reported,
unable_to_complete,
expired,
revoked,
interaction_lost_unrecoverable,
canceled
​
reconciliation
ManualHandoffReconciliationRef · object