Skip to main content
POST
/
v1
/
sandbox
/
prior-auth
/
authorizations
/
{authorizationId}
/
payer-events
curl --request POST \ --url https://api.sandbox.trycollate.ai/v1/sandbox/prior-auth/authorizations/{authorizationId}/payer-events \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "type": "more_info_request", "documentFileId": "file_456", "message": "Payer requested updated clinical notes documenting prior therapy response.", "requestedDocuments": [ "Updated clinical notes documenting prior therapy response" ], "resolutionHint": "Attach the updated note, resolve the action, and resubmit." } '
{ "id": "auth_123", "workflowState": "action_required", "decisionState": "pending", "urgency": "standard", "submissionChannel": "fax", "payer": { "id": "payer_aetna", "slug": "aetna", "displayName": "Aetna" }, "patient": { "identifiers": [ { "type": "mrn", "value": "MRN-001" } ], "firstName": "Jane", "lastName": "Doe", "dateOfBirth": "1988-05-09", "gender": "female", "phone": "415-555-0100", "address": { "line1": "123 Main St", "city": "San Francisco", "state": "CA", "zip": "94105" } }, "coverage": { "payerId": "payer_aetna", "memberId": "W123456789", "groupNumber": "GRP-123", "planType": "commercial", "insuranceState": "CA" }, "providers": [ { "role": "prescribing", "identifiers": [ { "type": "npi", "value": "1234567890" } ], "firstName": "Ajay", "lastName": "Patel", "specialty": "hematologist", "phone": "415-555-0100", "fax": "415-555-0101", "address": { "line1": "100 Main St", "city": "San Francisco", "state": "CA", "zip": "94105" } } ], "service": { "code": "J0791", "codeSystem": "hcpcs", "drugName": "Adakveo", "requestedStartDate": "2026-03-13", "requestedEndDate": "2026-09-13" }, "diagnoses": [ { "code": "D57.00", "codeSystem": "icd_10" } ], "locations": null, "requestedBy": { "firstName": "Alicia", "lastName": "Gomez", "phone": "415-555-0100" }, "siteOfCare": null, "treatmentPhase": null, "questionnaire": { "resourceType": "Questionnaire", "url": "https://api.example.com/questionnaires/aetna-adakveo-precert-2026-01", "title": "Adakveo Medication Precertification Request", "status": "active", "item": [ { "linkId": "request", "text": "Request details", "type": "group", "item": [ { "linkId": "request_type", "text": "Request type", "type": "choice", "required": true, "answerOption": [ { "valueCoding": { "code": "start_of_treatment", "display": "Start of treatment" } } ] }, { "linkId": "acknowledgment_date", "text": "Acknowledgment date", "type": "date", "required": true } ] } ] }, "questionnaireResponse": { "resourceType": "QuestionnaireResponse", "questionnaire": "https://api.example.com/questionnaires/aetna-adakveo-precert-2026-01", "status": "completed", "item": [ { "linkId": "request_type", "answer": [ { "valueCoding": { "code": "start_of_treatment", "display": "Start of treatment" } } ] }, { "linkId": "acknowledgment_date", "answer": [ { "valueDate": "2026-03-13" } ] } ] }, "paRequired": true, "recommendedChannel": "fax", "availableChannels": [ "fax" ], "supportingDocumentationGuidance": [ "Recent hematology note describing the diagnosis and treatment plan.", "Utilization summary documenting vaso-occlusive crises in the last 12 months." ], "sourceForm": { "formId": "aetna-adakveo-precert-2026-01", "title": "Adakveo Medication Precertification Request", "formDocumentUrl": "https://cdn.example.com/forms/aetna-adakveo-precert-2026-01.pdf", "pageCount": 2 }, "provenance": { "sourceFormId": "aetna-adakveo-precert-2026-01", "sourceName": "Adakveo Medication Precertification Request", "effectiveDate": "2026-01-12T15:23:46.000Z" }, "templateVersion": "2026-01", "lastVerifiedAt": "2026-01-12T15:23:46.000Z", "expiresAt": null, "attachments": [], "actions": [ { "id": "action_123", "authorizationId": "auth_123", "type": "payer_request_for_information", "status": "open", "blocking": true, "fieldKey": null, "message": "Payer requested updated clinical notes documenting prior therapy response.", "resolutionHint": "Attach the updated note, resolve the action, and resubmit.", "createdAt": "2026-03-13T17:20:00.000Z", "resolvedAt": null } ], "decisionDetails": { "certificationNumber": null, "payerReferenceNumber": null, "denialReasonCode": null, "denialReasonMessage": null, "approvedStartDate": null, "approvedEndDate": null, "approvalExpiresAt": null }, "validationIssues": [], "contextRequirements": [ { "key": "context.providers.prescribing", "label": "Prescribing provider", "requiredMode": "required", "status": "satisfied", "blocking": true, "paths": [ "providers[role=prescribing].firstName", "providers[role=prescribing].lastName", "providers[role=prescribing].identifiers[npi]" ], "message": "Prescribing provider is required for this payer form." } ], "questionStates": [ { "key": "questionnaire.request_type", "linkId": "request_type", "enabled": true, "required": true, "answered": true, "blocking": false }, { "key": "questionnaire.acknowledgment_date", "linkId": "acknowledgment_date", "enabled": true, "required": true, "answered": true, "blocking": false } ], "activeRequirementGroups": [], "supportingDocumentRequests": [ { "key": "questionnaire.request_type", "label": "Clinical documentation", "requiredMode": "recommended", "status": "recommended", "likelyDocTypes": [ "clinical_note", "treatment_plan" ], "message": "Clinical documentation is commonly included with this request." } ], "createdAt": "2026-03-13T17:00:00.000Z", "updatedAt": "2026-03-13T17:20:00.000Z", "submittedAt": "2026-03-13T17:15:00.000Z", "completedAt": null }

