Request Information

URI Parameters

NameDescriptionTypeAdditional information
addressId

The address identifier.

integer

Required

Body Parameters

None.

Response Information

Resource Description

The address, if it exists.

Nano.Address
NameDescriptionTypeAdditional information
city

Gets or sets the city.

string

None.

countryCode

Gets or sets the ISO 3166-1 alpha-2 country code.

string

None.

foreignPostalCode

Gets or sets the postal code of a foreign address.

string

None.

lotNumber

Gets or sets the lot number.

string

None.

state

Gets or sets the state.

string

None.

stateProvince

Gets or sets the state or province of a foreign address.

string

None.

street

Gets or sets the street.

string

None.

streetLine2

Gets or sets the second street line.

string

None.

unitNumber

Gets or sets the unit number.

string

None.

zipCode

Gets or sets the zip code.

string

None.

addressHistory

Gets or sets the person address history identifier.

integer

None.

id

Gets or sets the address id.

integer

None.

asset

Gets or sets the asset identifier.

integer

None.

employer

Gets or sets the employer identifier.

integer

None.

liability

Gets or sets the liability identifier.

integer

None.

previousGovernmentLoan

Gets or sets the previous government loan identifier.

integer

None.

property

Gets or sets the property identifier.

integer

None.

verifications

Gets or sets the verification identifiers.

Collection of integer

None.

Response Formats

application/json, text/json

Sample:
{
  "city": "sample String 1",
  "countryCode": "sample String 2",
  "foreignPostalCode": "sample String 3",
  "lotNumber": "sample String 4",
  "state": "sample String 5",
  "stateProvince": "sample String 6",
  "street": "sample String 7",
  "streetLine2": "sample String 8",
  "unitNumber": "sample String 9",
  "zipCode": "sample String 10",
  "addressHistory": "1",
  "id": "11",
  "asset": "1",
  "employer": "1",
  "liability": "1",
  "previousGovernmentLoan": "1",
  "property": "1",
  "verifications": [
    "1",
    "2"
  ]
}

text/html

Sample:
{"city":"sample String 1","countryCode":"sample String 2","foreignPostalCode":"sample String 3","lotNumber":"sample String 4","state":"sample String 5","stateProvince":"sample String 6","street":"sample String 7","streetLine2":"sample String 8","unitNumber":"sample String 9","zipCode":"sample String 10","addressHistory":"1","id":"11","asset":"1","employer":"1","liability":"1","previousGovernmentLoan":"1","property":"1","verifications":["1","2"]}

application/vnd.api+json

Sample:

Sample not available.