Sign in

v1

latestOpenAPI 3.0.02026-07-241220330.3 KB
Bank Accounts

Get a single bank account, with historical and entity data, by unique token or identifier.

Retrieves a single bank account uniquely defined by a bank account token or external account identifier. Bank account tokens are alphanumeric characters that start with a prefix "A-". External account identifiers are strings provided by services or clients.

get/bank-accounts/{account_identifier_or_token}

Path parameters

account_identifier_or_tokenstring required

Token of bank account to get details for.

Query parameters

pagenumber
Example:2

The page of history results to return. Default is 1.

per_pagenumber
Example:1000

How many history results per page to return. Default/maximum is 1000.

Response

Returns the bank account matching bank account token.

account_tokenstring
timestampstring date-time

ISO 8601 timestamp of when the event occurred.

external_account_idstring

Your system's unique identifier for the bank account.

external_entity_idstring

Unique identifier of one of the Entities associated with the Account.

Not strictly required if the event is not being monitored, but recommended to include for future proofing your integration. This field has no impact on which Entities are attached to the Account, although it should match at least one of the Entities that the Account belongs to.

Click here for more information.

entity_tokenstring nullable

Alloy-issued token of the entity associated with this account.

account_class'credit' | 'deposit' | 'brokerage' | 'loan' nullable

The type of account. One of: credit, deposit (checking or savings), brokerage, loan.

account_namestring nullable

Descriptive name for the account.

account_numberstring

Account number, as it appears on statements or checks.

routing_numberstring nullable

The ABA routing number for the bank account.

opening_datestring date-time nullable

Date the account was opened.

maturity_datestring date-time nullable

Date the account matures (for term-based accounts such as CDs or loans).

closing_datestring date-time nullable

Date the account was or will be closed.

cif_numberstring nullable

Customer Information File (CIF) number linking this account to a customer record in your core banking system.

card_networkstring nullable

Payment card network associated with the account (e.g. Visa, Mastercard).

country_codestring nullable

2-letter country code for the account.

currencystring nullable

Currency of the account (e.g. USD).

product_codestring nullable

Internal product code identifying the account product type in your system.

product_namestring nullable

Human-readable name of the account product.

statusstring nullable

Current status of the account as defined in your system.

status_detailstring nullable

Free-form companion to the status field. Commonly used to communicate fraud labels on closed or restricted accounts (e.g. Fraud, potentialFraud, confirmedFraud). Any custom value is accepted.

credit_limitnumber nullable

Credit limit of the account, in cents.

account_balancenumber nullable

Current balance of the account, in cents.

account_type_status'Written Off' | 'Active' | 'Refinanced' | 'Past Due' | 'Paid Off' | 'Cancelled' nullable

Lifecycle status of the account from a credit or loan servicing perspective.

status_fraud'fraud' | 'not fraud' nullable

Indicates whether this account has been flagged as fraudulent. Set to fraud when the account is confirmed or suspected fraudulent, not fraud otherwise.

entity_group_tokenstring nullable

Alloy-issued token for the entity group associated with this account. When present, at least one entry in entities is required.

external_entity_group_idstring nullable

Your system's identifier for the entity group associated with this account. When present, at least one entry in entities is required.

Example response

{
  "account_token": "A-WO6WloK6odpcoxJkTKAt",
  "timestamp": "2024-06-01T12:00:00.000Z",
  "external_account_id": "acct-0a9b1c2d3e4f5a6b",
  "entity_token": "P-R21gUOQ8rwCvmx8tIscf",
  "account_class": "deposit",
  "account_name": "My Checking Account",
  "account_number": "123456789",
  "routing_number": "021000021",
  "opening_date": "2022-01-15T00:00:00.000Z",
  "maturity_date": "2027-01-15T00:00:00.000Z",
  "closing_date": "2025-06-01T00:00:00.000Z",
  "cif_number": "CIF-00123456",
  "card_network": "Visa",
  "country_code": "US",
  "currency": "USD",
  "product_code": "CHK-PREMIER",
  "product_name": "Premier Checking",
  "status": "active",
  "status_detail": "Fraud",
  "credit_limit": 500000,
  "account_balance": 12345,
  "account_type_status": "Active",
  "status_fraud": "not fraud",
  "entity_group_token": "EG-Xk3mR8pLqN2wYvT1cZsA",
  "external_entity_group_id": "group-acct-0012"
}