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 anArchived
status on that date - Changed from a
Verified
status to aDeceased
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:
- Exactly one tab-delimited header line
- Zero or more tab-delimited content lines
- A tab character (
\t
, or0x09
) embedded in actual text content will be replaced with a space character (" ", or0x20
) during file generation - 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.
- ANSI encoded
- Line endings are Windows-style CarriageReturn + LineFeed (
\r\n
, or0x0D0A
) - File will be available in the relative directory of
/CustomerFiles
- 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 theFileCreatedDate
orFileEffectiveDate
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
Property | Data Type (Max Length) | Tab Offset | Description |
---|---|---|---|
File Name | string (50) | 0 | The name of this request file excluding path. |
Record Count | integer (10) | 1 | The number of records represented within the file. This field is zero-padded on the left side. |
File Created Date | datetime (34) | 2 | The date the file was created. Follows same format as API. |
File Effective Date | datetime (34) | 3 | The date to which the data in the file pertains. Follows same format as API. |
Content Row
Property | Data Type (Max Length) | Tab Offset | Description |
---|---|---|---|
Customer ID | integer (10) | 0 | The |
Tag | string (50) | 1 | The |
First Name | string (64) | 2 | The |
Middle Name | string (64) | 3 | The |
Last Name | string (128) | 4 | The |
Suffix | string (20) | 5 | The |
Birth Date | string (10) | 6 | The |
Gender | string (1) | 7 | The |
Culture | string (50) | 8 | The |
Tax ID | string (30) | 9 | The |
Status | string (50) | 10 | The |
Created Date | datetime | 11 | The date the customer object was created and its |
Archived Date | datetime | 12 | The date the |
Deceased Date | datetime | 13 | The |
ID Verification Date | datetime | 14 | The |
ID Verification Documents Received Date | datetime | 15 | The date documents required to verify the customer's identity were received. Follows same format as API. |
Drivers License Number | string (30) | 16 | The |
Drivers License State | string (2) | 17 | The |
Drivers License Issue Date | datetime | 18 | The |
Drivers License Expire Date | datetime | 19 | The |
Passport Number | string (30) | 20 | The |
Passport Country | string (5) | 21 | The |
Passport Issue Date | datetime | 22 | The |
Passport Expire Date | datetime | 23 | The |
Email Address | string (255) | 24 | The |
Is Subject To Backup Withholding | string (1) | 25 | The
|
Is Opted In To Bank Communication | string (1) | 26 | The
|
Is Documents Accepted | string (1) | 27 | The
|
Documents Accepted Date | datetime | 28 | The date the customer accepted the documents. Will typically coincide with the |
Is Locked | string (1) | 29 | The
|
Locked Date | datetime | 30 | The |
Locked Reason | string (255) | 31 | The |
Residence Line 1 | string (100) | 32 | The |
Residence Line 2 | string (100) | 33 | The |
Residence Line 3 | string (100) | 34 | The |
Residence Line 4 | string (100) | 35 | The |
Residence City | string (50) | 36 | The |
Residence State | string (2) | 37 | The |
Residence Postal Code | string (50) | 38 | The |
Residence Country | string (50) | 39 | The |
Mailing Line 1 | string (100) | 40 | The |
Mailing Line 2 | string (100) | 41 | The |
Mailing Line 3 | string (100) | 42 | The |
Mailing Line 4 | string (100) | 43 | The |
Mailing City | string (50) | 44 | The |
Mailing State | string (2) | 45 | The |
Mailing Postal Code | string (50) | 46 | The |
Mailing Country | string (50) | 47 | The |
Home Phone | string (50) | 48 | The |
Mobile Phone | string (50) | 49 | The |
Office Phone | string (50) | 50 | The |
Custom Field 1 | string (100) | 51 | The |
Custom Field 2 | string (100) | 52 | The |
Custom Field 3 | string (100) | 53 | The |
Custom Field 4 | string (100) | 54 | The |
Custom Field 5 | string (100) | 55 | The |
Last Activity Date | datetime | 56 | The |
Customer Type | string (10) | 57 |
|
Business Legal Name | string (300) | 58 | The |
DBA | string (200) | 59 | The |
Legal Entity Type | string (100) | 60 | The |
NAICS Code | string (20) | 61 | The corresponding |
Primary Business Line 1 | string (200) | 62 | The |
Primary Business Line 2 | string (200) | 63 | The |
Primary Business Line 3 | string (200) | 64 | The |
Primary Business Line 4 | string (200) | 65 | The |
Primary Business City | string (100) | 66 | The |
Primary Business State | string (100) | 67 | The |
Primary Business Postal Code | string (100) | 68 | The |
Primary Business Country | string (100) | 69 | The |
Tax Mailing Line 1 | string (200) | 70 | The |
Tax Mailing Line 2 | string (200) | 71 | The |
Tax Mailing Line 3 | string (200) | 72 | The |
Tax Mailing Line 4 | string (200) | 73 | The |
Tax Mailing City | string (100) | 74 | The |
Tax Mailing State | string (100) | 75 | The |
Tax Mailing Postal Code | string (100) | 76 | The |
Tax Mailing Country | string (100) | 77 | The |
Tax ID Type | string (100) | 78 | The |
Residency Status Type | string (200) | 79 | The |
Foreign Document Number | string (30) | 80 | The |
Foreign Document Type | string (100) | 81 | The |
Foreign Document Country Code | string (3) | 82 | The |
Foreign Document Expiration Date | datetime | 83 | The |
Take me to the Example Customer File
Updated 16 days ago