GET
/
customers
List Customers
curl --request GET \
  --url https://api-sandbox.synctera.com/v0/customers \
  --header 'Authorization: Bearer <token>'
{
  "customers": [
    {
      "addresses": [
        {
          "address_line_1": "100 Main St.",
          "address_line_2": "Suite 99",
          "address_type": "SHIPPING",
          "city": "New York",
          "country_code": "US",
          "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
          "nickname": "Home",
          "postal_code": "28620",
          "state": "NY"
        }
      ],
      "ban_status": "ALLOWED",
      "creation_time": "2010-05-06T12:23:34.321Z",
      "email": "alice@example.com",
      "has_accounts": true,
      "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "kyc_exempt": true,
      "kyc_last_run": "2010-05-06T12:23:34.321Z",
      "kyc_status": "ACCEPTED",
      "last_updated_time": "2010-05-06T12:23:34.321Z",
      "legal_address": {
        "address_line_1": "100 Main St.",
        "address_line_2": "Suite 99",
        "address_type": "SHIPPING",
        "city": "New York",
        "country_code": "US",
        "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
        "nickname": "Home",
        "postal_code": "28620",
        "state": "NY"
      },
      "metadata": {},
      "middle_name": "Anne",
      "phone_number": "+14374570680",
      "related_customers": [
        {
          "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
          "relationship_role": "CUSTODIAN"
        }
      ],
      "shipping_address": {
        "address_line_1": "100 Main St.",
        "address_line_2": "Suite 99",
        "address_type": "SHIPPING",
        "city": "New York",
        "country_code": "US",
        "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
        "nickname": "Home",
        "postal_code": "28620",
        "state": "NY"
      },
      "ssn": "123-45-6789",
      "ssn_source": "MANUAL",
      "tenant": "abcdef_ghijkl",
      "dob": "2000-01-01",
      "first_name": "Jane",
      "last_name": "Smith",
      "status": "ACTIVE"
    }
  ],
  "next_page_token": "a8937a0d"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
has_accounts
boolean

Filter on resources that have an account(s)

​
ssn_last_4
string

Only return resources where the last 4 characters of the SSN match the specified value.

Required string length: 4
Example:

"6789"

​
last_name
string

Only return resources where the last_name field matches the specified string. Any * characters in the string are wildcards, and match any characters.

Example:

"Smith"

​
email
string

Only return resources where the email field matches the specified string. Any * characters in the string are wildcards, and match any characters.

Example:

"john.doe@example.com"

​
first_name
string

Only return resources where the first_name or chosen_name field matches the specified string. Any * characters in the string are wildcards, and match any characters.

Example:

"Alice"

​
phone_number
string

Only return resources where the phone_number field matches the specified string. Phone numbers use the E.164 format e.g. +19178675309. Any * characters in the string are wildcards, and match any characters.

Example:

"+12065550100"

​
page_token
string

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

Example:

"a8937a0d"

​
id
string<uuid>[]

Unique resource identifier

​
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

​
sort_by
enum<string>[]

Specifies the sort order for the returned customers.

​
status
enum<string>

Only return resources where with the specified status.

Available options:
ACTIVE,
DECEASED,
DENIED,
DORMANT,
ESCHEAT,
FROZEN,
INACTIVE,
PROSPECT,
SANCTION
Example:

"ACTIVE"

Response

List of customers

​
customers
Customer · object[]
required

Array of Customers

​
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"