/ Guides / Cards / Order cards / Create addresses

Create addresses

Learn how to create a new address on your account. Optionally, you can look up the addresses for a given UK postcode to check that your details are correct before you do so.

Create an address

Post/v2/addresses?accountId={accountId}

Request

Use this request to create a new address.

Sample requestRequest structure
Copy
Copied
curl -i -X POST \
  'https://api.equalsmoney.com/v2/addresses?accountId=F12345' \
  -H 'Authorization: ApiKey {apiKey}' \
  -H 'Content-Type: application/json' \
  -d '{
    "type": "office",
    "nickName": "Head Office",
    "addressLine1": "Great Building",
    "addressLine2": "4 Maple Street",
    "addressLine3": "Southwark",
    "addressContact": "Jane Doe",
    "city": "London",
    "postcode": "SE13UB",
    "country": "England"
  }'
Copy
Copied
curl -i -X POST \
  'https://api.equalsmoney.com/v2/addresses?accountId={accountId}' \
  -H 'Authorization: ApiKey {apiKey}' \
  -H 'Content-Type: application/json' \
  -d '{
    "type": "string",
    "nickName": "string",
    "addressLine1": "string",
    "addressLine2": "string",
    "addressLine3": "string",
    "addressContact": "string",
    "city": "string",
    "postcode": "string",
    "country": "string"
  }'

Query parameters

Parameter Description
accountId
string
required		 The ID of the account that you want to create an address for.

Allowable values:
An existing accountId (<= 36 characters)

Request body schema

Parameter Description
type
string
required		 The address type. This can be anything except registered.

Allowable values:
A valid string
nickName
string or null		 The nickname of the address.

Allowable values:
<= 256 characters
addressLine1
string
required		 The first line of the address.

Allowable values:
<= 256 characters
addressLine2
string or null		 The second line of the address.

Allowable values:
<= 256 characters
addressLine3
string or null		 The third line of the address.

Allowable values:
<= 256 characters
addressContact
string or null		 The name of the contact associated with the address.

Allowable values:
<= 256 characters
city
string
required		 The city of the address.

Allowable values:
<= 256 characters
postcode
string
required		 The postal or ZIP code of the address.

Allowable values:
<= 256 characters
country
string
required		 The country of the address.

Allowable values:
<= 256 characters

Response

If your request is successful, you'll receive a 200 response containing details about your newly-created address. This includes the id which you can provide when converting a card.

Sample responseResponse structure
Copy
Copied
{
  "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"
}
Copy
Copied
{
  "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.

Look up an address

Get/v2/addresses/lookup

Request

Use this request get a list of all addresses for a given UK postcode (5-7 alphanumeric characters). You can use this to confirm that an address exists before adding it to your account.

info

By default, this endpoint isn't enabled. If you'd like to use it, please ask your account manager.

Sample requestRequest structure
Copy
Copied
curl -i -X GET \
  'https://api.equalsmoney.com/v2/addresses/lookup?postcode=SE13UB' \
  -H 'Authorization: ApiKey YOUR_API_KEY_HERE'
Copy
Copied
curl -i -X GET \
  'https://api.equalsmoney.com/v2/addresses/lookup?postcode={postcode}' \
  -H 'Authorization: ApiKey YOUR_API_KEY_HERE'

Query parameters

Parameter Description
postcode
string
required		 The UK postcode that you want to retrieve addresses for.

Allowable values:
5-7 characters

Response

If your request is successful, you'll receive a 200 response.

Sample responseResponse structure
Copy
Copied
{
  "data": [
    {
      "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",
      "createdAt": "2022-01-30T08:30:00Z",
      "updatedAt": "2022-01-30T08:30:00Z"
    }
  ]
}
Copy
Copied
{
  "data": [
    {
      "id": "string",
      "type": "string",
      "nickName": "string",
      "addressLine1": "string",
      "addressLine2": "string",
      "addressLine3": "string",
      "addressContact": "string",
      "city": "string",
      "postcode": "string",
      "country": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  ]
}

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