Customer File

A listing of all Customers in Helix for a given program with these qualities (as of the effective date of the file):

  • Moved to a Verified status on that date after successfully completing registration
  • Remained in a Verified status during the entire date
  • Changed from a Verified status to an Archived status on that date
  • Changed from a Verified status to a Deceased status on that date

i.e. Customers in this file with a status of Archived or Deceased will not appear in files for subsequent dates.
NOTE: On the day a customer is verified, he or she will appear in both this file and the Customer Registration File for that day.

Customer File Definition

The Customer File is created by Helix on a daily basis. It has the following properties:

  1. Exactly one tab-delimited header line
  2. Zero or more tab-delimited content lines
  3. A tab character (\t, or 0x09) embedded in actual text content will be replaced with a space character (" ", or 0x20) during file generation
  4. This file is tab-delimited to help reduce the size of file as it may grow considerably over time and possibly contain large sections of empty columns.
  5. ANSI encoded
  6. Line endings are Windows-style CarriageReturn + LineFeed (\r\n, or 0x0D0A)
  7. File will be available in the relative directory of /CustomerFiles
  8. File name follows a specific, case-sensitive pattern of: yyyyMMddhhmm_CUSTOMER.TXT

🚧

Format Disclaimer
Helix reserves the right to append new field(s) to the end of any Header or Content line without notice. This is to allow new data points to be added as needed in a timely fashion.

Implementation Note
Your code should be written such that unexpected characters after the "last" field but prior to the end of each line should be ignored. That is, if the file is documented as having 30 tabs per line, receiving a file with 31 or more per line should not disrupt your processing. This applies to both Header and Content lines.

File Name Disclaimer
The date in file name should be used as a guideline for human eyes only. Any date-related programmatic dependencies should rely on the FileCreatedDate or FileEffectiveDate contained within the header line of each file, as these will be precise to the second and will be in the appropriate timezone.

Header Row

PropertyData Type (Max Length)Tab OffsetDescription
File Namestring (50)0The name of this request file excluding path.
Format: yyyyMMddhhmm_CUSTOMER.TXT
Example: 201410210148_CUSTOMER.TXT
Record Countinteger (10)1The number of records represented within the file. This field is zero-padded on the left side.
Example: 0000000872
File Created Datedatetime (34)2The date the file was created. Follows same format as API.
Example: 2014-10-20T10:30:31.456-05:00
See data format guidelines
File Effective Datedatetime (34)3The date to which the data in the file pertains. Follows same format as API.
Example: 2014-10-20T23:59:59.999-05:00
See data format guidelines

Content Row

