Sign in

v1

OpenAPI 3.1.02026-08-043657124.9 KB
Depositors

Get Depositor

get/digital-banking/v1/depositors/{depositor_id}

Path parameters

string uuid required
OR
string required

Query parameters

id_type'INSTITUTION'

Type of the account id. Institution accounts ids are external ids and come from the institution.

Type of the depositor id. Must be 'institution' or 'None'.

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