Skip to main content
GET
Same as POST with flat query parameters

Authorizations

Authorization
string
header
required

Optional. An Arlo account token adds linked-coverage plan matching and family-member patientId. Anonymous calls resolve the plan from planHints only.

Query Parameters

providerName
string
npi
string
code
string
limit
integer
zip
string

5-digit US ZIP

latitude
number
longitude
number
state
string

2-letter US state; ranks name matches there first when no ZIP or coordinates are given

payerName
string

planHints.payerName

employerName
string

planHints.employerName

planName
string

planHints.planName

groupNumber
string

planHints.groupNumber (HCSC members only)

planUnavailable
boolean

planHints.unavailable

Response

Matches

service
object

Echo of the resolved service. VERIFY appliesTo against the actual patient before relaying any number.

supportedServices
object[]

Full pricing catalog, returned when the service could not be resolved. Pick the right code and re-call.

location
object

Which location the answer used: the ZIP or coordinates passed, else the state param (source "state"), else on authenticated calls the patient's profile state (source "profile_state", an assumption: relay note so the patient can correct it). Only re-ask the patient for location when applied=false.

matches
object[]
organizations
object[] | null

Present when several organization matches share a parent organization or legal name. One entry per system with its billing entities grouped and typed, so a large system reads as a tree (hospital, subparts, clinics) rather than a flat list of same-name rows. Entities list nearest first when a location was given (nearestKm on the system, distanceKm per entity); a system's far-away sites are in the tree for breadth, not as the answer to a local question. Present the system, then the entity the patient means.

plan
object

What the estimate is based on. Always read matchTier and basis before relaying numbers.

medicare
object

Present on Original Medicare responses. The year's Part B deductible, coinsurance, and limiting charge, whether a Medigap supplement was mentioned, and assumed=true when the person said only "Medicare" (confirm it is not an Advantage plan; the medicare_type ask says how). Relay the note once.

rateFetchNote
string
networkNote
string | null

Present when every match is outside the plan. Explains why that is not an out-of-network verdict and how to resolve the real billing entity. Relay it before any network verdict.

billingEvidenceDefinitions
object

Once-per-response legend for billingCandidates[].evidence[].type. Present when any match carries billingCandidates.

evidenceCardEligible
boolean

true when exactly one match carries evidence signals (a UI may render an evidence card).

signalDefinitions
object
methodology
string
needsMoreInfo
object[]

Asks to relay to the patient. Answering them improves the estimate (ranges become the plan's exact rates). Each ask names the field, why it matters, and how to obtain it. A medicare_type ask means the numbers assume Original Medicare and the person must confirm they are not on a Medicare Advantage plan. A code ask on an unpriced code says so plainly and lists related catalog codes in options when there are any.

disclaimer
string

ALWAYS convey to the patient: estimates come from the insurer's published data and are not a price guarantee.