Retrieve an address

Retrieves an address, based on a given address ID.

SecurityCommonAuth
Request
path Parameters
addressId
required
string <uuid>

The ID of the address to work with.

query Parameters
accountId
required
string

The ID of the account to work with.

Example: accountId=F50091
format
string

The format to return the addresses in.

Value: "iso20022"
Responses
200

OK

get/addresses/{addressId}
Request samples
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "AdrTp": "string",
  • "Dept": "string",
  • "SubDept": "string",
  • "StrtNm": "string",
  • "BldgNb": "string",
  • "BldgNm": "string",
  • "Flr": "string",
  • "PstBx": "string",
  • "Room": "string",
  • "PstCd": "string",
  • "TwnNm": "string",
  • "TwnLctnNm": "string",
  • "DstrctNm": "string",
  • "CtrySubDvsn": "string",
  • "Ctry": "st",
  • "type": "office",
  • "nickName": "office",
  • "addressLine1": "Great Building",
  • "addressLine2": "Four Maple Street",
  • "addressLine3": "Southwark",
  • "addressContact": "Brian May",
  • "city": "string",
  • "postcode": "SE13UB",
  • "country": "England",
  • "countryCode": "GB"
}