Customers guide

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

The default endpoint, used in most cases, is Customer info (/customers). This endpoint returns information for the permissioned end-user.

An alternative endpoint, used in some cases, is Account holder information (/contacts). You will use this endpoint if it is required by specific data providers. Please check the Data Recipient Hub to determine which providers support this endpoint. This endpoint returns information on all account holders for the accounts permissioned by the end-user.

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

Name	Type	Description
customerId	string	Long-term persistent identity of the customer. This identity must be unique to the owning institution
name	object	none
name.first	string	First or given name. This data element may contain first & last name if not separated.
name.middle	string	none
name.last	string	none
name.prefix	string	Name prefix, e.g. Mr.
name.suffix	string	Generational or academic suffix
name.company	string	Company name
addresses	array[addresses]	An array of the customer's addresses
addresses.type	string	The location type of an address
addresses.line1	string	May contain full address if not separated
addresses.line2	string	none
addresses.line3	string	none
addresses.city	string	none
addresses.state	string	none
addresses.postalCode	string	none
addresses.country	string	ISO 3166 Country Code
telephones	array[telephones]	An array of the customer's telephone numbers.
telephones.number	string	none
telephones.type	string	none
telephones.country	string	Country calling codes defined by ITU-T recommendations E.123 and E.164
email	array[string]	An array of the customer's electronic mail addresses

Example response

📘Data elements shown are not exhaustive

Supported data elements

📘
Data elements shown are not exhaustive