v1

OpenAPI 3.1.02026-08-043657124.9 KB

Depositors

List Depositors

get/digital-banking/v1/depositors

Query parameters

namestring nullable

Search by first name, last name, or entity name (case-insensitive partial match).

Search by first name, last name, or entity name (case-insensitive partial match).

institution_depositor_idstring nullable

Filter by exact institution depositor ID.

Filter by exact institution depositor ID.

depositor_type'CONSUMER' | 'BUSINESS' | 'NONPROFIT' | 'LOCAL_GOVERNMENT' | 'FEDERAL_GOVERNMENT' | 'US_DEPOSITORY' | 'FOREIGN_DEPOSITORY' | 'FOREIGN_GOVERNMENT'

Filter by depositor type.

Response

Successful Response

idstring required

institution_idstring required

institution_depositor_idstring nullable required

tinstring nullable

tin_last_fourstring nullable

Last 4 digits of the TIN (masked).

first_namestring nullable required

last_namestring nullable required

entity_namestring nullable required

is_organizationboolean required

depositor_type'CONSUMER' | 'BUSINESS' | 'NONPROFIT' | 'LOCAL_GOVERNMENT' | 'FEDERAL_GOVERNMENT' | 'US_DEPOSITORY' | 'FOREIGN_DEPOSITORY' | 'FOREIGN_GOVERNMENT' required

ownership_category'JOINT' | 'SINGLE' | 'RETIREMENT' | 'ESTATE_REVOCABLE_TRUST' | 'OTHER_CONSUMER' | 'CORPORATION' | 'LIMITED_LIABILITY_COMPANY' | 'LIMITED_PARTNERSHIP' | 'SOLE_PROPRIETORSHIP' | 'OTHER_BUSINESS' | 'CLUBS_ASSOCIATIONS' | 'OTHER_NONPROFIT' | 'MUNICIPALITIES' | 'SCHOOL_DISTRICTS' | 'OTHER_LOCAL_GOVERNMENT' | 'US_GOVERNMENT' | 'US_DEPOSITORY'

account_officerstring nullable

notesstring nullable

institution_opt_out_federal_idsstring[]

List of institutions (by federal_id) excluded from receiving this depositor's funds