Skip to main content
GET
Get Address

Authorizations

X-API-Key
string
header
required

Path Parameters

address_id
string<uuid>
required

The unique identifier of the address to fetch the details for.

Example:

"d064ba47-d345-47b5-937a-22893366b22a"

Response

Response

Response model for address data.

This model defines the complete structure for address-related API responses.

id
string<uuid>
required

The ID of the address

primary_number
string
required

The primary number of the address

Example:

"94941"

street_name
string
required

The street name

Example:

"Harrison Drive"

city
string
required

The city name

Examples:

"Wilsonside"

"Fayettesville"

state
enum<string>
required

The state 2 letter abbreviation

Available options:
AL,
AK,
AZ,
AR,
CA,
CO,
CT,
DE,
DC,
FL,
GA,
HI,
ID,
IL,
IN,
IA,
KS,
KY,
LA,
ME,
MD,
MA,
MI,
MN,
MS,
MO,
MT,
NE,
NV,
NH,
NJ,
NM,
NY,
NC,
ND,
OH,
OK,
OR,
PA,
RI,
SC,
SD,
TN,
TX,
UT,
VT,
VA,
WA,
WV,
WI,
WY,
PR,
VI,
AE,
AA,
AP,
GU,
AS
zipcode
string
required

The 5 digit zipcode

Examples:

"90210"

"31337"

latitude
number
required

The latitude of the address

Example:

38.03012

longitude
number
required

The longitude of the address

Example:

78.47665

street_predirection
string | null

The street predirection e.g. N 5th St

Example:

"North"

street_postdirection
string | null

The street postdirection e.g. 5th St NW

Example:

"South"

street_suffix
string | null

The street suffix e.g. St, Ave, Blvd, etc.

Example:

"St"

secondary_number
string | null

The secondary number of the address e.g. Apt, Suite, etc.

Example:

"517"

secondary_designator
string | null

The secondary designator of the address e.g. Apartment, Suite etc.

Example:

"Apartment"

pmb_designator
string | null

The Private Mailbox Designator

pmb_number
string | null

The Private Mailbox Number

plus4_code
string | null

The 4 digit zipcode extension

rdi
enum<string> | null

Residential Delivery Indicator

Available options:
Residential,
Commercial
cmra
boolean | null

Whether the address is a Commercial Mail Receiving Agency

deliverable
boolean | null

Whether the address is deliverable

associated_registered_agents
string[]

All registered agents that have ever been associated with this address

delivery_type
enum<string> | null

The delivery type of the address

Available options:
FIRM,
GENERAL_DELIVERY,
HIGH_RISE,
POST_OFFICE,
RURAL_ROUTE,
STREET