Skip to main content
GET
/
v1
/
prior-auth
/
authorizations
/
{authorization_id}
/
requirements
Retrieve authorization requirements
curl --request GET \
  --url https://api.sandbox.trycollate.ai/v1/prior-auth/authorizations/{authorization_id}/requirements \
  --header 'Authorization: Bearer <token>'
{
  "version": 123,
  "questions": [
    {
      "linkId": "<string>",
      "message": "<string>"
    }
  ],
  "documents": [
    {
      "type": "<string>",
      "message": "<string>"
    }
  ],
  "issues": [
    {
      "code": "<string>",
      "message": "<string>",
      "field": "<string>",
      "severity": "error"
    }
  ]
}

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 when you only need missing answers, missing documents, and validation issues. The same object is included on the authorization detail response under requirements. Requirements are not the editable questionnaire. Retrieve the authorization when you need the full question surface.

​
Returns

Returns the current Requirements object.

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-auth/authorizations.

Response

Successful Response

​
version
integer
required

Requirements version for concurrency and nextAction checks.

​
questions
RequirementQuestion · object[]

Unanswered or invalid questionnaire fields blocking progress.

​
documents
RequirementDocument · object[]

Missing supporting documents blocking progress.

​
issues
ValidationIssue · object[]

Validation issues Collate detected on the current snapshot.