Skip to main content
GET
Resolve a selected address suggestion to a full address

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

Opaque brand id (brd_...). Validated to belong to the resolved client (§2).

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

Query Parameters

suggestion_id
string
required

Response

the resolved address

address
object
required
deliverable
boolean
required

The vendor's deliverability verdict. FAILS CLOSED — false means "not confirmed deliverable", which includes "the deliverability check could not be performed", and never means "confirmed undeliverable".

simulated
boolean
required

TRUE when this address is FABRICATED — from the synthetic address book the build ships, not a real national database. A simulated address may never be recorded or shown as a confirmed one, and its deliverable is not a verdict. Fails closed to true when no adapter is armed.