v1.6.3
See below for our latest API changes. This release focuses on accounts and depositors: secure, on-demand TIN retrieval endpoints, a new List Depositors endpoint, a batch of new account and depositor fields, and a richer close-account response. We recommend reviewing this page closely before beginning development or upgrading to a new API version.
New Endpoints
TIN Retrieval — Dedicated endpoints to fetch full tax identification numbers on demand, so full TINs no longer need to be returned in standard account and depositor responses (those now expose only the last four digits).
GET /digital-banking/v1/depositors/{depositor_id}/tin— Retrieve a depositor’s full TIN.GET /digital-banking/v1/accounts/{account_id}/signer-primary-tin— Retrieve the primary signer’s full TIN for an account.GET /digital-banking/v1/accounts/{account_id}/beneficiary-tin— Retrieve the beneficiary’s full TIN for an account.
Depositors
GET /digital-banking/v1/depositors— List depositors for your institution, with optionalname,institution_depositor_id, anddepositor_typefilters.
Updated Endpoints
-
POST /digital-banking/v1/accounts(Create Account)- Added
signer_primary_tin(string, optional) — set the primary signer’s TIN at creation. - Added
account_officer(string, optional). - Added
is_non_interest_bearing(boolean, optional) — open a non-interest-bearing account. - Added
is_receiving_printed_statements(boolean, optional). - Added
custom_field_1–custom_field_4(string, optional) — free-form, institution-defined metadata.
- Added
-
PATCH /digital-banking/v1/accounts/{account_id}(Update Account)- Added
account_officerandcustom_field_1–custom_field_4(all optional).
- Added
-
POST /digital-banking/v1/depositors(Create Depositor)- Added
institution_opt_out_federal_ids(string array, optional) — institutions to exclude from reciprocation for this depositor.
- Added
-
PATCH /digital-banking/v1/depositors/{depositor_id}(Update Depositor)- Added
account_ids(uuid array, optional) — set the depositor’s linked accounts. - Added
institution_opt_out_federal_ids(string array, optional).
- Added
-
DELETE /digital-banking/v1/accounts/{account_id}(Close Account)- Now returns
200 OKwith aCloseAccountResponsebody (account_id,liquidation_amount,scheduled_to_close_date) instead of204 No Content. Clients that treat any 2xx as success are unaffected; those that checked specifically for204should update accordingly, and can now read the liquidation amount and scheduled close date directly from the response.
- Now returns
Schema Changes
-
AccountResponse— added metadata and TIN fields:is_non_interest_bearing(boolean),account_officer(string, nullable),cost_center_id/cost_center_code(nullable), andcustom_field_1–custom_field_4(nullable).signer_primary_tin_last4andbeneficiary_tin_last4(string, nullable) — last four digits of the relevant TINs; use the new TIN endpoints for full values.
-
DepositorResponse- Added
tin_last_four(string, nullable) — last four digits of the depositor’s TIN; useGET /digital-banking/v1/depositors/{depositor_id}/tinfor the full value. - Added
institution_opt_out_federal_ids(string array).
- Added
-
New schemas:
AccountTINResponse,DepositorTINResponse,CloseAccountResponse