Sign in

v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB
Customers

List Customers

Retrieves paginated list of Customers associated with the authorized requester

get/customers

Query parameters

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

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
idstring[]

Unique resource identifier

[
  "7d943c51-e4ff-4e57-9558-08cab6b963c7"
]
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
sort_bystring[]

Specifies the sort order for the returned customers.

status'ACTIVE' | 'DECEASED' | 'DENIED' | 'DORMANT' | 'ESCHEAT' | 'FROZEN' | 'INACTIVE' | 'PROSPECT' | 'SANCTION'

Only return resources where with the specified status.

Example:ACTIVE

Response

List of customers

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

{
  "customers": [
    {
      "vendor_info": {
        "vendor_data": {
          "loanpro": {
            "customer_id": 12345
          }
        }
      },
      "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",
          "is_registered_agent": true,
          "nickname": "Home",
          "postal_code": "28620",
          "state": "NY"
        }
      ],
      "ban_status": "ALLOWED",
      "creation_time": "2010-05-06T12:23:34.321Z",
      "email": "alice@example.com",
      "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "kyc_last_run": "2010-05-06T12:23:34.321Z",
      "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",
      "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",
        "is_registered_agent": true,
        "nickname": "Home",
        "postal_code": "28620",
        "state": "NY"
      },
      "spend_control_ids": [
        "7d943c51-e4ff-4e57-9558-08cab6b963c7"
      ],
      "ssn": "123-45-6789",
      "tenant": "abcdef_ghijkl",
      "dob": "2000-01-01",
      "first_name": "Jane",
      "last_name": "Smith"
    }
  ],
  "next_page_token": "a8937a0d"
}