Sign in

v1

latestOpenAPI 3.1.02026-07-241695611.0 MB
Address

Get Address

Get the details of a specific address.

get/addresses/{address_id}

Path parameters

address_idstring uuid required

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

Example:04b82cfa-49a2-46ee-a4bd-227e1d8afedf

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

Response

Response

idstring uuid required

The ID of the address

primary_numberstring required

The primary number of the address

street_namestring required

The street name

street_predirectionstring nullable

The street predirection e.g. N 5th St

street_postdirectionstring nullable

The street postdirection e.g. 5th St NW

street_suffixstring nullable

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

secondary_numberstring nullable

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

secondary_designatorstring nullable

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

pmb_designatorstring nullable

The Private Mailbox Designator

pmb_numberstring nullable

The Private Mailbox Number

citystring required

The city name

state'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' required
zipcodestring required

The 5 digit zipcode

plus4_codestring nullable

The 4 digit zipcode extension

rdi'Residential' | 'Commercial'
cmraboolean nullable

Whether the address is a Commercial Mail Receiving Agency

deliverableboolean nullable

Whether the address is deliverable

latitudenumber required

The latitude of the address

longitudenumber required

The longitude of the address

associated_registered_agentsstring[]

All registered agents that have ever been associated with this address

delivery_type'FIRM' | 'GENERAL_DELIVERY' | 'HIGH_RISE' | 'POST_OFFICE' | 'RURAL_ROUTE' | 'STREET'

Enum representing the different types of USPS delivery points. Used to classify addresses based on how mail is delivered to them.

Example response

{
  "primary_number": "94941",
  "street_name": "Harrison Drive",
  "street_predirection": "North",
  "street_postdirection": "South",
  "street_suffix": "St",
  "secondary_number": "517",
  "secondary_designator": "Apartment",
  "city": "Wilsonside",
  "zipcode": "90210",
  "latitude": 38.03012,
  "longitude": 78.47665
}