Authorizations

Authorization
string
header
required

Bearer token for WorkOS session JWTs and organization API keys.

Path Parameters

authorizationId
string
required
Example:

"auth_123"

Body

application/json
type
enum<string>
required
Available options:
approval
documentFileId
string
required
certificationNumber
string
required
approvedStartDate
string<date-time>
required
approvedEndDate
string<date-time>
required
approvalExpiresAt
string<date-time>
required
payerReferenceNumber
string

Response

Authorization after processing the sandbox payer event.

id
string
required
workflowState
enum<string>
required
Available options:
needs_input,
ready_to_submit,
submitting,
pending_payer,
action_required,
completed,
cancelled
decisionState
enum<string>
required
Available options:
unknown,
pending,
approved,
denied
urgency
enum<string>
required
Available options:
standard,
urgent,
retrospective
submissionChannel
enum<string> | null
required
Available options:
fax,
portal,
phone,
null
payer
object
required
patient
object
required
coverage
object
required
providers
object[]
required
service
object
required
diagnoses
object[]
required
locations
object
required
requestedBy
object
required
siteOfCare
string | null
required
treatmentPhase
enum<string> | null
required
Available options:
initiation,
continuation,
null
questionnaire
object
required
questionnaireResponse
object
required
paRequired
boolean
required
Available options:
fax,
portal,
phone,
null
availableChannels
(enum<string> | null)[]
required
Available options:
fax,
portal,
phone,
null
supportingDocumentationGuidance
string[]
required
sourceForm
object
required
provenance
object
required
templateVersion
string
required
lastVerifiedAt
string<date-time>
required
expiresAt
string<date-time> | null
required
attachments
object[]
required
actions
object[]
required
decisionDetails
object
required
validationIssues
object[]
required
contextRequirements
object[]
required
questionStates
object[]
required
activeRequirementGroups
object[]
required
supportingDocumentRequests
object[]
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
submittedAt
string<date-time> | null
required
completedAt
string<date-time> | null
required