A customer represents a single end-user. Almost every action in Helix requires a customerId to identify for whom the action is being performed. To correlate a customer in Helix to a user in your system, you can:

  1. Pass your system's unique user ID into the tag property during customer creation. This allows you to use your system's ID to fetch the customer's Helix data via /customer/getByTag
  2. Capture and store the unique customerId returned by Helix after customer creation. You can then use /customer/Get to fetch the customer's Helix data.

customer Object

PropertyData Type (length)Description
accountsarrayAn array of account objects owned by the customer
addressesarrayAn array of address objects associated with the customer
attestationDate*datetimeDate the business information was attested to
attesterName*string (50)Name of the person attesting to the business' information
attesterTitle*string (50)Title of the person attesting to the business' information
birthDatedatetimeExample: 1976-07-04T00:00:00.000+00:00
businessDescription*string (200)Description of the business
businessLegalName*string (300)Legal name of the business
businessWebsite*string (100)Url of the business
cardsarrayAn array of card objects owned by the customer
createdDatedatetimeDate the customer was created. Note: a customer may have been created but not available for use, depending on the isLocked or status properties.
cultureenumAccepted values vary by program. Possible values:
- en-US: English
- es-US: Spanish
customerIdintegerThe Helix-assigned unique ID for a customer. Will be
returned via /customer/create . Used as a parameter to
almost every other Helix route
customField1string (50)A property for holding client-defined data. There is no
business logic in Helix for a custom field
customField2string (50)A property for holding client-defined data. There is no
business logic in Helix for a custom field
customField3string (50)A property for holding client-defined data. There is no
business logic in Helix for a custom field
customField4string (50)A property for holding client-defined data. There is no
business logic in Helix for a custom field
customField5string (50)A property for holding client-defined data. There is no
business logic in Helix for a custom field
doingBusinessAs*string (200)"DBA" or "Fictitious Business Name" of the business
deceasedDatedatetimeDenotes the date the customer was reported as deceased.
Example: 2014-01-01T00:00:00.000+00:00
driversLicenseExpireDatedatetimeDate the driver's license expires.
driversLicenseIssueDatedatetimeDate the driver's license was issued.
driversLicenseNumberstring (30)The identifying number from a government-issued driver's
driversLicenseNumberMaskedstringLast 4 digits of the driversLicenseNumber property value,
preceded by 6 '*'.
Example: ******1234
driversLicenseStatestring (2)State from which the driver's license is issued.
Example: CA
emailAddressstring (255)Example: [email protected]
exemptFromBeneficialOwnershipReasonType*enumThe reason the business is exempt from Beneficial Ownership. See customer.exemptFromBeneficialOwnershipType for more details.
Possible values:
- UsStockExchangeTradedEntity
- CharityOrNonProfitEntity
- PublicAccountingFirmRegisteredUnderSection102
- UsStateRegulatedBank
- UsRegulatedInsuranceCompany
- UsRegulatedFinancialInstitution
- UsFederalGovernmentAgency
- UsStateGovernmentAgency
- UsLocalGovernmentAgency
- NonUsGovernmentAgency
- BankHoldingCompany
- SavingsAndLoanHoldingCompany
- FinancialMarketUtility
- NonUsEntityOpeningAPrivateBankingAccount
- ForeignFinancialInstitution
- ClassOfSecuritiesIssuer
- SecCurrentRegisteredFirm
- CommodityFuturesTradingCommissionRegisteredEntity
- ExcludedPooledInvestmentVehicle
- NonExludedPooledInvestmentVehicle
- UsStockExchangeMajorityEquityEntity
externalAccountsarrayAn array of externalAccount objects owned by the customer
firstNamestring (64)First (given) name
formationDate*datetimeDate the business was originally registered
formationState*string (2)2-character state abbreviation of the state where the business was registered
genderenumPossible values:
- M: Male
- F: Female
- U: Unknown/Unspecified
industryClassificationCodeId*integerThe Helix-assigned unique ID for the industry a business operates in. See the industryClassificationCode object for more info.
isActivedeprecatedUse status instead
isBusinessbooleanIndicates whether the customer is a natural person or business entity.
isDocumentsAcceptedbooleanOnly required when creating a new customer. Confirms that customer viewed and accepted all documents returned via the /bankDocument/list route
isExemptFromBeneficialOwnership*booleanIndicates if the business is exempt from providing beneficial ownership information
isLockedbooleanDenotes if a customer is locked, typically caused by fraud prevention mechanisms or manual intervention via the admin console. A locked customer can not transfer any funds
isOptedInToBankCommunicationbooleanDenotes if customer opts in to receiving marketing
notifications from the bank. Note: customer may possibly still receive other required notifications from the bank regardless of this flag -- it depends on your program and the bank.
isSubjectToBackupWithholdingbooleanAll customers need to indicate whether they are subject to
backup withholding. Helix will withhold the appropriate
percentage of earned interest and submit these funds
directly to the IRS. The amount withheld will be reported on the annual 1099-INT generated by Helix. Please see the Backup Withholding topic at the IRS website for additional
isTaxExempt*booleanIndicates if the customer exempt from US taxes
lastActivityDatedatetimeTimestamp for the last time any action was performed on this customer. Actions include listing, editing, archiving,
closing, transferring funds, or otherwise "touching" any
data specific to this customer, whether it is via the API, a
Bulk Transfer Request file, or the Admin console
lastModifiedDatedatetimeDate when the object was last altered in any way
lastNamestring (128)Last name (surname)
legalEntityTypeenumPossible values:
- Individual
- Sole Proprietorship
- Partnership
- Limited Liability Partnership (LLP)
- Limited Liability Company (LLC)
- Single-member LLC
- Trust
- Estate
- Non-Profit
- Association
- Church
- Conservator
- Guardianship
- Government
- Cooperative
- S-Corporation
- C-Corporation
- B-Corporation
- Revocable Trust
- Irrevocable Trust
- Totten Trust (POD)
- Limited Partnership
- General Partnership
- Government Department
- Government Agency
- Government Authority
- Government non-commercial, non-US department or agency
- Government Other
- Regulated Financial Institution
- Regulated Bank Loan holdings Company
- Regulated Savings and Loan Holding Company
- Foreign Financial institution whose regulator maintains UBO information
- Financial institution - Other
lockedDatedatetimeDenotes the last time isLocked was set to true. Note: if isLocked is changed to false, this value will not reset.
Example: 2014-01-01T00:00:00.000+00:00
lockedReasonstringThe reason isLocked was set to true. Freeform. Note: if isLocked is changed to false, this value will not reset.
middleNamestring (64)
passportCountrystring (5)Country from which the passport is issued.
Example: US
passportExpireDatedatetimeDate the passport expires.
Example: 1976-07-04T00:00:00.000+00:00
passportIssueDatedatetimeDate the passport was issued.
Example: 1976-07-04T00:00:00.000+00:00
passportNumberstring (30)The identifying number from a government-issued passport
passportNumberMaskedstringLast 4 digits of the passportNumberMasked property, preceded by 6 '*'.
Example: ******1234
phonesarrayAn array of phone objects associated with the customer
residencyStatusTypeenumPossible values:
- USCitizen
- ResidentAlien
- NonResidentAlien
statusenumPossible values:
- Active
- Initiated
- Manual Review
- Verified
- Denied
- Expired
- Archived
- Deceased
suffixstring (20)A customer's name suffix. Examples:
- Sr.
- Esq.
- Ph.D
tagstring (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
taxIdstring (30)SSN in the US. Specify only the digits, no formatting (dashes, spaces, etc.) of any kind.
taxIdMaskedstringLast 4 digits of the taxId property, preceded by 6 '*'.
Example: ******1234
taxIdTypeenumPossible values:
- SSN: Social Security Number
- EIN: Employer Identification Number
- ITIN: Individual Taxpayer Identification Number

Note: A null value will be interpreted as SSN

*Property relates to business account functionality. Use of business account functionality requires approval from Q2 and your bank partner.