Documentation

Account information

GET

https://sandbox-products.ddp.akoya.com/accounts-info/{version}/{providerId}

Get basic account information including accountId, masked account number, type, description, etc.

To view the response schema, select the 200 response below. Then pick an option for annuity, deposit, insurance, investment, loan, and line of credit account types.

For an example payload response, see the 200 example response below the Try it feature. The example is from a deposit account but all account types are supported by this endpoint.

The id_token should be used as the bearer token with this call.

Use the mode query param to receive FDX-aligned, standardized data values (Beta). For example:

https://sandbox-products.ddp.akoya.com/accounts-info/v2/mikomo?mode=standard

mode is available in both sandbox and production.

mode is supported by a subset of providers. Log into the Data Recipient Hub and click here to view a list of all providers supporting the mode parameter.

Path Parameters

version*
stringdefault: v2
Akoya major version number. Do not use minor version numbers. For instance, use v2 and not v2.2
providerId*
stringdefault: mikomo
Id of provider

Headers

x-akoya-interaction-type
string
Optional but recommended header to include with each data request. Allowed values are `user` or `batch`. `user` indicates a request is prompted by an end-user action. `batch` indicates the request is part of a batch process.
batch

Query Parameters

mode
string
BETA. Default is raw. Use standard for FDX-aligned, standardized data values.
raw

Responses

