Skip to main content
GET
/
v1
/
payers
/
{payer_id}
Retrieve a payer
curl --request GET \
  --url https://api.sandbox.trycollate.ai/v1/payers/{payer_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "displayName": "<string>",
  "supportedStates": [
    "<string>"
  ],
  "supportedServiceTypes": [
    "inpatient"
  ],
  "aliases": [
    "<string>"
  ],
  "status": "<string>",
  "brand": "<string>",
  "lineOfBusiness": "<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 when you already have a stored payerId and need fresh display metadata or supported-state coverage.

​
Returns

Returns the payer. Returns 404 payer_not_found if the payer ID is unknown.

Authorizations

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

API key passed as Authorization: Bearer <API_KEY>.

Path Parameters

​
payer_id
string
required

Canonical payer ID returned by GET /v1/payers.

Response

Successful Response

​
id
string
required

Canonical payer ID.

​
displayName
string
required

Human-readable payer name.

​
supportedStates
string[]
required

Two-letter states supported for this payer.

​
supportedServiceTypes
enum<string>[]
required

Prior-auth service categories supported for this payer.

Available options:
inpatient,
outpatient,
drug
​
aliases
string[]
required

Common payer aliases used for search and matching.

​
status
string
required

Catalog status for the payer.

​
brand
string | null

Parent payer brand, when available.

​
lineOfBusiness
string | null

Payer line of business, when available.