API Reference
Log inSign up
v.1.7.2
v.1.7.2
  • Introduction
  • Integration
  • Sandbox and Live
  • Authentication
  • Rate Limits
  • Service Quota
  • Errors
  • Pagination
  • Filtering
  • Versioning
  • Core resources
  • Clients
    • Create a client
    • Get a client
    • Update a client
    • Delete a client
    • List clients
    • Filtering clients
  • Addresses
    • Create an address
    • Get an address
    • Update an address
    • Delete an address
    • List addresses
    • Filtering addresses
  • Documents
    • Create a document
    • Get a document
    • Update a document
    • Upload image attachment
    • Download image attachment
    • Delete image attachment
    • Delete a document
    • List documents
    • Filtering documents
  • Live Photos
    • Upload a live photo
    • Get a live photo
    • Download live photo
    • Delete a live photo
    • List live photos
  • Checks
    • Create a check
    • Get a check
    • Update a check
    • Validate check outcome
    • List checks
    • Filtering checks
  • Risk Profile
    • Get a risk profile
  • Check types
    • AML Screening Check
    • Document Check
    • Identity Check
  • Other Resources
    • Webhooks
      • Create a webhook
      • Get a webhook
      • Update a webhook
      • Delete a webhook
      • List webhooks
      • Filtering webhooks
    • Reports
      • Generate a client report
      • Generate a check report
    • SDK Tokens
      • Generate a token
    • Team Members
      • Get a team member
      • List team members
      • Filtering team members
    • Audit Logs
      • Get an audit log
      • List audit logs
      • Filtering audit logs
Powered by GitBook
On this page

Was this helpful?

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

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.

{
    "id": "5eb1276f96be4a0008713af6",
    "clientId": "5eb1276d96be4a0008713af5",
    "type": "main",
    "propertyNumber": "Flat 323",
    "line": "Common street",
    "city": "Aldgate",
    "state": "London",
    "postalCode": "W10 11L",
    "country": "GB",
    "fromDate": "2007-09-01",
    "createdAt": "2020-01-01T14:06:44.756Z",
    "updatedAt": "2020-01-01T14:06:44.756Z"
}

PreviousFiltering clientsNextCreate an address

Last updated 4 years ago

Was this helpful?

The country of the client's address. This will be the .

two-letter country ISO code