Skip to main content
GET
Suggest addresses as your patient types

Authorizations

Authorization
string
header
required

Per-client API key (M2M). Presented as Authorization: Bearer <key>.

Headers

X-Correlation-Id
string

An optional id you send to tie this request to your own logs. Send one and it is echoed back unchanged; omit it and one is assigned for you. Either way the id is returned in the X-Correlation-Id response header on every response, including errors, so you can match a response to the request that produced it.

Maximum string length: 128
Pattern: ^[A-Za-z0-9][A-Za-z0-9._:-]*$
X-Brand-Id
string
required

Your brand id (brd_...). It must be one of the brands your API key's account owns; with a publishable key it must be the one brand the key was issued for. A missing or malformed value is refused with 400, and an unknown or foreign brand with 404.

Pattern: ^brd_[A-Za-z0-9][A-Za-z0-9_-]*$

Query Parameters

partial
string
required

Response

address suggestions

simulated
boolean
required

TRUE when these suggestions are FABRICATED — the synthetic address book the build ships, not a real national database. Your patient-facing surface must say so: a simulated suggestion may never be presented as a confirmed address. Fails closed to true when no adapter is armed.

suggestions
object[]
required