v2
latestOpenAPI 3.1.02026-08-083657125.0 KBDepositors
Update Depositor
patch/digital-banking/v1/depositors/{depositor_id}
Path parameters
depositor_idstring uuid required
Request body
first_namestring nullable
last_namestring nullable
entity_namestring nullable
institution_depositor_idstring nullable
depositor_type'CONSUMER' | 'BUSINESS' | 'NONPROFIT' | 'LOCAL_GOVERNMENT' | 'FEDERAL_GOVERNMENT' | 'US_DEPOSITORY' | 'FOREIGN_DEPOSITORY' | 'FOREIGN_GOVERNMENT'
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
approval_status'PENDING' | 'APPROVED' | 'REJECTED'
account_idsstring[] nullable
Account IDs to associate with this depositor. These are appended to existing associations.
institution_opt_out_federal_idsstring[] nullable
List of institutions (by federal_id) excluded from receiving this depositor's funds
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