Customer Registration File

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

  • Entered an Initiated status on that date -- registration was started, but abandoned before answering the challenge questions (if enabled for your program)
  • Marked as Expired on that date -- registration was never completed in the allowed timeframe (typically 14 days)
  • Marked as Denied on that date -- registration was completed but "too much" information was invalid, therefore a human does not need to review
  • Entered a Manual Review status on that date -- registration was completed but "some" information was invalid and a human must review
  • Remained in a Manual Review status the entire time during that date
  • Moved from Initiated to Verified status on that date -- registration was completed successfully without human review
  • Moved from Manual Review to Verified status on that date -- registration was completed successfully after a human reviewed it

iCustomers in this file with a status of Initiated, Verified, Expired or Denied 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 File for that day.

Customer Registration File Definition

The Customer Registration 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 /Customer
  8. File name follows a specific, case-sensitive pattern of: yyyyMMddhhmm_CUSTOMERREGISTRATION.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
FileNamestring (50)0The name of this request file excluding path.
Format: yyyyMMddhhmm_CUSTOMERREGISTRATION.TXT
Example: 201410210148_CUSTOMERREGISTRATION.TXT
RecordCountinteger (10)1The number of records represented within the file.
FileCreatedDatedatetime (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
FileEffectiveDatedatetime (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
CustomerIdinteger (10)0The customerId property of the customer object.
CustomerTagstring (50)1The tag property of the customer object.
FirstNamestring (64)2The firstName property of the customer object.
MiddleNamestring (64)3The middleName property of the customer object.
LastNamestring (128)4The lastName property of the customer object.
Suffixstring (20)5The suffix property of the customer object.
BirthDatestring (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.
CustomerStatusstring (50)10The status property of the customer object.
CreatedDatedatetime11The 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
ArchivedDatedatetime12The 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
IdVerificationDatedatetime13The idVerificationDate property of the customer object. Follows same format as API.
Example: 2014-10-20T23:59:59.999-05:00
See data format guidelines
IdVerificationDocumentsReceivedDatedatetime14The 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
DeniedDatedatetime15The date the customer registration was Denied. A Denied status can result from any of the following:
- The customer providing too much invalid information during initial registration
- An administrator reviewing a customer registration that entered the Manual Review process and denying the customer via the Admin Console.

Follows same format as API.
Example: 2014-10-20T23:59:59.999-05:00
See data format guidelines
ExpiredDatedatetime16The date the customer registration was Expired by Helix. An Expired status results from a customer beginning the registration process but never completing it after a given number of days, typically between 7 and 14. Follows same format as API. Example: 2014-10-20T23:59:59.999-05:00
See data format guidelines
DriversLicenseNumberstring (30)17The driversLicenseNumber property of the customer object.
DriversLicenseStatestring (2)18The driversLicenseState property of the customer object.
DriversLicenseIssueDatedatetime19The driversLicenseIssueDate property of the customer object. Follows same format as API.
Example: 2014-10-20T23:59:59.999-05:00
See data format guidelines
DriversLicenseExpireDatedatetime20The driversLicenseExpireDate property of the customer object. Follows same format as API. Example: 2014-10-20T23:59:59.999-05:00
See data format guidelines
PassportNumberstring (30)21The passportNumber property of the customer object.
PassportCountrystring (5)22The passportCountry property of the customer object.
PassportIssueDatedatetime23The passportIssueDate property of the customer object. Follows same format as API.
Example: 2014-10-20T23:59:59.999-05:00
See data format guidelines
PassportExpireDatedatetime24The passportExpireDate property of the customer object. Follows same format as API.
Example: 2014-10-20T23:59:59.999-05:00
See data format guidelines
EmailAddressstring (255)25The emailAddress property of the customer object.
IsSubjectToBackupWithholdingstring (1)26The isSubjectToBackupWithholding property of the customer object.
- Y: Yes/true
- N: No/false
IsOptedInToBankCommunicationstring (1)27The isOptedInToBankCommunication property of the customer object.
- Y: Yes/true
- N: No/false
IsDocumentsAcceptedstring (1)28The isDocumentsAccepted property of the customer object.
- Y: Yes/true
- N: No/false
DocumentsAcceptedDatedatetime29The date the customer accepted the documents. Follows same format as API.
Example: 2014-10-20T23:59:59.999-05:00
See data format guidelines
ResidenceLine1string (100)30The addressLine1 property of the address object associated with the Residence address for this customer.
ResidenceLine2string (100)31The addressLine2 property of the address object associated with the Residence address for this customer.
ResidenceLine3string (100)32The addressLine3 property of the address object associated with the Residence address for this customer.
ResidenceLine4string (100)33The addressLine4 property of the address object associated with the Residence address for this customer.
ResidenceCitystring (50)34The city property of the address object associated with the Residence address for this customer.
ResidenceStatestring (2)35The state property of the address object associated with the Residence address for this customer.
ResidencePostalCodestring (50)36The postalCode property of the address object associated with the Residence address for this customer.
ResidenceCountrystring (50)37The country property of the address object associated with the Residence address for this customer.
MailingLine1string (100)38The addressLine1 property of the address object associated with the Mailing address for this customer.
MailingLine2string (100)39The addressLine2 property of the address object associated with the Mailing address for this customer.
MailingLine3string (100)40The addressLine3 property of the address object associated with the Mailing address for this customer.
MailingLine4string (100)41The addressLine4 property of the address object associated with the Mailing address for this customer.
MailingCitystring (50)42The city property of the address object associated with the Mailing address for this customer.
MailingStatestring (2)43The state property of the address object associated with the Mailing address for this customer.
MailingPostalCodestring (50)44The postalCode property of the address object associated with the Mailing address for this customer.
MailingCountrystring (50)45The country property of the address object associated with the Mailing address for this customer.
HomePhonestring (50)46The number property of the phone object associated with the Home phone for this customer.
MobilePhonestring (50)47The number property of the phone object associated with the Mobile phone for this customer.
OfficePhonestring (50)48The number property of the phone object associated with the Office phone for this customer.
CustomField1string (100)49The customField1 property of the customer object.
CustomField2string (100)50The customField2 property of the customer object.
CustomField3string (100)51The customField3 property of the customer object.
CustomField4string (100)52The customField4 property of the customer object.
CustomField5string (100)53The customField5 property of the customer object.

{ "file_type": "tab_delimited" }