POST api/UserInstitutionAccount/GetUserInstitutionAccountByID

Get UserInstitutionAccount information by account ID

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
AccountID	Guid-type ID of the UserInstitutionAccount	globally unique identifier	None.

Request Formats

application/json, text/json

Sample:

{
  "AccountID": "85d1149f-be6b-45bd-a7a3-ab548d648e0d"
}

application/xml, text/xml

Sample:

Coming soon.

Response Information

Resource Description

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

Sample:

{
  "UserInstitutionID": "085a99af-b65b-449e-9c29-7cbd4ca1e687",
  "AccountID": "a8fe75c8-cbe5-48e0-b63f-7fc05009633e",
  "AccountName": "sample string 3",
  "AccountNumber": "sample string 4",
  "AccountType": "sample string 5",
  "Balance": 1.0,
  "AvailableBalance": 1.0,
  "BalanceCurrency": "sample string 6",
  "LastUpdated": "2025-06-01T15:13:41.9440749+00:00",
  "DueDate": "2025-06-01T15:13:41.9440749+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": "8a402b8b-b3d4-4859-8089-c48682c29079",
    "PremiumAmount": 1.0,
    "BenefitAmount": 1.0,
    "InsuredName": "sample string 2",
    "CashValueAmount": 1.0,
    "DeathBenefitAmount": 1.0,
    "PremiumFrequency": "sample string 3",
    "PolicyDate": "2025-06-01T15:13:41.9440749+00:00",
    "MaturityDate": "2025-06-01T15:13:41.9440749+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-06-01T15:13:41.9440749+00:00",
    "CurrentLevel": "sample string 3",
    "NextLevel": "sample string 4",
    "CreditCardAccountKey": "3105587e-f326-412e-84e7-7a2c2bc53083"
  },
  "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-06-01T15:13:41.9440749+00:00",
    "LoanPayoffAmount": 1.0,
    "LoanPayByDate": "2025-06-01T15:13:41.9440749+00:00",
    "LoanAccountKey": "71f005ec-e7ef-41b5-8bce-ac4a8c77048f"
  },
  "SubType": "sample string 13",
  "CashBalance": 1.0
}

application/xml, text/xml

Sample:

Coming soon.