POST api/UserInstitution/GetUserInstitutionAccounts
Get all UserInstitutionAccounts retrieved under a UserInstitution, e.g. "Primary Checking", "Savings" under login account "Bob1234" with "Chase Bank".
Request Information
URI Parameters
None.
Body Parameters
GetUserInstitutionAccountsParams| Name | Description | Type | Additional information |
|---|---|---|---|
| UserInstitutionID |
Guid-type UserInstitutionID. |
globally unique identifier |
None. |
Request Formats
application/json, text/json
{
"UserInstitutionID": "b52e7cf3-9353-40b0-adab-c37a195dac1e"
}
application/xml, text/xml
Coming soon.
Response Information
Resource Description
List of UserInstitutionAccounts retrieved under a UserInstitution.
Collection of UserInstitutionAccountInformation| Name | Description | Type | Additional information |
|---|---|---|---|
| UserInstitutionID |
Guid-type ID of the UserInstitution. |
globally unique identifier |
None. |
| AccountID |
Guid-type ID of the UserInstitutionAccount. |
globally unique identifier |
None. |
| AccountName |
Account name, e.g. "Primary Checking". |
string |
None. |
| AccountNumber |
Account number, e.g. "xxx1234". |
string |
None. |
| AccountType |
Account type, e.g. "Checking", "Savings". |
string |
None. |
| Balance |
Account balance. |
decimal number |
None. |
| AvailableBalance |
Account's available balance (Optional). |
decimal number |
None. |
| BalanceCurrency |
Account balance's currency symbol, e.g. "$". |
string |
None. |
| LastUpdated |
Last time the account was updated. |
date |
None. |
| DueDate |
If the account is a billing account or credit card account, the payment due date. |
date |
None. |
| Status |
Account's status. Account status is set to "Tracked" by default. Choose "Untracked" to stop tracking the account. |
UserInstitutionAccountStatus |
None. |
| FullAccountNumber |
Account's full account number. Account's full account number is retrieved after running GetFullAccountDetail job. |
string |
None. |
| RoutingNumber |
Account's routing number. |
string |
None. |
| InstitutionNumber |
Account's institution number. |
string |
None. |
| TransitNumber |
Account's transit number. |
string |
None. |
| OwnerName |
Account owner(s)' full name. |
string |
None. |
| Address |
Account owner(s)' address. |
string |
None. |
| InsuranceData |
Optional insurance data if this is an insurance account |
InsuranceData |
None. |
| CreditCardData |
Optional credit card data if this is an credit card account |
CreditCardData |
None. |
| LoanData |
Optional loan data if this is an loan account |
LoanData |
None. |
| SubType |
Account owner(s)' subtype. |
string |
None. |
| CashBalance |
Account's cash balance (Optional). |
decimal number |
None. |
Response Formats
application/json, text/json
[
{
"UserInstitutionID": "bcdb23f6-478b-42a5-b862-a8ae31597dce",
"AccountID": "c41b041e-4518-4329-a320-ef64f62cadca",
"AccountName": "sample string 3",
"AccountNumber": "sample string 4",
"AccountType": "sample string 5",
"Balance": 1.0,
"AvailableBalance": 1.0,
"BalanceCurrency": "sample string 6",
"LastUpdated": "2025-01-23T03:16:37.5105617+00:00",
"DueDate": "2025-01-23T03:16:37.5105617+00:00",
"Status": 0,
"FullAccountNumber": "sample string 7",
"RoutingNumber": "sample string 8",
"InstitutionNumber": "sample string 9",
"TransitNumber": "sample string 10",
"OwnerName": "sample string 11",
"Address": "sample string 12",
"InsuranceData": {
"InsuranceAccountID": "b7576949-2a63-4a08-a6cc-e043a9832e75",
"PremiumAmount": 1.0,
"BenefitAmount": 1.0,
"InsuredName": "sample string 2",
"CashValueAmount": 1.0,
"DeathBenefitAmount": 1.0,
"PremiumFrequency": "sample string 3",
"PolicyDate": "2025-01-23T03:16:37.5105617+00:00",
"MaturityDate": "2025-01-23T03:16:37.5105617+00:00",
"Beneficiary": "sample string 4",
"CashSurrenderValue": 1.0,
"PayOutAmount": 1.0
},
"CreditCardData": {
"AvailableCash": 1.0,
"AvailableCredit": 1.0,
"TotalCashLimit": 1.0,
"TotalCreditLine": 1.0,
"APR": 1.0,
"CashAPR": 1.0,
"RewardUnit": "sample string 1",
"RewardBalance": 1.0,
"RewardDescription": "sample string 2",
"EnrollmentDate": "2025-01-23T03:16:37.5105617+00:00",
"CurrentLevel": "sample string 3",
"NextLevel": "sample string 4",
"CreditCardAccountKey": "f214a199-3a81-438d-a78e-fee9966b5bb4"
},
"LoanData": {
"ReferenceNumber": "sample string 1",
"SequenceNumber": "sample string 2",
"Guarantor": "sample string 3",
"Lender": "sample string 4",
"LoanStatus": "sample string 5",
"OriginalLoanAmount": 1.0,
"PrincipalBalance": 1.0,
"RecurringPayment": 1.0,
"TotalCreditLimit": 1.0,
"OriginationDate": "2025-01-23T03:16:37.5105617+00:00",
"LoanPayoffAmount": 1.0,
"LoanPayByDate": "2025-01-23T03:16:37.5105617+00:00",
"LoanAccountKey": "f772edc7-8d51-47ba-a563-211002ef6ac4"
},
"SubType": "sample string 13",
"CashBalance": 1.0
},
{
"UserInstitutionID": "bcdb23f6-478b-42a5-b862-a8ae31597dce",
"AccountID": "c41b041e-4518-4329-a320-ef64f62cadca",
"AccountName": "sample string 3",
"AccountNumber": "sample string 4",
"AccountType": "sample string 5",
"Balance": 1.0,
"AvailableBalance": 1.0,
"BalanceCurrency": "sample string 6",
"LastUpdated": "2025-01-23T03:16:37.5105617+00:00",
"DueDate": "2025-01-23T03:16:37.5105617+00:00",
"Status": 0,
"FullAccountNumber": "sample string 7",
"RoutingNumber": "sample string 8",
"InstitutionNumber": "sample string 9",
"TransitNumber": "sample string 10",
"OwnerName": "sample string 11",
"Address": "sample string 12",
"InsuranceData": {
"InsuranceAccountID": "b7576949-2a63-4a08-a6cc-e043a9832e75",
"PremiumAmount": 1.0,
"BenefitAmount": 1.0,
"InsuredName": "sample string 2",
"CashValueAmount": 1.0,
"DeathBenefitAmount": 1.0,
"PremiumFrequency": "sample string 3",
"PolicyDate": "2025-01-23T03:16:37.5105617+00:00",
"MaturityDate": "2025-01-23T03:16:37.5105617+00:00",
"Beneficiary": "sample string 4",
"CashSurrenderValue": 1.0,
"PayOutAmount": 1.0
},
"CreditCardData": {
"AvailableCash": 1.0,
"AvailableCredit": 1.0,
"TotalCashLimit": 1.0,
"TotalCreditLine": 1.0,
"APR": 1.0,
"CashAPR": 1.0,
"RewardUnit": "sample string 1",
"RewardBalance": 1.0,
"RewardDescription": "sample string 2",
"EnrollmentDate": "2025-01-23T03:16:37.5105617+00:00",
"CurrentLevel": "sample string 3",
"NextLevel": "sample string 4",
"CreditCardAccountKey": "f214a199-3a81-438d-a78e-fee9966b5bb4"
},
"LoanData": {
"ReferenceNumber": "sample string 1",
"SequenceNumber": "sample string 2",
"Guarantor": "sample string 3",
"Lender": "sample string 4",
"LoanStatus": "sample string 5",
"OriginalLoanAmount": 1.0,
"PrincipalBalance": 1.0,
"RecurringPayment": 1.0,
"TotalCreditLimit": 1.0,
"OriginationDate": "2025-01-23T03:16:37.5105617+00:00",
"LoanPayoffAmount": 1.0,
"LoanPayByDate": "2025-01-23T03:16:37.5105617+00:00",
"LoanAccountKey": "f772edc7-8d51-47ba-a563-211002ef6ac4"
},
"SubType": "sample string 13",
"CashBalance": 1.0
}
]
application/xml, text/xml
Coming soon.