v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB

Persons

List persons

Retrieves paginated list of persons associated with the authorized requester.

get/persons

Query parameters

sort_bystring[]

Specifies the sort order for the returned persons.

is_customerboolean

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

idstring[]

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

has_accountsboolean

Filter on resources that have an account(s)

ssn_last_4string

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

Example:6789

dobstring date

Only return resources where the date of birth matches the specified value.

Example:1980-12-25

last_namestring

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 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.

Example:ACTIVE

emailstring

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_namestring

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

classificationsClassification[]

Specifies the classification of a party for banks. This may contain multiple values for a combined classifications list of customers.

Specifies the classification of a party for banks. It can contain multiple values.

verification_statusVerificationStatus[]

Verification status of the person. Multiple values can be provided as a comma-seperated list of the following:

UNVERIFIED – verification has not been completed for this customer.
PENDING – verification is in progress for this customer.
PROVISIONAL – partially verified or verified with restrictions.
ACCEPTED – the customer has been verified.
REVIEW – verification has run and issues have been identified and require review.
REJECTED – the customer was rejected and should not be allowed to take certain actions e.g., open an account.

[
  "ACCEPTED"
]

phone_numberstring

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_tokenstring

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

Example:a8937a0d

include_console_usersboolean

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

ban_statusBanStatus[]

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

[
  "ALLOWED"
]

limitinteger

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

Example:100

Response

List of persons.

next_page_tokenstring

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

Example response

{
  "persons": [
    {
      "ban_status": "ALLOWED",
      "chosen_name": "Annie",
      "creation_time": "2010-05-06T12:23:34.321Z",
      "customer_active": "2010-05-06T12:23:34.321Z",
      "dob": "2000-01-01",
      "email": "alice@example.com",
      "first_name": "Jane",
      "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "is_customer": true,
      "is_user": 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",
        "is_registered_agent": true,
        "nickname": "Home",
        "postal_code": "28620",
        "state": "NY"
      },
      "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",
        "is_registered_agent": true,
        "nickname": "Home",
        "postal_code": "28620",
        "state": "NY"
      },
      "spend_control_ids": [
        "7d943c51-e4ff-4e57-9558-08cab6b963c7"
      ],
      "ssn": "123-45-6789",
      "status": "ACTIVE",
      "tenant": "abcdef_ghijkl",
      "verification_last_run": "2010-05-06T12:23:34.321Z",
      "verification_status": "ACCEPTED",
      "vendor_info": {
        "vendor_data": {
          "loanpro": {
            "customer_id": 12345
          }
        }
      },
      "personal_ids": [
        {
          "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
          "id_type": "SSN",
          "identifier": "123-45-6789",
          "expiry_date": "2020-01-01",
          "issue_date": "2020-01-01"
        }
      ]
    }
  ],
  "next_page_token": "a8937a0d"
}