Manage addresses - Equals Documentation

List addresses

GET /v2/addresses

Request

Use this request to retrieve a list of addresses associated with a given account. The only required parameter is the accountId. You can use optional parameters to filter or search the results, and retrieve additional details.

curl -i -X GET \
  'https://api.equalsmoney.com/v2/addresses?accountId=F12345' \
  -H 'Authorization: ApiKey YOUR_API_KEY_HERE'

curl -i -X GET \
  'https://api.equalsmoney.com/v2/addresses?accountId={accountId}' \
  -H 'Authorization: ApiKey YOUR_API_KEY_HERE'

Query parameters

string

required

The ID of the account that you want to retrieve a list of addresses for.Allowable values: An existing accountId (≤ 36 characters)

integer

The maximum number of results to return. For example, limit=25. By default, this is set to 100.Allowable values: [ 1 .. 1000 ]

integer

The number of items to skip before returning results. For example, offset=200. By default, this is set to 0.Allowable values: A valid integer

string

Filters results that include this string. For example, search=Jane+Doe.Allowable values: A valid string

array of strings

Filter results to include only this type of address. For example, type=registered.Allowable values: A valid string

Response

If your request is successful, you’ll receive a 200 response containing a list of addresses. These are ordered alphabetically by nickName.

{
  "limit": 100,
  "offset": 200,
  "count": 2,
  "rows": [
    {
      "id": "55ddc56e-f605-49c6-9862-0e8b55fa368f",
      "type": "office",
      "nickName": "Head Office",
      "addressLine1": "Great Building",
      "addressLine2": "4 Maple Street",
      "addressLine3": "Southwark",
      "addressContact": "Jane Doe",
      "city": "London",
      "postcode": "SE13UB",
      "country": "England"
    },
    {
      "id": "516bd368-65b9-43d5-97bf-669c2018606a",
      "type": "personal",
      "nickName": "William Walker Home",
      "addressLine1": "41 Middle Street",
      "addressLine2": "",
      "addressLine3": "",
      "addressContact": "William Walker",
      "city": "Enfield",
      "postcode": "EN13JY",
      "country": "England"
    }
  ]
}

{
  "limit": integer,
  "offset": integer,
  "count": integer,
  "rows": [
    {
      "id": "string",
      "type": "string",
      "nickName": "string",
      "addressLine1": "string",
      "addressLine2": "string",
      "addressLine3": "string",
      "addressContact": "string",
      "city": "string",
      "postcode": "string",
      "country": "string"
    }
  ]
}

For more detailed information about this request and its response, see the API reference.

Retrieve an address

GET /v2/addresses/{addressId}?accountId={accountId}

Request

Use this request to retrieve details for a specific address, based on its addressId.

curl -i -X GET \
  'https://api.equalsmoney.com/v2/addresses/55ddc56e-f605-49c6-9862-0e8b55fa368f?accountId=F12345' \
  -H 'Authorization: ApiKey YOUR_API_KEY_HERE'

curl -i -X GET \
  'https://api.equalsmoney.com/v2/addresses/{addressId}?accountId={accountId}' \
  -H 'Authorization: ApiKey YOUR_API_KEY_HERE'

Path parameters

string

required

The ID of the address that you want to retrieve details for.Allowable values: An existing addressId

Query parameters

string

required

The ID of the account associated with the address ID.Allowable values: An existing accountId (≤ 36 characters)

Response

If your request is successful, you’ll receive a 200 response containing the details of the address.

{
  "id": "55ddc56e-f605-49c6-9862-0e8b55fa368f",
  "type": "office",
  "nickName": "Head Office",
  "addressLine1": "Great Building",
  "addressLine2": "4 Maple Street",
  "addressLine3": "Southwark",
  "addressContact": "Jane Doe",
  "city": "London",
  "postcode": "SE13UB",
  "country": "England"
}

{
  "id": "string",
  "type": "string",
  "nickName": "string",
  "addressLine1": "string",
  "addressLine2": "string",
  "addressLine3": "string",
  "addressContact": "string",
  "city": "string",
  "postcode": "string",
  "country": "string"
}

For more detailed information about this request and its response, see the API reference.

