Customers product enhancement (October 12, 2022)
We’ve enhanced our Customers product! Akoya has added support for the FDX "CustomerToAccountRelationship" entity. Data from our Customers product will now include accounts
, an array of data that specifies the relationship between listed accounts and the current customer. Our OpenAPI spec and customer info
endpoint documentation have been updated to reflect this enhancement.
Akoya is actively working to increase the coverage of data providers that support this data element.
What’s been added?
The customer
element now includes accounts
which describes the relationship between a set of accounts and the current customer.
The accounts
array includes objects with the following elements:
Field | Type | Description |
---|---|---|
accountId | string | Account ID of the related account |
relationship | string | Type of relationship to the account |
The relationship
data element may include (but is not limited to) the following enums:
- AUTHORIZED_USER
- BUSINESS
- FOR_BENEFIT_OF
- FOR_BENEFIT_OF_PRIMARY
- FOR_BENEFIT_OF_PRIMARY_JOINT_RESTRICTED
- FOR_BENEFIT_OF_SECONDARY
- FOR_BENEFIT_OF_SECONDARY_JOINT_RESTRICTED
- FOR_BENEFIT_OF_SOLE_OWNER_RESTRICTED
- POWER_OF_ATTORNEY
- PRIMARY_JOINT_TENANTS
- PRIMARY
- PRIMARY_BORROWER
- PRIMARY_JOINT
- SECONDARY
- SECONDARY_JOINT_TENANTS
- SECONDARY_BORROWER
- SECONDARY_JOINT
- SOLE_OWNER
- TRUSTEE
- UNIFORM_TRANSFER_TO_MINOR
Example response
{
"customer":
{
"customerId": "7hfls01887ds",
"name":
{
"first": "Jane",
"middle": "Elizabeth",
"last": "Smith"
},
"addresses": [
{
"line1": "16 East St",
"city": "Boston",
"state": "Massachusetts",
"postalCode": "02129",
"country": "USA"
}
],
"telephones": [
{
"number": "6178907862"
},
{
"number": "6171809472"
}
],
"email": [
"[email protected]"
],
"accounts": [
{
"accountId": "1058527205",
"relationship": "PRIMARY_JOINT"
},
{
"accountId": "1058566233",
"relationship": "SECONDARY"
}
]
}
}