Retrieve an address

Retrieves an address, based on a given address ID.

get/addresses/{addressId}

Request

Base URL
https://api.equalsmoney.com/v2
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/equalsmoney/apis/cis-api/docs/addresses/:addressId/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

addressIdstring uuid required

The ID of the address to work with.

Query parameters

accountIdstring required

The ID of the account to work with.

Example:F50091

format'iso20022'

The format to return the addresses in.

Response

Example response

{
  "type": "office",
  "nickName": "office",
  "addressLine1": "Great Building",
  "addressLine2": "Four Maple Street",
  "addressLine3": "Southwark",
  "addressContact": "Brian May",
  "postcode": "SE13UB",
  "country": "England",
  "countryCode": "GB"
}

Changes

No recorded changes to this operation across all 1 revision of this API.