Customers guide

The Customers product supports two endpoints for retrieval of customer information.

The default endpoint (used in most cases as it is the most efficient), is Customer info (/customers). This endpoint returns information for the permissioned consumer.

The second endpoint is Account holder information (/contacts). You will use this endpoint if it is required by specific data providers (please see the provider nuance documentation in the Data Recipient Hub), or if necessitated by your use case. By default, the response for Account Holder information includes the data elements for Customer info for the permissioned user in addition to the relationship data element, but some providers share customer data for additional account holders. Please see the provider documentation in the Data Recipient Hub.

The Customers product operates from the context of the bearer token (a.k.a. the authorized user). The Customer Info endpoint will meet your needs for use cases such as payment, identity verification, account opening, and UX personalization. It doesn’t return customer info at the account level (e.g. account holders for a joint account). Instead, it returns info for the currently-permissioned user only.

The Account Holders endpoint supports lending or credit decisioning use cases where you would want to determine the relationship between an account and the permissioned end-user (e.g. if they’re the primary account holder). This endpoint returns information on the permissioned account holder, and depending on the data provider, potentially account holders.

Please see this article from within the Data Recipient Hub for a list of providers that support the Account Holders endpoint. Please note that this article is only viewable from within the Hub.

The provider documentation tabs for each provider in the Data Recipient Hub also mention if the Account Holders endpoint is supported by that provider.

Results are returned in JSON in FDX format.

Example response

📘

Data elements shown are not exhaustive

This is an example. See the chart below for a complete list of supported data elements.

{
    "customer": {
        "customerId": "1521963501",
        "name": {
            "last": "Last",
            "first": "First",
            "middle": "H"
        },
        "telephones": [
            {
                "number": "9585550103"
            }
        ],
        "addresses": [
            {
                "state": "TN",
                "city": "SPRINGFIELD",
                "line1": "7572 Road Rd",
                "postalCode": "37172-6488"
            }
        ],
        "email": [
            "[email protected]"
        ]
    }
}

Supported data elements

Example response Customer Info (/customers)

📘

Note

This is an example. See the chart below for a complete list of supported data elements.

{
    "customer": {
        "customerId": "1521963501",
        "name": {
            "last": "Last",
            "first": "First",
            "middle": "H"
        },
        "telephones": [
            {
                "number": "9585550103"
            }
        ],
        "addresses": [
            {
                "state": "TN",
                "city": "SPRINGFIELD",
                "line1": "7572 Road Rd",
                "postalCode": "37172-6488"
            }
        ],
        "email": [
            "[email protected]"
        ]
    }
}

Supported data elements

Example response Account holder (/contacts)

📘

Note

This is an example. /contacts extends the /customers response entity. See the chart above combined with the chart below for a complete list of supported data elements.

{
  "holders": [
    {
      "customerId": "1521963501",
      "name": {
        "first": "First",
        "middle": "H",
        "last": "Last"
      },
      "businessCustomer": {
        "registeredAgents": [
          {
            "first": "RAFirst",
            "middle": "I",
            "last": "RALast"
          }
        ],
        "registeredId": "111223333",
        "industryCode": {
          "type": "BCLASS",
          "code": "BC"
        },
        "domicile": {
          "country": "USA"
        }
      },
      "addresses": [
        {
          "state": "TN",
          "city": "SPRINGFIELD",
          "line1": "7572 Road Rd",
          "postalCode": "37172-6488"
        }
      ],
      "telephones": [
        {
          "number": "9585550103"
        }
      ],
      "email": [
          "[email protected]"
      ],
      "accounts": [
        {
          "accountId": "839502593",
          "relationship": "PRIMARY"
        }
      ],
      "relationship": "PRIMARY"
    }
  ]
}

Supported data elements /contacts

Need help?

Check out our Developer Community, or visit the Support Center in the Data Recipient Hub.

Looking for provider nuance documentation?

All provider nuance documentation is available in the Data providers section in the Data Recipient Hub.

Still stuck?

For all production issues, submit a support ticket through the Data Recipient Hub. Our support team is standing by 24/7. Questions and non-production issues will be answered during business hours.