Sign in

v1

latestOpenAPI 3.0.12026-07-242073551.1 MB
Address Book

Get Address

Returns information for a specific address from your address book, including when it was last updated and by whom.

get/v4/addresses/{addressId}

Path parameters

addressIdstring required

Address Identifier <br />SAPIENT AddressId (assigned by SAPIENT or by you).

Response

Returns the details of a address book.

AddressIdstring nullable

The address Id <br />Your identifier for the address. If none provided the system will allocate one.

ContactNamestring nullable

Contact Name <br />The contact name or company name is required. <br />Up to 50 characters may be allowed.However it is carrier dependent. Some carriers may allow less.

CompanyNamestring nullable

Company Name <br />The contact name or company name is required. <br />Up to 50 characters may be allowed.However it is carrier dependent. Some carriers may allow less.

ContactEmailstring email nullable

Contact Phone Number

ContactPhonestring tel nullable

Contact Phone Number

Line1string required

Address Line 1 <br />Up to 50 characters may be allowed, however it is carrier dependent and some carriers may allow less.

Line2string nullable

Address Line 2 <br />Up to 50 characters may be allowed, however it is carrier dependent and some carriers may allow less.

Line3string nullable

Address Line 3 <br />Up to 50 characters may be allowed, however it is carrier dependent and some carriers may allow less.

Townstring required

Town <br />Up to 50 characters may be allowed, however it is carrier dependent and some carriers may allow less.

Postcodestring nullable

Postcode / Zip <br />Required for United Kingdom addresses and some international addresses. <br />The Countries API can be used to check whether postcode/zip code is required for a country. <br />Up to 20 characters may be allowed, however it is carrier dependent and some carriers may allow less.

Countystring nullable

County / State / Province <br />May be required depending on the country. <br />For USA, Australia and Canada, if provided, must be a valid state code or name. <br />The Countries API can be used to check whether county/state is required for a country. <br />Up to 50 characters may be allowed, however it is carrier dependent and some carriers may allow less.

CountryCodestring required

Country Code <br />2 Digit ISO Country Code, per ISO 3166 Standard.

What3Wordsstring nullable

The what3words identifier for this address.

LastUpdatedDateUtcstring date-time

Last Updated Date UTC

LastUpdatedBystring nullable

Last Updated By

Example response

{
  "AddressId": "John Brown Default",
  "ContactName": "Jane Doe",
  "CompanyName": "My Company Ltd.",
  "ContactEmail": "jane@example.com",
  "ContactPhone": "07123887422",
  "Line1": "10 Sky Lane",
  "Line2": "123 Main Street",
  "Line3": "Hills End",
  "Town": "Christchurch",
  "Postcode": "TW20 0HJ",
  "County": "Surrey",
  "CountryCode": "GB",
  "What3Words": "brick.space.employ",
  "LastUpdatedDateUtc": "2022-02-06T16:13:24.010Z",
  "LastUpdatedBy": "User A"
}