200
OK
Response Body
object
accounts
array of objects
An array of accounts with entity types dependent on the account type (deposit, investment, loan, line of credit, annuity or insurance)
Any of:
depositAccount
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
object
currencyCode
string
Iso 4217 currency code.
currencyRate
number
Currency rate between original and converted currency.
originalCurrencyCode
string
Iso 4217 currency code.
description
string
error
Present if an error was encountered while retrieving this account
object
code
integer
Long term persistent identifier which can be used to trace error condition back to log information
message
string
End user displayable information which might help the customer diagnose an error
fiAttributes
array of objects
object
name
string
Name of attribute
value
string
Value of attribute
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.
OPENCLOSEDPENDINGOPENPENDINGCLOSEDELINQUENTPAIDNEGATIVECURRENTBALANCE
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)
ASSETLIABILITY
interestRate
number
Interest Rate of Account
interestRateType
string
The type of interest rate. FIXED or VARIABLE.
FIXEDVARIABLE
interestRateAsOf
string
Date of account’s interest rate
lastActivityDate
string
Date that last transaction occurred on account
micrNumber
string
MICR Number. (Magnetic Ink Character Recognition)
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
annualPercentageYield
number
Annual Percentage Yield. If account type = CD, required.
term
integer
Term of CD in months
maturityDate
string
Maturity date for CDs. If account type = CD, required.
loanAccount
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
object
currencyCode
string
Iso 4217 currency code.
currencyRate
number
Currency rate between original and converted currency.
originalCurrencyCode
string
Iso 4217 currency code.
description
string
error
Present if an error was encountered while retrieving this account
object
code
integer
Long term persistent identifier which can be used to trace error condition back to log information
message
string
End user displayable information which might help the customer diagnose an error
fiAttributes
array of objects
object
name
string
Name of attribute
value
string
Value of attribute
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.
OPENCLOSEDPENDINGOPENPENDINGCLOSEDELINQUENTPAIDNEGATIVECURRENTBALANCE
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)
ASSETLIABILITY
interestRate
number
Interest Rate of Account
interestRateType
string
The type of interest rate. FIXED or VARIABLE.
FIXEDVARIABLE
interestRateAsOf
string
Date of account’s interest rate
lastActivityDate
string
Date that last transaction occurred on account
micrNumber
string
MICR Number. (Magnetic Ink Character Recognition)
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
compoundingPeriod
string
DAILYWEEKLYBIWEEKLYSEMIMONTHLYMONTHLYSEMIANNUALLYANNUALLY
loanTerm
integer
Term of loan in months
maturityDate
string
Maturity date is required for CDs
originatingDate
string
Loan origination date
paymentFrequency
string
DAILYWEEKLYBIWEEKLYSEMIMONTHLYMONTHLYSEMIANNUALLYANNUALLY
totalNumberOfPayments
integer
Total number of payments
locAccount
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
object
currencyCode
string
Iso 4217 currency code.
currencyRate
number
Currency rate between original and converted currency.
originalCurrencyCode
string
Iso 4217 currency code.
description
string
error
Present if an error was encountered while retrieving this account
object
code
integer
Long term persistent identifier which can be used to trace error condition back to log information
message
string
End user displayable information which might help the customer diagnose an error
fiAttributes
array of objects
object
name
string
Name of attribute
value
string
Value of attribute
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.
OPENCLOSEDPENDINGOPENPENDINGCLOSEDELINQUENTPAIDNEGATIVECURRENTBALANCE
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)
ASSETLIABILITY
interestRate
number
Interest Rate of Account
interestRateType
string
The type of interest rate. FIXED or VARIABLE.
FIXEDVARIABLE
interestRateAsOf
string
Date of account’s interest rate
lastActivityDate
string
Date that last transaction occurred on account
micrNumber
string
MICR Number. (Magnetic Ink Character Recognition)
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
investmentAccount
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
object
currencyCode
string
Iso 4217 currency code.
currencyRate
number
Currency rate between original and converted currency.
originalCurrencyCode
string
Iso 4217 currency code.
description
string
error
Present if an error was encountered while retrieving this account
object
code
integer
Long term persistent identifier which can be used to trace error condition back to log information
message
string
End user displayable information which might help the customer diagnose an error
fiAttributes
array of objects
object
name
string
Name of attribute
value
string
Value of attribute
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.
OPENCLOSEDPENDINGOPENPENDINGCLOSEDELINQUENTPAIDNEGATIVECURRENTBALANCE
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)
ASSETLIABILITY
interestRate
number
Interest Rate of Account
interestRateType
string
The type of interest rate. FIXED or VARIABLE.
FIXEDVARIABLE
interestRateAsOf
string
Date of account’s interest rate
lastActivityDate
string
Date that last transaction occurred on account
micrNumber
string
MICR Number. (Magnetic Ink Character Recognition)
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
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
insuranceAccount
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
object
currencyCode
string
Iso 4217 currency code.
currencyRate
number
Currency rate between original and converted currency.
originalCurrencyCode
string
Iso 4217 currency code.
description
string
error
Present if an error was encountered while retrieving this account
object
code
integer
Long term persistent identifier which can be used to trace error condition back to log information
message
string
End user displayable information which might help the customer diagnose an error
fiAttributes
array of objects
object
name
string
Name of attribute
value
string
Value of attribute
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.
OPENCLOSEDPENDINGOPENPENDINGCLOSEDELINQUENTPAIDNEGATIVECURRENTBALANCE
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)
ASSETLIABILITY
interestRate
number
Interest Rate of Account
interestRateType
string
The type of interest rate. FIXED or VARIABLE.
FIXEDVARIABLE
interestRateAsOf
string
Date of account’s interest rate
lastActivityDate
string
Date that last transaction occurred on account
micrNumber
string
MICR Number. (Magnetic Ink Character Recognition)
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
accountCategory
string
The account category of the insurance account. Possible enums: DEPOSIT_ACCOUNT, INVESTMENT_ACCOUNT, LOAN_ACCOUNT, LOC_ACCOUNT, INSURANCE_ACCOUNT
DEPOSIT_ACCOUNTINVESTMENT_ACCOUNTLOAN_ACCOUNTLOC_ACCOUNTINSURANCE_ACCOUNT
annuityAccount
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
object
currencyCode
string
Iso 4217 currency code.
currencyRate
number
Currency rate between original and converted currency.
originalCurrencyCode
string
Iso 4217 currency code.
description
string
error
Present if an error was encountered while retrieving this account
object
code
integer
Long term persistent identifier which can be used to trace error condition back to log information
message
string
End user displayable information which might help the customer diagnose an error
fiAttributes
array of objects
object
name
string
Name of attribute
value
string
Value of attribute
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.
OPENCLOSEDPENDINGOPENPENDINGCLOSEDELINQUENTPAIDNEGATIVECURRENTBALANCE
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)
ASSETLIABILITY
interestRate
number
Interest Rate of Account
interestRateType
string
The type of interest rate. FIXED or VARIABLE.
FIXEDVARIABLE
interestRateAsOf
string
Date of account’s interest rate
lastActivityDate
string
Date that last transaction occurred on account
micrNumber
string
MICR Number. (Magnetic Ink Character Recognition)
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
annuityProductType
string
CURRENCYSHARES
annuityValueBasis
string
FIXEDVARIABLE
paymentFrequency
string
ANNUALLYQUARTERLYMONTHLYWEEKLY
Headers
x-akoya-interaction-idstring
Akoya supplied interaction id used for logging and error tracking
206
Partial Content. Success searching for accounts. Some errors are being returned.
Response Body
object
accounts
array of objects
An array of accounts with entity types dependent on the account type (deposit, investment, loan, line of credit, annuity or insurance)
Any of:
depositAccount
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
object
currencyCode
string
Iso 4217 currency code.
currencyRate
number
Currency rate between original and converted currency.
originalCurrencyCode
string
Iso 4217 currency code.
description
string
error
Present if an error was encountered while retrieving this account
object
code
integer
Long term persistent identifier which can be used to trace error condition back to log information
message
string
End user displayable information which might help the customer diagnose an error
fiAttributes
array of objects
object
name
string
Name of attribute
value
string
Value of attribute
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.
OPENCLOSEDPENDINGOPENPENDINGCLOSEDELINQUENTPAIDNEGATIVECURRENTBALANCE
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)
ASSETLIABILITY
interestRate
number
Interest Rate of Account
interestRateType
string
The type of interest rate. FIXED or VARIABLE.
FIXEDVARIABLE
interestRateAsOf
string
Date of account’s interest rate
lastActivityDate
string
Date that last transaction occurred on account
micrNumber
string
MICR Number. (Magnetic Ink Character Recognition)
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
annualPercentageYield
number
Annual Percentage Yield. If account type = CD, required.
term
integer
Term of CD in months
maturityDate
string
Maturity date for CDs. If account type = CD, required.
loanAccount
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
object
currencyCode
string
Iso 4217 currency code.
currencyRate
number
Currency rate between original and converted currency.
originalCurrencyCode
string
Iso 4217 currency code.
description
string
error
Present if an error was encountered while retrieving this account
object
code
integer
Long term persistent identifier which can be used to trace error condition back to log information
message
string
End user displayable information which might help the customer diagnose an error
fiAttributes
array of objects
object
name
string
Name of attribute
value
string
Value of attribute
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.
OPENCLOSEDPENDINGOPENPENDINGCLOSEDELINQUENTPAIDNEGATIVECURRENTBALANCE
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)
ASSETLIABILITY
interestRate
number
Interest Rate of Account
interestRateType
string
The type of interest rate. FIXED or VARIABLE.
FIXEDVARIABLE
interestRateAsOf
string
Date of account’s interest rate
lastActivityDate
string
Date that last transaction occurred on account
micrNumber
string
MICR Number. (Magnetic Ink Character Recognition)
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
compoundingPeriod
string
DAILYWEEKLYBIWEEKLYSEMIMONTHLYMONTHLYSEMIANNUALLYANNUALLY
loanTerm
integer
Term of loan in months
maturityDate
string
Maturity date is required for CDs
originatingDate
string
Loan origination date
paymentFrequency
string
DAILYWEEKLYBIWEEKLYSEMIMONTHLYMONTHLYSEMIANNUALLYANNUALLY
totalNumberOfPayments
integer
Total number of payments
locAccount
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
object
currencyCode
string
Iso 4217 currency code.
currencyRate
number
Currency rate between original and converted currency.
originalCurrencyCode
string
Iso 4217 currency code.
description
string
error
Present if an error was encountered while retrieving this account
object
code
integer
Long term persistent identifier which can be used to trace error condition back to log information
message
string
End user displayable information which might help the customer diagnose an error
fiAttributes
array of objects
object
name
string
Name of attribute
value
string
Value of attribute
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.
OPENCLOSEDPENDINGOPENPENDINGCLOSEDELINQUENTPAIDNEGATIVECURRENTBALANCE
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)
ASSETLIABILITY
interestRate
number
Interest Rate of Account
interestRateType
string
The type of interest rate. FIXED or VARIABLE.
FIXEDVARIABLE
interestRateAsOf
string
Date of account’s interest rate
lastActivityDate
string
Date that last transaction occurred on account
micrNumber
string
MICR Number. (Magnetic Ink Character Recognition)
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
investmentAccount
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
object
currencyCode
string
Iso 4217 currency code.
currencyRate
number
Currency rate between original and converted currency.
originalCurrencyCode
string
Iso 4217 currency code.
description
string
error
Present if an error was encountered while retrieving this account
object
code
integer
Long term persistent identifier which can be used to trace error condition back to log information
message
string
End user displayable information which might help the customer diagnose an error
fiAttributes
array of objects
object
name
string
Name of attribute
value
string
Value of attribute
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.
OPENCLOSEDPENDINGOPENPENDINGCLOSEDELINQUENTPAIDNEGATIVECURRENTBALANCE
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)
ASSETLIABILITY
interestRate
number
Interest Rate of Account
interestRateType
string
The type of interest rate. FIXED or VARIABLE.
FIXEDVARIABLE
interestRateAsOf
string
Date of account’s interest rate
lastActivityDate
string
Date that last transaction occurred on account
micrNumber
string
MICR Number. (Magnetic Ink Character Recognition)
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
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
insuranceAccount
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
object
currencyCode
string
Iso 4217 currency code.
currencyRate
number
Currency rate between original and converted currency.
originalCurrencyCode
string
Iso 4217 currency code.
description
string
error
Present if an error was encountered while retrieving this account
object
code
integer
Long term persistent identifier which can be used to trace error condition back to log information
message
string
End user displayable information which might help the customer diagnose an error
fiAttributes
array of objects
object
name
string
Name of attribute
value
string
Value of attribute
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.
OPENCLOSEDPENDINGOPENPENDINGCLOSEDELINQUENTPAIDNEGATIVECURRENTBALANCE
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)
ASSETLIABILITY
interestRate
number
Interest Rate of Account
interestRateType
string
The type of interest rate. FIXED or VARIABLE.
FIXEDVARIABLE
interestRateAsOf
string
Date of account’s interest rate
lastActivityDate
string
Date that last transaction occurred on account
micrNumber
string
MICR Number. (Magnetic Ink Character Recognition)
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
accountCategory
string
The account category of the insurance account. Possible enums: DEPOSIT_ACCOUNT, INVESTMENT_ACCOUNT, LOAN_ACCOUNT, LOC_ACCOUNT, INSURANCE_ACCOUNT
DEPOSIT_ACCOUNTINVESTMENT_ACCOUNTLOAN_ACCOUNTLOC_ACCOUNTINSURANCE_ACCOUNT
annuityAccount
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
object
currencyCode
string
Iso 4217 currency code.
currencyRate
number
Currency rate between original and converted currency.
originalCurrencyCode
string
Iso 4217 currency code.
description
string
error
Present if an error was encountered while retrieving this account
object
code
integer
Long term persistent identifier which can be used to trace error condition back to log information
message
string
End user displayable information which might help the customer diagnose an error
fiAttributes
array of objects
object
name
string
Name of attribute
value
string
Value of attribute
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.
OPENCLOSEDPENDINGOPENPENDINGCLOSEDELINQUENTPAIDNEGATIVECURRENTBALANCE
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)
ASSETLIABILITY
interestRate
number
Interest Rate of Account
interestRateType
string
The type of interest rate. FIXED or VARIABLE.
FIXEDVARIABLE
interestRateAsOf
string
Date of account’s interest rate
lastActivityDate
string
Date that last transaction occurred on account
micrNumber
string
MICR Number. (Magnetic Ink Character Recognition)
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
annuityProductType
string
CURRENCYSHARES
annuityValueBasis
string
FIXEDVARIABLE
paymentFrequency
string
ANNUALLYQUARTERLYMONTHLYWEEKLY
Headers
x-akoya-interaction-idstring
Akoya supplied interaction id used for logging and error tracking
400
401 - Invalid input
Response Body
object
code
integer
Long term persistent identifier which can be used to trace error condition back to log information
message
string
End user displayable information which might help the customer diagnose an error
401
602 - Customer not authorized
Response Body
code
integer
message
string
404
701 - Tax Lots not found. The `holdingId` may be wrong.
Response Body
code
integer
message
string
406
1203 - Content Type not Supported
Response Body
object
code
integer
Long term persistent identifier which can be used to trace error condition back to log information
message
string
End user displayable information which might help the customer diagnose an error
429
1207 - Too many requests
Response Body
object
code
integer
Long term persistent identifier which can be used to trace error condition back to log information
message
string
End user displayable information which might help the customer diagnose an error
500
500 - Internal server error
Response Body
object
code
integer
Long term persistent identifier which can be used to trace error condition back to log information
message
string
End user displayable information which might help the customer diagnose an error
501
1106 - Version not supported or not implemented
Response Body
object
code
integer
Long term persistent identifier which can be used to trace error condition back to log information
message
string
End user displayable information which might help the customer diagnose an error
503
503 - System is down for maintenance
Response Body
object
code
integer
Long term persistent identifier which can be used to trace error condition back to log information
message
string
End user displayable information which might help the customer diagnose an error

Try it

Language

Library

Base URL

Authorization

Bearer Token

const options = {
	"method": "GET",
	"headers": {
		"x-akoya-interaction-type": "batch"
	}
}};
fetch('https://sandbox-products.ddp.akoya.com/accounts-info/v2/mikomo?mode=raw', options)
  .then(response => response.json())
  .catch(err => console.error(err));

Account info guide Balances guide

Introduction

Technical Guides

Sandbox Data

Reference

Overview

Akoya Token API v2.2.0

Akoya Service Token API v1.0.1

Akoya APIs v2.3.0

Akoya Apps Management API v2.0.0

Akoya Notifications API v1.1.0