Sign in

v14

OpenAPI 3.1.02026-08-03122113375.9 KB
user-addresses

Retrieve address details

Retrieve full structured address fields for a selected lookup result.

Use this endpoint as step 2 of the assisted lookup workflow, after POST /user/addresses/lookup/find.

How to use this endpoint:

  1. Call POST /user/addresses/lookup/find and let the user choose a specific address result.
  2. Send that result id to this endpoint.
  3. Use the returned structured fields to prefill or confirm the address form.
  4. Save the confirmed address with POST /user/addresses.

Behavior notes:

  • This endpoint resolves data only; it does not create or update a saved address.
  • The returned payload is intended to reduce manual entry errors and improve consistency.
  • If the supplied id is invalid or unavailable, the request fails and the client should return to lookup.
post/user/addresses/lookup/retrieve

Request body

idstring required

The ID of a specific address to retrieve

Example request

{
  "id": "GB|RM|A|10321882|ENG"
}

Response

Retrieve a specific address

idstring

Unique identifier for the address

departmentstring

Department or internal division

companystring

Company name associated with the address

subBuildingstring

Sub-building identifier (e.g., Apartment or Suite number)

buildingNumberstring

Building number in the street

buildingNamestring

Name of the building

secondaryStreetstring

Secondary street address, if any

streetstring

Primary street name

blockstring

Block name or number

neighbourhoodstring

Neighbourhood or locality

districtstring

District or borough

citystring

City or town

line1string

First line of the formatted address

line2string

Second line of the formatted address

line3string

Third line of the formatted address

line4string

Fourth line of the formatted address

line5string

Fifth line of the formatted address

adminAreastring

Administrative area name (e.g., county or region)

adminAreaCodestring

Administrative area code

statestring

State or province name

stateCodestring

State or province code

postalCodestring

Postal or ZIP code

countrystring

Full country name

countryIso2string

ISO 3166-1 alpha-2 country code

countryIso3string

ISO 3166-1 alpha-3 country code

countryIsoNumberstring nullable

ISO 3166-1 numeric country code

sortingNumber1string

Primary sorting number (used in mail sorting)

sortingNumber2string

Secondary sorting number (used in mail sorting)

barcodestring

Postal barcode for mail sorting

poBoxNumberstring

Post Office Box number

labelstring

Formatted label for display

typestring

Type of address (e.g., Residential, Business, etc.)