✨ Coming soon

Akoya is excited to announce two upcoming releases!

Akoya API v2 release!
Customers product update to include accounts.

Both will be available in summer 2022.

Customers product update

Available Summer 2022

We’re enhancing our Customers product by adding a new data element, accounts.

The /customers/current endpoint will return an array of accounts which will specify the relationship between these listed accounts and the current customer. This is defined by the FDX CustomerToAccountRelationship entity.

What’s in the `CustomerToAccountRelationship` entity?

The CustomerToAccountRelationship entity allows you to return data describing the relationship between a set of accounts and the current customer. The /customers/currentendpoint will return an additional data field, accounts.

Field	Type	Description
`accounts`	Array of `CustomerToAccountRelationship`	List of accounts related to this customer.

The CustomerToAccountRelationship entity is defined as:

Field	Type	Description
`accountId`	`Identifier`	Account ID of the related account
`relationship`	`AccountHolderRelationship`	Type of relationship to the account

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"
        }
      ]
    }
}

Akoya Endpoints v2

Available Summer 2022

Data recipients on the Akoya network have growing needs to serve their customers and ever-evolving use cases. Akoya is launching new API products to meet these needs. These new APIs will align with the products Akoya has to offer: Balances, Customers, Investments, Payments, and Transactions.

What are these new endpoints?

For balance checking before payment initiation, we’ll have a new /balances endpoint.

To consistently page through historical transactions for one of your end-user’s accounts, the v2 /transactions endpoint will have a standardized pagination schema.

Those are just a few examples of how to use our v2 endpoints! We’re sure you’ll find new and innovative ways to leverage them to best serve your end-users.

Here’s a quick summary of these new endpoints:

Product / Endpoint path	Data elements returned (non-exhaustive)
Accounts Basic `/accounts-basic/v2/{providerId}/`	Returns a basic version of account info data elements such as: `accountType` `productName` `status` `currency`
Accounts `/accounts/v2/{providerId}/`	Returns a comprehensive version of account info, balances, and investments data elements such as: `marginBalance` `availableCashBalance` `holdings`: `holdingType`, `symbol`, `units` `contribution`: `employerYearToDate` , `employeeYearToDate`
Balances `/balances/v2/{providerId}/`	Returns both account info and balances data elements such as: `accountType` `currency` `balanceAsOf` `availableBalance` `currentBalance` `creditLine` `availableCredit`
Transactions `/transactions/v2/{providerId}/{accountId}`	Returns a paginated list of transactions data elements such as: `transactionId` `postedTimestamp` `description` `category` `amount` `transactionType`
Payment networks `/payments/v2/{providerId}/{accountId}/payment-networks`	Returns payment network related data elements such as: `bankId` (i.e., routing number) `identifier` (i.e., account number) `identifierType` (e.g., tokenized account number) `type` (e.g., US_ACH, US_RTP)
Customer info `/customers/v2/{providerId}/current`	Returns customer info related data elements such as: `name` `email` `addresses` `telephones` `relationships` (i.e., account holder relationship to an account)

Why does it matter to me?

We are providing more granular endpoints that better target your use cases and enable us to offer you better pricing based on those use cases. Offering a consistent experience is also a key mission for us, so we always strive for standardization across the providers on our network. This makes it easier for you to integrate with Akoya’s network and use our products.

What will happen to the v1 endpoints that I’m using today?

Nothing.

We are not decommissioning our v1 endpoints. However, we strongly encourage you to use our v2 endpoints for any new implementations, as we’ll be adding new features and pricing over time.

Can I migrate from the v1 endpoints to the v2 endpoints?

Yes.

We’re creating a guide on how to perform the migration. Stay tuned!