Addresses

Residential or business addresses can be linked to your client.

An address can be associated with an individual or company clients.

The API allows you to create, retrieve, update, and delete your clients' addresses. You can retrieve a specific address as well as a list of all your client's addresses.

The Address object

Attribute

Type

Description

id

string

The unique identifier for an address.

clientId

string

The ID of the client associated with this address.

type

string

The type of address. Valid values are:

  1. main

  2. alternative

  3. other

propertyNumber

string

The property number of the client's address.

buildingName

string

The building name of the client's address.

line

string

The line of the client's address.

city

string

The city or town of the client's address.

state

string

The county, state, or province of the client's address.

postalCode

string

The zip or postcode of the client's address.

country

string

The country of the client's address. This will be the two-letter country ISO code.

fromDate

string

The date the client moved into this address. The format is YYYY-MM-DD.

toDate

string

The date the client moved out of this address. The format is YYYY-MM-DD.

createdAt

string

The date and time when the address was created.

updatedAt

string

The date and time when the address was updated.

Last updated