Account info

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.

Endpoint: /accounts-basic

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

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

Example response

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

NameTypeRequiredDescription
accountIdstringtrueLong-term persistent identity of the account. Not an account number. This identity must be unique to the owning institution.
accountTypestringtrueThe type of an account. For instance, CHECKING, SAVINGS, 401K, etc.
accountNumberDisplaystringtrueAccount display number for the end user’s handle at owning institution. This is to be displayed by the Interface Provider.
currency[currency]falseIndicates the currency code used by the account. May also include currency rate.
descriptionstringtrueDescription of account.
fiAttributes[fiAttribute]falseData provider-specific attributes.
nicknamestringtrueName given by the user. Used in UIs to assist in account selection
productNamestringtrueMarketed product name for this account. Used in UIs to assist in account selection
statusstringtrueThe status of an account.
lineOfBusinessstringtrueThe line of business, such as consumer, consumer joint, small business, corporate, etc.
balanceTypestringtrueASSET (positive transaction amount increases balance), LIABILITY (positive transaction amount decreases balance).
interestRatenumbertrueInterest Rate of Account
interestRateTypestringfalseThe type of interest rate. FIXED or VARIABLE.
interestRateAsOfstring(date-time)falseDate of account’s interest rate
lastActivityDatestring(date-time)falseDate that last transaction occurred on account
micrNumberstringfalseMICR Number
parentAccountIdstringfalseLong-term persistent identity of the parent account. This is used to group accounts.
priorInterestRatenumberfalsePrevious Interest Rate of Account
transferInbooleanfalseAccount is eligible for incoming transfers
transferOutbooleanfalseAccount is eligible for outgoing transfers

Deposit accounts

may also include:

NameTypeRequiredDescription
annualPercentageYieldnumberfalseAnnual Percentage Yield. If account type = CD, required.
termintegerfalseTerm of CD in months
maturityDatestring(date-time)falseMaturity date for CDs. If account type = CD, required.

Line of credit accounts

No additional data elements

Loan accounts

may also include:

NameTypeRequiredDescription
compoundingPeriodstringfalsenone
loanTermintegertrueTerm of loan in months
maturityDatestring(date-time)falseMaturity date is required for CDs
originatingDatestring(date-time)falseLoan origination date
paymentFrequencystringfalsenone
totalNumberOfPaymentsintegerfalseTotal number of payments

Investment accounts

may also include:

NameTypeRequiredDescription
NameTypeRequiredDescription
allowedCheckWritingbooleanfalseCheck writing privileges
allowedOptionTradebooleanfalseAllowed to trade options
brokerIdstringfalseUnique identifier FI
calendaryearFor401KstringfalseDate for this calendar year for 401K account
employerNamestringfalseName of the employer in investment 401k Plan
marginbooleanfalseMargin trading is allowed
planIdstringfalsePlan number for Investment 401k plan

Insurance accounts

may also include:

NameTypeRequiredDescription
accountCategorystringfalsenone

Annuity accounts

may also include:

NameTypeRequiredDescription
annuityProductTypestringtruenone
annuityValueBasisstringtruenone
paymentFrequencystringfalsenone