Sign in
Depositors

Create Depositor

post/digital-banking/v1/depositors

Headers

idempotency-keystring required

Request body

tinstring required

TIN must be unique per institution

first_namestring nullable
last_namestring nullable
entity_namestring nullable
is_organizationboolean
institution_depositor_idstring nullable
account_idsstring[] 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
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

Changes

Changed in 1 of the 4 revisions of this API.1

  • d9c7bd6bd2f21See the full diff
    • ▲

      the request property's minLength was increased from 0 to 1

      request-property-min-length-increased