API ReferenceDepositors

Create Depositor

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

idempotency-keystringRequired

Request

This endpoint expects an object.
tinstringRequired<=64 characters
TIN must be unique per institution
first_namestring or nullOptional<=32 characters
last_namestring or nullOptional<=32 characters
entity_namestring or nullOptional<=64 characters
is_organizationbooleanOptionalDefaults to false
internal_depositor_idstring or nullOptional<=64 characters
phone_numberslist of objects or nullOptional
emailslist of objects or nullOptional
addresseslist of objects or nullOptional
account_idslist of strings or nullOptional
depositor_typeenum or nullOptional
account_officerstring or nullOptional<=128 characters

Response

Successful Response
idstring
institution_idstring
institution_depositor_idstring or null
first_namestring or null
last_namestring or null
entity_namestring or null
is_organizationboolean
phone_numberslist of objects
emailslist of objects
addresseslist of objects
depositor_typeenum or null
account_officerstring or null
tinstring or nullDeprecated

Errors