availableCash | | object | | | |
availableCash.amount | | number |
| | |
availableCash.currency | | string |
| | |
includeInNetWorth | | boolean | | | |
moneyMarketBalance | | object | | | |
moneyMarketBalance.amount | | number | | | |
moneyMarketBalance.currency | | string | | | |
enrollmentDate | | string | | | |
estimatedDate | | string | | | |
memo | | string | | | |
guarantor | | string | | | |
interestPaidLastYear | | object | | | |
interestPaidLastYear.amount | | number | | | |
interestPaidLastYear.currency | | string | | | |
lastupdated | | string | | | |
balance | balances | object | object | | |
balance.amount | balances.available | number | numbernull | | |
balance.currency | balances.iso_currency_code, balances.unofficial_currency_code | string | stringnull | | |
homeInsuranceType | | string | | | |
id | account_id | number | string | | |
cash | | object | | | |
cash.amount | | number | | | |
cash.currency | | string | | | |
totalCreditLine | | object | | | |
totalCreditLine.amount | | number | | | |
totalCreditLine.currency | | string | | | |
providerName | | string | | | |
valuationType | | string | | | |
marginBalance | | object | | | |
marginBalance.amount | | number | | | |
marginBalance.currency | | string | | | |
apr | | number | | | |
availableCredit | | object | | | |
availableCredit.amount | | number | | | |
availableCredit.currency | | string | | | |
currentBalance | | object | | | |
currentBalance.amount | | number | | | |
currentBalance.currency | | string | | | |
isManual | | boolean | | | |
profile | | object | | | |
profile.identifier | | array | | | |
profile.identifier[].type | | string | | | |
profile.identifier[].value | | string | | | |
profile.address[].zip | | string | | | |
profile.address[].country | | string | | | |
profile.address[].address3 | | string | | | |
profile.address[].address2 | | string | | | |
profile.address[].city | | string | | | |
profile.address[].sourceType | | string | | | |
profile.address[].address1 | | string | | | |
profile.address[].street | | string | | | |
profile.address[].state | | string | | | |
profile.address[].type | | string | | | |
profile.phoneNumber | | array | | | |
profile.phoneNumber[].type | | string | | | |
profile.phoneNumber[].value | | string | | | |
profile.email | | array | | | |
profile.email[].type | | string | | | |
profile.email[].value | | string | | | |
escrowBalance | | object | | | |
escrowBalance.amount | | number | | | |
escrowBalance.currency | | string | | | |
nextLevel | | string | | | |
classification | | string | | | |
loanPayoffAmount | | object | | | |
loanPayoffAmount.amount | | number | | | |
loanPayoffAmount.currency | | string | | | |
interestRateType | | string | | | |
loanPayByDate | | string | | | |
faceAmount | | object | | | |
faceAmount.amount | | number | | | |
faceAmount.currency | | string | | | |
policyFromDate | | string | | | |
premiumPaymentTerm | | string | | | |
policyterm | | string | | | |
repaymentPlanType | | string | | | |
availableBalance | | object | | | |
availableBalance.amount | | number | | | |
availableBalance.currency | | string | | | |
accountStatus | | string | | | |
lifeInsuranceType | | string | | | |
fullAccountNumber | | string | | | |
premium | | object | | | |
premium.amount | | number | | | |
premium.currency | | string | | | |
aggregationSource | | string | | | |
overDraftLimit | | object | | | |
overDraftLimit.amount | | number | | | |
overDraftLimit.currency | | string | | | |
nickname | | string | | | |
term | | string | | | |
interestRate | | number | | | |
deathBenefit | | object | | | |
deathBenefit.amount | | number | | | |
deathBenefit.currency | | string | | | |
address | | object | | | |
address.zip | | string | | | |
address.country | | string | | | |
address.address3 | | string | | | |
address.address2 | | string | | | |
address.city | | string | | | |
address.sourceType | | string | | | |
address.address1 | | string | | | |
address.street | | string | | | |
address.state | | string | | | |
address.type | | string | | | |
cashValue | | object | | | |
cashValue.amount | | number | | | |
cashValue.currency | | string | | | |
holder | | array | | | |
holder.identifier | | array | | | |
holder[].identifier[].type | | string | | | |
holder[].identifier[].value | | string | | | |
holder[].gender | | string | | | |
holder[].ownership | | string | | | |
holder[].name | | object | | | |
holder[].name.middle | | string | | | |
holder[].name.last | | string | | | |
holder[].name.fullName | | string | | | |
holder[].name.first | | string | | | |
401kLoan | | object | | | |
401kLoan.amount | | number | | | |
401kLoan.currency | | string | | | |
homeValue | | object | | | |
homeValue.amount | | number | | | |
homeValue.currency | | string | | | |
accountNumber | | string | | | This may be similar to "mask" of Plaid's account data, if it masks the account number to 4 digits |
createdDate | | string | | | |
interestPaidYTD | | object | | | |
interestPaidYTD.amount | | number | | | |
interestPaidYTD.currency | | string | | | |
providerAccountId | | number | | | |
collateral | | string | | | |
dataset | | array | | | |
dataset[].lastUpdated | | string | | | |
dataset[].updateEligibility | | string | | | |
dataset[].additionalStatus | | string | | | |
dataset[].nextUpdateScheduled | | string | | | |
dataset[].name | | string | | | |
dataset[].lastUpdateAttempt | | string | | | |
runningBalance | | object | | | |
runningBalance.amount | | number | | | |
runningBalance.currency | | string | | | |
sourceId | | string | | | |
dueDate | | string | | | |
frequency | | string | | | |
maturityAmount | | object | | | |
maturityAmount.amount | | number | | | |
maturityAmount.currency | | string | | | |
associatedProviderAccountId | | array | | | |
isAsset | | boolean | | | |
principalBalance | | object | | | |
principalBalance.amount | | number | | | |
principalBalance.currency | | string | | | |
totalCashLimit | | object | | | |
totalCashLimit.amount | | number | | | |
totalCashLimit.currency | | string | | | |
maturityDate | | string | | | |
minimumAmountDue | | object | | | |
minimumAmountDue.amount | | number | | | |
minimumAmountDue.currency | | string | | | |
annualPercentageYield | | number | | | |
accountType | subtype | string | stringnull | | |
originationDate | | string | | | |
totalVestedBalance | | object | | | |
totalVestedBalance.amount | | number | | | |
totalVestedBalance.currency | | string | | | |
rewardBalance | | array | | | |
rewardBalance[].expiryDate | | string | | | |
rewardBalance[].balanceToReward | | string | | | |
rewardBalance[].balanceType | | string | | | |
rewardBalance[].balance | | number | | | |
rewardBalance[].description | | string | | | |
rewardBalance[].balanceToLevel | | string | | | |
rewardBalance[].units | | string | | | |
sourceAccountStatus | | string | | | |
derivedApr | | number | | | |
policyEffectiveDate | | string | | | |
totalUnvestedBalance | | object | | | |
totalUnvestedBalance.amount | | number | | | |
totalUnvestedBalance.currency | | string | | | |
annuityBalance | | object | | | |
annuityBalance.amount | | number | | | |
annuityBalance.currency | | string | | | |
accountName | official_name | string | stringnull | | |
totalCreditLimit | | object | | | |
totalCreditLimit.amount | account.balances.limit | number | numbernull | | |
totalCreditLimit.currency | account.balances.iso_currency_code | string | | | |
policyStatus | | string | | | |
shortBalance | | object | | | |
shortBalance.amount | | number | | | |
shortBalance.currency | | string | | | |
lender | | string | | | |
lastEmployeeContributionAmount | | object | | | |
lastEmployeeContributionAmount.amount | | number | | | |
lastEmployeeContributionAmount.currency | | string | | | |
providerId | | string | | | |
lastPaymentDate | | string | | | |
primaryRewardUnit | | string | | | |
lastPaymentAmount | | object | | | |
lastPaymentAmount.amount | | number | | | |
lastPaymentAmount.currency | | string | | | |
remainingBalance | | object | | | |
remainingBalance.amount | | number | | | |
remainingBalance.currency | | string | | | |
userClassification | | string | | | |
bankTransferCode | | array | | | |
bankTransferCode[].id | | string | | | |
bankTransferCode[].type | | string | | | |
expirationDate | | string | | | |
coverage | | array | | | |
coverage[].amount | | array | | | |
coverage[].amount[].cover | | object | | | |
coverage[].amount[].cover.amount | | number | | | |
coverage[].amount[].cover.currency | | string | | | |
coverage[].amount[].unitType | | string | | | |
coverage[].amount[].type | | string | | | |
coverage[].amount[].limitType | | string | | | |
coverage[].amount[].met | | object | | | |
coverage[].amount[].met.amount | | number | | | |
coverage[].amount[].met.currency | | string | | | |
coverage[].planType | | string | | | |
coverage[].endDate | | string | | | |
coverage[].type | | string | | | |
coverage[].startDate | | string | | | |
cashApr | | number | | | |
autoRefresh | | object | | | |
autoRefresh.additionalStatus | | string | | | |
autoRefresh.asOfDate | | string | | | |
autoRefresh.status | | string | | | |
oauthMigrationStatus | | string | | | |
displayedName | name | string | string | | |
fullAccountNumberList | | object | | | |
fullAccountNumberList.paymentAccountNumber | | string | | | This may be similar to "mask" of Plaid's account data, if it masks the account number to 4 digits |
fullAccountNumberList.unmaskedAccountNumber | | string | | | |
amountDue | | object | | | |
amountDue.amount | | number | | | |
amountDue.currency | | string | | | |
currentLevel | | string | | | |
originalLoanAmount | | object | | | |
originalLoanAmount.amount | | number | | | |
originalLoanAmount.currency | | string | | | |
policyToDate | | string | | | |
loanPayoffDetails | | object | | | |
loanPayoffDetails.payByDate | | string | | | |
loanPayoffDetails.payoffAmount | | object | | | |
loanPayoffDetails.payoffAmount.amount | | number | | | |
loanPayoffDetails.payoffAmount.currency | | string | | | |
loanPayoffDetails.oustandingBalance.amount | | number | | | |
loanPayoffDetails.oustandingBalance.currency | | string | | | |
paymentProfile | | object | | | |
paymentProfile.identifier | | object | | | |
paymentProfile.identifier.type | | string | | | |
paymentProfile.identifier.value | | string | | | |
paymentProfile.address | | array | | | |
paymentProfile.address[].zip | | string | | | |
paymentProfile.address[].country | | string | | | |
paymentProfile.address[].address3 | | string | | | |
paymentProfile.address[].address2 | | string | | | |
paymentProfile.address[].city | | string | | | |
paymentProfile.address[].sourceType | | string | | | |
paymentProfile.address[].address1 | | string | | | |
paymentProfile.address[].street | | string | | | |
paymentProfile.address[].state | | string | | | |
paymentProfile.address[].type | | string | | | |
paymentProfile.paymentBankTransferCode | | object | | | |
paymentProfile.paymentBankTransferCode.id | | string | | | |
paymentProfile.paymentBankTransferCode.type | | string | | | |
CONTAINER | type | string | string | | |
lastEmployeeContributionDate | | string | | | |
lastPayment | | object | | | |
lastPayment.amount | | number | | | |
lastPayment.currency | | string | | | |
recurringPayment | | object | | | |
recurringPayment.amount | | number | | | |
recurringPayment.currency | | string | | | |
| items.item_id | | | | Unique Id from Plaid. We will need to generate and send along. |
| balances.current | | numbernull | | |
| balances.limit | | numbernull | | |
| mask | | stringnull | | |
| | | | | |
| | | | | |
| | | stringnull | | |
| | |
| | |
| | | | | |
N/A | items.available_products | | [string] | | A list of products available for the Item that have not yet been accessed. |
N/A | items.billed_products | | [string] | | |
| items.consent_expiration_time | | stringnull | | |
| items.error | | object | | |
| items.error.error_type | | string | | |
| items.error.error_code |
| string | | |
| items.error.error_message |
| string | | |
| items.error.display_message | | stringnull | | |
| items.error.request_id | | string | | |
| items.error.causes | | array | | |
| items.error.status | | numbernull | | |
| items.error.documentation_url | | string | | |
| items.error.suggested_action | | string | | |
| items.institution_id | | stringnull | | |
| | | | | |