API Reference
Search…
API Reference
v1.7.3
Introduction
Integration
Sandbox and Live
Authentication
Rate Limits
Service Quota
Errors
Pagination
Filtering
Versioning
Core resources
Clients
Addresses
Create an address
Get an address
Update an address
Delete an address
List addresses
Filtering addresses
Documents
Live Photos
Live Videos
Checks
Risk Profile
Check types
AML Screening Check
Document Check
Identity Check
Enhanced Identity Check
Proof of Address Check
Multi-Bureau Check
Face Authentication Check
Lookups
Company Search
Address Search
Tools
Custom Lists
Static Data
Screening Lists
Supported Documents
Other Resources
Flow (Hosted Solution)
Webhooks
SDK Tokens
Autofill
Reports
Team Members
Audit Logs
Account Info
Powered By GitBook
Addresses
Residential or business addresses can be linked to your client.
An address can be associated with 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. 1.
    main
  2. 2.
    alternative
  3. 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. When country is US, this must be the state's USPS abbreviation (e.g. NY, CA, or DE).
postalCode
string
The zip or postal code 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.
​
Previous
Filtering clients
Next
Create an address
Last modified 8mo ago
Copy link
Contents
The Address object