Accounts2

Address lookup1

Addresses5

Budgets4

Card budgets2

Card details3

Cards1

Currencies1

Digital wallets5

Direct Debits5

Email domains3

IP addresses2

Merchant controls5

Onboarding21

Order a card3

Orders1

Payment Batches12

Payment confirmation1

Payment purposes1

Payments8

People7

PIN2

Recipients6

Remitters3

Simulations9

Spending limits3

Testing credits1

Transaction activity2

Transaction limits3

Update a card2

Webhooks7

Addresses

Update an address

Updates an address, based on a given address ID. You can only update an address
if it's not a registered address.

patch/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/patch.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

Request body

typestring

The address type.

nickNamestring nullable

The nickname of the address.

addressLine1string

The first line of the address.

addressLine2string nullable

The second line of the address.

addressLine3string nullable

The third line of the address.

addressContactstring nullable

The name of the contact associated with the address.

citystring

The city of the address.

postcodestring

The postal or ZIP code of the address.

countrystring

The country of the address.

countryCodestring nullable

ISO 3166-1 2 digit country code.

Example request

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

Response

idstring uuid required

The ID of the address.

typestring required