Update an address

PATCH /v2/addresses/{addressId}?accountId={accountId}

Request

Use this request to update a given address.

You can’t update an address that has registered as its type.

curl -i -X PATCH \
  'https://api.equalsmoney.com/v2/addresses/55ddc56e-f605-49c6-9862-0e8b55fa368f?accountId=F12345' \
  -H 'Authorization: ApiKey YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "type": "office",
    "nickName": "London Office",
    "addressLine1": "Great Building",
    "addressLine2": "3 Maple Street",
    "addressLine3": "Southwark",
    "addressContact": "John Doe",
    "city": "London",
    "postcode": "SE13UB",
    "country": "England"
  }'

curl -i -X PATCH \
  'https://api.equalsmoney.com/v2/addresses/{addressId}?accountId={accountId}' \
  -H 'Authorization: ApiKey YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "type": "string",
    "nickName": "string",
    "addressLine1": "string",
    "addressLine2": "string",
    "addressLine3": "string",
    "addressContact": "string",
    "city": "string",
    "postcode": "string",
    "country": "string"
  }'

Path parameters

string

required

The ID of the address that you want to update.Allowable values: An existing addressId

Query parameters

string

required

The ID of the account associated with the address ID.Allowable values: An existing accountId (≤ 36 characters)

Request body schema

string

The address type. This can be anything except registered.Allowable values: A valid string

string or null

The nickname of the address.Allowable values: ≤ 256 characters

string

The first line of the address.Allowable values: ≤ 256 characters

string or null

The second line of the address.Allowable values: ≤ 256 characters

string or null

The third line of the address.Allowable values: ≤ 256 characters

string or null

The name of the contact associated with the address.Allowable values: ≤ 256 characters

string

The city of the address.Allowable values: ≤ 256 characters

string

The postal or ZIP code of the address.Allowable values: ≤ 256 characters

string

The country of the address.Allowable values: ≤ 256 characters

Response

If your request is successful, you’ll receive a 200 response containing the updated details for this address.

{
  "id": "55ddc56e-f605-49c6-9862-0e8b55fa368f",
  "type": "office",
  "nickName": "London Office",
  "addressLine1": "Great Building",
  "addressLine2": "3 Maple Street",
  "addressLine3": "Southwark",
  "addressContact": "John Doe",
  "city": "London",
  "postcode": "SE13UB",
  "country": "England"
}

{
  "id": "string",
  "type": "string",
  "nickName": "string",
  "addressLine1": "string",
  "addressLine2": "string",
  "addressLine3": "string",
  "addressContact": "string",
  "city": "string",
  "postcode": "string",
  "country": "string"
}

For more detailed information about this request and its response, see the API reference.

Delete an address

DELETE /v2/addresses/{addressId}?accountId={accountId}

Request

Use this request to delete an existing address.

You can’t delete an address that has registered as its type.

curl -i -X DELETE \
  'https://api.equalsmoney.com/v2/addresses/55ddc56e-f605-49c6-9862-0e8b55fa368f?accountId=F12345' \
  -H 'Authorization: ApiKey YOUR_API_KEY_HERE'

curl -i -X DELETE \
  'https://api.equalsmoney.com/v2/addresses/{addressId}?accountId={accountId}' \
  -H 'Authorization: ApiKey YOUR_API_KEY_HERE'

Path parameters

string

required

The ID of the address that you want to delete.Allowable values: An existing addressId

Query parameters

string

required

The ID of the account associated with the address ID.Allowable values: An existing accountId (≤ 36 characters)

Response

If your request is successful, you’ll receive a 204 response. For more detailed information about this request and its response, see the API reference.

​List addresses

​Request

​Query parameters

​Response

​Retrieve an address

​Request

​Path parameters

​Query parameters

​Response

​Update an address

​Request

​Path parameters

​Query parameters

​Request body schema

​Response

​Delete an address

​Request

​Path parameters

​Query parameters

​Response

List addresses

Request

Query parameters

Response

Retrieve an address

Request

Path parameters

Query parameters

Response

Update an address

Request

Path parameters

Query parameters

Request body schema

Response

Delete an address

Request

Path parameters

Query parameters

Response