PropertyData Type (Max Length)Tab OffsetDescription
Customer Idinteger (10)0The customerId property of the customer object.
Tagstring (50)1The tag property of the customer object.
First Namestring (64)2The firstName property of the customer object.
Middle Namestring (64)3The middleName property of the customer object.
Last Namestring (128)4The lastName property of the customer object.
Suffixstring (20)5The suffix property of the customer object.
Birth Datestring (10)6The birthDate property of the customer object.
Format: yyyy-MM-dd
Example: 1986-07-12
Genderstring (1)7The gender property of the customer object.
Culturestring (50)8The culture property of the customer object.
TaxIdstring (30)9The taxId property of the customer object.
Statusstring (50)10The status property of the customer object.
Created Datedatetime11The date the customer object was created and its status property set to Initiated. Follows same format as API.
Example: 2014-10-20T23:59:59.999-05:00
See data format guidelines
Archived Datedatetime12The date the status property of the customer object was changed to Archived. Follows same format as API.
Example: 2014-10-20T23:59:59.999-05:00
See data format guidelines
Deceased Datedatetime13The deceasedDate property of the customer object. Follows same format as API.
Example: 2014-10-20T23:59:59.999-05:00
See data format guidelines
ID Verification Datedatetime14The idVerificationDate property of the customer object. Follows same format as API.
Example: 2014-10-20T23:59:59.999-05:00
See data format guidelines
ID Verification Documents Received Datedatetime15The date documents required to verify the customer's identity were received. Follows same format as API.
Example: 2014-10-20T23:59:59.999-05:00
See data format guidelines
Drivers License Numberstring (30)16The driversLicenseNumber property of the customer object.
Drivers License Statestring (2)17The driversLicenseState property of the customer object.
Drivers License Issue Datedatetime18The driversLicenseIssueDate property of the customer object. Follows same format as API.
Example: 2014-10-20T23:59:59.999-05:00
See data format guidelines
Drivers License Expire Datedatetime19The driversLicenseExpireDate property of the customer object. Follows same format as API.
Example: 2014-10-20T23:59:59.999-05:00
See data format guidelines
Passport Numberstring (30)20The passportNumber property of the customer object.
Passport Countrystring (5)21The passportCountry property of the customer object.
Passport Issue Datedatetime22The passportIssueDate property of the customer object. Follows same format as API.
Example: 2014-10-20T23:59:59.999-05:00
See data format guidelines
Passport Expire Datedatetime23The passportExpireDate property of the customer object. Follows same format as API.
Example: 2014-10-20T23:59:59.999-05:00
See data format guidelines
Email Addressstring (255)24The emailAddress property of the customer object.
Is Subject To Backup Withholdingstring (1)25The isSubjectToBackupWithholding property of the customer object.
- Y: yes/true
- N: no/false.
Is Opted In To Bank Communicationstring (1)26The isOptedInToBankCommunication property of the customer object.
- Y: yes/true
- N: no/false.
Is Documents Acceptedstring (1)27The isDocumentsAccepted property of the customer object.
- Y: yes/true
- N: no/false.
Documents Accepted Datedatetime28The date the customer accepted the documents. Will typically coincide with the IdVerificationDate. Follows same format as API.
Example: 2014-10-20T23:59:59.999-05:00
See data format guidelines
Is Lockedstring (1)29The isLocked property of the customer object.
- Y: yes/true
- N: no/false.
Locked Datedatetime30The lockedDate property of the customer object. Follows same format as API.
Example: 2014-10-20T23:59:59.999-05:00
See data format guidelines
Locked Reasonstring (255)31The lockedReason property of the customer object.
Residence Line 1string (100)32The addressLine1 property of the address object with type=Residence for this customer.
Residence Line 2string (100)33The addressLine2 property of the address object with type=Residence for this customer.
Residence Line 3string (100)34The addressLine3 property of the address object with type=Residence for this customer.
Residence Line 4string (100)35The addressLine4 property of the address object with type=Residence for this customer.
Residence Citystring (50)36The city property of the address object with type=Residence for this customer.
Residence Statestring (2)37The state property of the address object with type=Residence for this customer.
Residence Postal Codestring (50)38The postalCode property of the address object with type=Residence for this customer.
Residence Countrystring (50)39The country property of the address object with type=Residence for this customer.
Mailing Line 1string (100)40The addressLine1 property of the address object with type=Mailing for this customer.
Mailing Line 2string (100)41The addressLine2 property of the address object with type=Mailing for this customer.
Mailing Line 3string (100)42The addressLine3 property of the address object with type=Mailing for this customer.
Mailing Line 4string (100)43The addressLine4 property of the address object with type=Mailing for this customer.
Mailing Citystring (50)44The city property of the address object with type=Mailing for this customer.
Mailing Statestring (2)45The state property of the address object with type=Mailing for this customer.
Mailing Postal Codestring (50)46The postalCode property of the address object with type=Mailing for this customer.
Mailing Countrystring (50)47The country property of the address object with type=Mailing for this customer.
Home Phonestring (50)48The number property of the phone object with type=Home for this customer.
Mobile Phonestring (50)49The number property of the phone object with type=Mobile for this customer.
Office Phonestring (50)50The number property of the phone object with type=Office for this customer.
Custom Field 1string (100)51The customField1 property of the customer object.
Custom Field 2string (100)52The customField2 property of the customer object.
Custom Field 3string (100)53The customField3 property of the customer object.
Custom Field 4string (100)54The customField4 property of the customer object.
Custom Field 5string (100)55The customField5 property of the customer object.
Last Activity Datedatetime56The lastActivityDate property of the customer object.
Customer Typestring (10)57Business or Individual
Business Legal Namestring (300)58The businessLegalName property of the customer object
DBAstring (200)59The doingBusinessAs property of the customer object
Legal Entity Typestring (100)60The legalEntityType property of the customer object
NAICS Codestring (20)61The correspondingindustryCode associated with the customer via the customer's industryClassificationCodeId
Primary Business Line 1string (200)62The addressLine1 property of the address object with type=PrimaryBusiness for this customer.
Primary Business Line 2string (200)63The addressLine2 property of the address object with type=PrimaryBusiness for this customer.
Primary Business Line 3string (200)64The addressLine3 property of the address object with type=PrimaryBusiness for this customer.
Primary Business Line 4string (200)65The addressLine4 property of the address object with type=PrimaryBusiness for this customer.
Primary Business Citystring (100)66The city property of the address object with type=PrimaryBusiness for this customer.
Primary Business Statestring (100)67The state property of the address object with type=PrimaryBusiness for this customer.
Primary Business Postal Codestring (100)68The postalCode property of the address object with type=PrimaryBusiness for this customer.
Primary Business Countrystring (100)69The country property of the address object with type=PrimaryBusiness for this customer.
Tax Mailing Line 1string (200)70The addressLine1 property of the address object with type=TaxFormMailing for this customer.
Tax Mailing Line 2string (200)71The addressLine2 property of the address object with type=TaxFormMailing for this customer.
Tax Mailing Line 3string (200)72The addressLine3 property of the address object with type=TaxFormMailing for this customer.
Tax Mailing Line 4string (200)73The addressLine4 property of the address object with type=TaxFormMailing for this customer.
Tax Mailing Citystring (100)74The city property of the address object with type=TaxFormMailing for this customer..
Tax Mailing Statestring (100)75The state property of the address object with type=TaxFormMailing for this customer.
Tax Mailing Postal Codestring (100)76The postalCode property of the address object with type=TaxFormMailing for this customer.
Tax Mailing Countrystring (100)77The country property of the address object with type=TaxFormMailing for this customer.
Tax Id Typestring (100)78the taxIdType property of the customer object
Residency Status Typestring (200)79the residencyStatusType property of the customer object
Foreign Document Numberstring (30)80the foreignDocumentNumber property of the customer object
Foreign Document Typestring (100)81the foreignDocumentType property of the customer object
Foreign Document Country Codestring (3)82the foreignDocumentCountryCode property of the customer object
Foreign Document Expiration Datedatetime83the foreignDocumentExpirationDate property of the customer object

Take me to the Example Customer File

{ "file_type": "tab_delimited" }