Auth

Learn about account details in a financial institution.

Attributes

The information in this table is for the financial institution response.

AttributeTypeDescription
accountsarray of objectsList of accounts, see Accounts object

Accounts object

The response information in the table below is for account values.

AttributeTypeDescription
idstringUnique ID
created_atdate-timeTimestamp when account was created in Truv
updated_atdate-timeTimestamp when account last updated in Truv
typestringAccount type
subtypestringAccount subtype
maskstringLast 4 digits of account number
nicknamestringDescription of account
providerstringData provider ID
provider_namestringData provider name
balancesobjectList of balance information, see Balances object
numbersobjectList of account numbers, see Numbers object

Balances object

View the table below for values from the balances object.

AttributeTypeDescription
currency_codestringCurrency
balancestringBalance amount
available_balancestringAvailable balance amount
credit_limitstringCredit limit

Numbers object

Each object has the type (ACH, RPT, OTHERS) and nested values from the table:

AttributeTypeDescription
account_numberstringA unique identifier assigned to a financial account for tracking and managing transactions, providing essential information for financial operations.
routing_numberstringA unique identifier for a financial institution. It is used to route and process transactions, ensuring accurate and secure transfers of funds.
is_tokenized_account_numberbooleanIndicates whether the account number has been tokenized by the institution, providing an additional layer of security for transactions.

Endpoints

Use the endpoint below for account information.

Example response

The sample below is a JSON response for the endpoint.

{
  "accounts": [
    {
      "id": "24d7e80942ce4ad58a93f70ce4115f5c",
      "created_at": "2022-05-04T11:30:00Z",
      "updated_at": "2022-05-04T12:00:00Z",
      "type": "CHECKING",
      "subtype": "MONEY_MARKET",
      "mask": "6789",
      "nickname": "My account",
      "is_open": true,
      "balances": {
        "currency_code": "USD",
        "balance": "100.00",
        "available_balance": "50.99",
        "credit_limit": "200.00"
      },
      "provider": "truv",
      "provider_name": "Truv Bank",
      "numbers": {
        "ACH": [
          {
            "account_number": "16002600",
            "routing_number": "123456789",
            "is_tokenized_account_number": true
          }
        ],
        "RTP": [
          {
            "account_number": "16002600",
            "routing_number": "123456789",
            "is_tokenized_account_number": true
          }
        ],
        "OTHERS": [
          {
            "account_number": "16002600",
            "routing_number": "123456789",
            "is_tokenized_account_number": true
          }
        ]
      }
    }
  ]
}