addressLine1

string (100)

Customer beneficiary residential address line 1

addressLine2

string (100)

Customer beneficiary residential address line 2

addressLine3

string (100)

Customer beneficiary residential address line 3

addressLine4

string (100)

Customer beneficiary residential address line 4

birthDate

datetime

Customer beneficiary birth date
Format: yyyy-MM-ddT00:00:00.000+00:00
Example: 1976-07-04T00:00:00.000+00:00

city

string (50)

Customer beneficiary residential address city

country

string (50)

Must be US

createdDate

datetime

Date the customer was created. Note: a customer may have been created but not available for use, depending on theisLocked or status properties.

customerBeneficiaryId

integer

Helix-assigned unique ID for the customer beneficiary

customerId

integer

Helix-assigned unique ID for the customer to whom this
beneficiary belongs

distributionDescription

string (50)

Free-form description of the distribution

documentsAcceptedDate

string (1)

emailAddress

string (256)

Example: [email protected]

firstName

string (50)

First name of the beneficiary

isActive

boolean

Indicates whether the customer beneficiary is available for use

isDocumentsAccepted

boolean

Only required when creating a new customer. Confirms that customer viewed and accepted all documents returned via the /bankDocument/list route

lastModifiedDate

datetime

Date when the object was last altered in any way

lastName

string (50)

Last name of the beneficiary

legalName1

string (100)

Legal name (if beneficiary is not a person)

legalName2

string (100)

Legal name continued (if beneficiary is not a person)

middleName

string (50)

Middle name of the beneficiary

phoneNumber

string (15)

Customer beneficiary phone number

Numbers only, without hyphens

Example: 5152221212

Data cleansing should be performed on any invalid user input prior to sending to Helix

postalCode

string (9)

Customer beneficiary address postal code
U.S. numbers only, without hyphen

state

string (2)

Two-character code for U.S. state of beneficiary address

Example: CA

suffix

string (20)

A customer beneficiary' name suffix. Examples:

• Sr.
• Esq.
• Ph.D

tag

string (50)

A client-assigned unique identifier to represent exactly one customer in Helix in production. Sandbox does allow duplicate tags for testing. Typically represents the unique user ID in your system

taxId

string (50)

Social Security Number (SSN), Employer Identification Number (EIN) or Individual Taxpayer Identification Number (ITIN) of the beneficiary

Numeric characters only, no formatting (i.e., hyphens, spaces) of any kind

Example: 123456789

taxIdMasked

string

Tax ID of the beneficiary with all but the last 4
characters masked