Skip to main content
POST
This call is asynchronous, it initiates an eligibility search and returns a UID assigned to this request. The result will be returned in two ways:
  • Via active webhooks once available - preferred. Request UID will be included in payload.
  • By calling the “Eligibility Result” endpoint - only to be used as fallback. Request UID is required.
If specifying a UID, ensure it is unique. If omitted, one will be generated automatically and included in the response for this API call. The response will contain the request UID or a validation error.

Authorizations

Authorization
string
header
required

Your API token prefaced with an "Api" prefix. Example value: "Api B3F4242424E3FDB4242424242A9C7642"

Body

application/json
patient
object
required
insurer_code
string

Required if you don't have access to Universal Search. Allows searching a specific insurer. Example: insurer:vision:vsp

insurer_code_list
string[]

Allows searching several insurers at once (Universal Search). When omitted, Anagram will search all insurers available for your account (Recommended). Alternatively, can explicitly list the insurers you want to search. Example: ["insurer:vision:vsp", "insurer:vision:eyemed"]

request_uid
string

Any string value. Max length: 256

location_code
string

Identifies the location that the eligibility check will be linked to. When this field is empty, the eligibility check will be linked with the default location. Example: LOC4242B

Response

Search started successfully

request_uid
string
required

UID provided during request creation or auto generated