Skip to main content

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.

The Collate Prior Auth API submits prior authorizations to U.S. health plans through a single resource: the Authorization. You create an authorization for a payer submission, answer the questionnaire the API surfaces, attach the required supporting documents, and confirm when the case is ready to advance. Collate handles payer-portal navigation, submission, payer receipt, and decision tracking.

​
How an authorization moves

Two fields drive every authorization: status and nextAction. status says where the case is. nextAction says what to do next when the case is yours.
statusOwnerWhat you do
requires_inputYouPatch answers and attach files.
requires_confirmationYouConfirm the current nextAction.
processingCollateWait.
waiting_on_payerPayerWait.
completed—Read outcome and submission.decision.
canceled—Stop.
nextAction.typeResolve by
provide_requirementsPatching answers and attaching files. Do not call /confirm.
advance_caseCalling /confirm with the current nextAction.id.
approve_submissionReviewing submission.reviewSnapshot, then calling /confirm.
See Authorization lifecycle for the full state machine.

​
The integration loop

Read the authorization. Act on the current status. 
status = requires_input
  → PATCH /answers, POST /attachments

status = requires_confirmation
  → POST /confirm with the current nextAction.id

status = processing or waiting_on_payer
  → Wait, then read again

status = completed or canceled
  → Stop
That single loop covers progressive discovery, immediate-submission cases, and final-approval gating.

​
Resources

You usually work with four resources:
ResourcePurpose
AuthorizationThe durable case. Source of truth for state.
FileUpload supporting documents.
ProviderTenant-scoped providers, looked up by NPI.
PayerCanonical payer destinations.

​
Next steps

Quickstart

Create, fill, attach, and confirm a sandbox authorization in TypeScript.

Authorization lifecycle

The full state machine, transitions, and polling model.

Final submission approval

Render submission.reviewSnapshot and confirm at the final payer boundary.

Attaching files

Upload, complete, and link supporting documents.

Canonical fields

Stable linkIds to map directly from your source systems.

API reference

Authentication, idempotency, concurrency, and errors.