Account information available with all Akoya products.
Akoya products include basic account information such as identifiers, account types, status, descriptions, and everything you need for top level information about an end-user’s account(s).
This account information is available as a standalone endpoint and is also included in results of balances and investment endpoints. To use this product, you must have the end-user’s consent and their associated ID token for permissioned data.
Results for account info are returned in JSON in FDX format. Account info includes a common grouping of data and may contain additional data elements for annuity, deposit, insurance, investment, or loan account types.
Example response
Data elements shown are not exhaustive
This is an example. See the chart below for a complete list of supported data elements.
{
"depositAccount": {
"accountId": "g833202fb0866d0ad83472c429",
"accountType": "CHECKING",
"accountNumberDisplay": "xxxxxxxx0071",
"currency": {
"currencyCode": "USD"
},
"description": "Checking Plus",
"fiAttributes": [
{
"name": "accountOpenedDate",
"value": "2020-04-23"
},
{
"name": "interestPaidLastYear",
"value": "3.20"
}
],
"nickname": "Nickname Checking Plus 0071",
"productName": "Checking Plus",
"status": "OPEN",
"lineOfBusiness": "Personal",
"balanceType": "ASSET",
"interestRate": 0.0125,
"interestRateType": "FIXED",
"interestRateAsOf": "2022-03-24T14:15:22Z",
"lastActivityDate": "2022-03-24T14:15:22Z"
}
}
Supported data elements
Note
Account info responses vary by account category.
All account categories
| Name | Type | Description |
|---|---|---|
| accountId | string | Long-term persistent identity of the account. Not an account number. This identity must be unique to the owning institution. |
| accountType | string | The type of an account. For instance, CHECKING, SAVINGS, 401K, etc. |
| accountNumberDisplay | string | Account display number for the end user’s handle at owning institution. This is to be displayed by the Interface Provider. |
| currency | [currency] | Indicates the currency code used by the account. May also include currency rate. |
| description | string | Description of account. |
| fiAttributes | [fiAttribute] | Data provider-specific attributes. |
| nickname | string | Name given by the user. Used in UIs to assist in account selection |
| productName | string | Marketed product name for this account. Used in UIs to assist in account selection |
| status | string | The status of an account. |
| lineOfBusiness | string | The line of business, such as consumer, consumer joint, small business, corporate, etc. |
| balanceType | string | ASSET (positive transaction amount increases balance), LIABILITY (positive transaction amount decreases balance). |
| interestRate | number | Interest Rate of Account |
| interestRateType | string | The type of interest rate. FIXED or VARIABLE. |
| interestRateAsOf | string(date-time) | Date of account’s interest rate |
| lastActivityDate | string(date-time) | Date that last transaction occurred on account |
| micrNumber | string | MICR Number |
| parentAccountId | string | Long-term persistent identity of the parent account. This is used to group accounts. |
| priorInterestRate | number | Previous Interest Rate of Account |
| transferIn | boolean | Account is eligible for incoming transfers |
| transferOut | boolean | Account is eligible for outgoing transfers |
Deposit accounts
may also include:
| Name | Type | Description |
|---|---|---|
| annualPercentageYield | number | Annual Percentage Yield. If account type = CD, required. |
| term | integer | Term of CD in months |
| maturityDate | string(date-time) | Maturity date for CDs. If account type = CD, required. |
Line of credit accounts
No additional data elements
Loan accounts
may also include:
| Name | Type | Description |
|---|---|---|
| compoundingPeriod | string | none |
| loanTerm | integer | Term of loan in months |
| maturityDate | string(date-time) | Maturity date is required for CDs |
| originatingDate | string(date-time) | Loan origination date |
| paymentFrequency | string | none |
| totalNumberOfPayments | integer | Total number of payments |
Investment accounts
may also include:
| Name | Type | Description |
|---|---|---|
| allowedCheckWriting | boolean | Check writing privileges |
| allowedOptionTrade | boolean | Allowed to trade options |
| brokerId | string | Unique identifier FI |
| calendaryearFor401K | string | Date for this calendar year for 401K account |
| employerName | string | Name of the employer in investment 401k Plan |
| margin | boolean | Margin trading is allowed |
| planId | string | Plan number for Investment 401k plan |
Insurance accounts
may also include:
| Name | Type | Description |
|---|---|---|
| accountCategory | string | none |
Annuity accounts
may also include:
| Name | Type | Description |
|---|---|---|
| annuityProductType | string | none |
| annuityValueBasis | string | none |
| paymentFrequency | string | none |
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.