Skip to main content
GET
/
addresses
List Addresses
curl --request GET \
  --url https://api.synctera.com/v2/addresses
{
  "addresses": [
    {
      "creation_date": "2019-01-01T00:00:00Z",
      "is_active": true,
      "last_updated_time": "2010-05-06T12:23:34.321Z",
      "address_line_1": "<string>",
      "address_line_2": "<string>",
      "city": "<string>",
      "country_code": "<string>",
      "postal_code": "<string>",
      "state": "<string>",
      "business_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "customer_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7"
    }
  ],
  "next_page_token": "a8937a0d"
}

Query Parameters

​
customer_id
string<uuid>

The unique identifier of a customer.

Example:

"b01db9c7-78f2-4a99-8aca-1231d32f9b96"

​
business_id
string<uuid>

ID of the business that the risk score applies to

Example:

"edebece0-4a06-4806-b062-7de25a848be8"

​
address_type
enum<string>[]

Specifies the address type.

Available options:
BILLING,
LEGAL,
SHIPPING,
OPERATING,
OTHER
​
is_registered_agent
boolean

Whether the address uses a registered agent or not

​
is_active
boolean

Whether the address is active or not

​
country
string

Country code.

ISO 3166-1 Alpha-2 or Alpha-3 country code.

Example:

"U"

​
limit
integer
default:100

Maximum number of objects to return per page. If the limit is greater than 100, then it will be set to 100.

Required range: x >= 1
Example:

100

​
page_token
string

Optional pagination token to be provided to retrieve subsequent pages, returned from previous get

Example:

"a8937a0d"

Response

List of addresses

​
addresses
Address · object[]
required

Array of Addresses

​
next_page_token
string

If returned, use the next_page_token to query for the next page of results. Not returned if there are no more rows.

Example:

"a8937a0d"