Get Depositor | Modernfi

curl https://api.modernfi.com/digital-banking/v1/depositors/string \
     -H "Authorization: Bearer <token>"

{
  "id": "string",
  "institution_id": "string",
  "institution_depositor_id": "string",
  "first_name": "string",
  "last_name": "string",
  "entity_name": "string",
  "is_organization": true,
  "phone_numbers": [
    {
      "number": "string",
      "is_primary": true
    }
  ],
  "emails": [
    {
      "email_address": "string",
      "is_primary": true
    }
  ],
  "addresses": [
    {
      "street": "string",
      "city": "string",
      "state": "string",
      "zip": "string",
      "country_code": "string",
      "is_primary": true
    }
  ],
  "depositor_type": "CONSUMER",
  "tin_last_four": "string",
  "ownership_category": "JOINT",
  "account_officer": "string",
  "notes": "string",
  "institution_opt_out_federal_ids": [
    "string"
  ],
  "tin": "string"
}

Authentication

AuthorizationBearer

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

Path parameters

depositor_idstringRequired

Query parameters

id_typeenum or nullOptional

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

Allowed values:

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

tin_last_fourstring or null

Last 4 digits of the TIN (masked).

ownership_categoryenum or null

account_officerstring or null

notesstring or null

institution_opt_out_federal_idslist of strings

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

tinstring or nullDeprecated

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

422

Unprocessable Entity Error

500

Internal Server Error