Skip to main content
GET
Retrieve an address by external ID

Authorizations

Authorization
string
header
required

API key authentication. Obtain your API key from the dashboard.

X-Environment
string
header
required

Target environment for the request. Must be "test" or "live".

Path Parameters

externalId
string
required
Minimum string length: 1

Response

200 - application/json

OK

clientId
string<uuid>
required

Client ID

isPrimary
boolean
required
street
string
required

Street

Minimum string length: 1
city
string
required

City

Minimum string length: 1
state
string
required

State

Minimum string length: 1
postalCode
string
required

Postal Code

Minimum string length: 1
scope
enum<string>
required
Available options:
base,
MX:AV,
MX:AV:ARI,
MX:AV:AVI,
MX:AV:INM,
MX:AV:JYS,
MX:AV:MJR,
MX:AV:MPC,
MX:AV:TSC,
MX:AV:VEH,
MX:CNBV,
MX:CNBV:TRANSMISOR,
MX
id
string<uuid>
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
type
enum<string>
default:home

Type

Available options:
home,
business,
mailing,
legal,
other
country
any

Country

externalId
string

External ID

metadata
object

Metadata

scopeData
object