Customers

Verified contact information on file, including name, email, address, and phone number.

Full customer information for permissioned end-user.

Results for customers are returned in JSON in FDX format.

Endpoint: /customers

API documentation: https://docs.akoya.com/v2/reference/customer-info

curl --location --request GET 'https://sandbox-products.ddp.akoya.com/customers/v2/{providerId}/current' --header 'Content-Type: application/x-www-form-urlencoded' --header 'Authorization: Bearer {id_token}

Example response

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

NameTypeDescription
customerIdstringLong-term persistent identity of the customer. This identity must be unique to the owning institution
nameobjectnone
name.firststringFirst or given name. This data element may contain first & last name if not separated.
name.middlestringnone
name.laststringnone
name.prefixstringName prefix, e.g. Mr.
name.suffixstringGenerational or academic suffix
name.companystringCompany name
addressesarray[addresses]An array of the customer's addresses
addresses.typestringThe location type of an address
addresses.line1stringMay contain full address if not separated
addresses.line2stringnone
addresses.line3stringnone
addresses.citystringnone
addresses.statestringnone
addresses.postalCodestringnone
addresses.countrystringISO 3166 Country Code
telephonesarray[telephones]An array of the customer's telephone numbers.
telephones.numberstringnone
telephones.typestringnone
telephones.countrystringCountry calling codes defined by ITU-T recommendations E.123 and E.164
emailarray[string]An array of the customer's electronic mail addresses