GET
/
persons
List persons
curl --request GET \
  --url https://api-sandbox.synctera.com/v0/persons \
  --header 'Authorization: Bearer <token>'
{
  "persons": [
    {
      "ban_status": "ALLOWED",
      "chosen_name": "Annie",
      "creation_time": "2010-05-06T12:23:34.321Z",
      "dob": "2000-01-01",
      "email": "alice@example.com",
      "first_name": "Jane",
      "has_accounts": true,
      "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "is_customer": true,
      "last_name": "Smith",
      "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",
      "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",
      "status": "ACTIVE",
      "tenant": "abcdef_ghijkl",
      "verification_last_run": "2010-05-06T12:23:34.321Z",
      "verification_status": "ACCEPTED",
      "personal_ids": [
        {
          "country_code": "<string>",
          "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
          "id_type": "SSN",
          "identifier": "123-45-6789",
          "system_provided": true
        }
      ]
    }
  ],
  "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

​
sort_by
enum<string>[]

Specifies the sort order for the returned persons.

​
is_customer
boolean

If true, show only customers. If false, show non-customer parties.

​
id
string<uuid>[]

Unique identifier for the resource. Multiple IDs can be provided as a comma-separated list.

Example:

"64438afd-fa20-4010-a573-2bbdca77cdb6,84ef251c-ab8f-47a5-bbfd-a16648f95157"

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

​
status
enum<string>

Status of the person. One of the following:

  • ACTIVE – is an integrator defined status. Integrators should set a person to active if they believe the person to be qualified for conducting business. Synctera will combine this status with other statuses such a verification to determine if the person is eligible for specific actions such as initiating transactions or issuing a card.
  • DECEASED – person is deceased.
  • DENIED – customer was turned down.
  • DORMANT – person is no longer active.
  • ESCHEAT – person's assets are abandoned and are property of the state.
  • FROZEN – person's actions are blocked for security, legal, or other reasons.
  • INACTIVE – an inactive status indicating that the person is no longer active.
  • PROSPECT – a potential customer, used for information-gathering and disclosures.
  • SANCTION – person is on a sanctions list and should be carefully monitored.
Available options:
ACTIVE,
DECEASED,
DENIED,
DORMANT,
ESCHEAT,
FROZEN,
INACTIVE,
PROSPECT,
SANCTION
Example:

"ACTIVE"

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

​
include_console_users
boolean

includes the person representations of available console users in the person get respsonse.

​
ban_status
enum<string>[]

(beta) Ban status of the person. Multiple values can be provided as a comma-seperated list of the following:

  • ALLOWED – person is not banned or suspended
  • SUSPENDED - person is suspended
  • BANNED – person is banned
​
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

Response

200
application/json

List of persons.

The response is of type object.