OpenApi SpecContact Us
Guides
Start typing to search…

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

Property

Data Type (Max Length)

Tab Offset

Description

File Name

string (50)

0

The name of this request file excluding path.
Format: yyyyMMddhhmm_CUSTOMER.TXT
Example: 201410210148_CUSTOMER.TXT

Record Count

integer (10)

1

The number of records represented within the file. This field is zero-padded on the left side.
Example: 0000000872

File Created Date

datetime (34)

2

The 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 Date

datetime (34)

3

The 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

Property

Data Type (Max Length)

Tab Offset

Description

Customer ID

integer (10)

0

The customerId property of the customer object.

Tag

string (50)

1

The tag property of the customer object.

First Name

string (64)

2

The firstName property of the customer object.

Middle Name

string (64)

3

The middleName property of the customer object.

Last Name

string (128)

4

The lastName property of the customer object.

Suffix

string (20)

5

The suffix property of the customer object.

Birth Date

string (10)

6

The birthDate property of the customer object.
Format: yyyy-MM-dd
Example: 1986-07-12

Gender

string (1)

7

The gender property of the customer object.

Culture

string (50)

8

The culture property of the customer object.

Tax ID

string (30)

9

The taxId property of the customer object.

Status

string (50)

10

The status property of the customer object.

Created Date

datetime

11

The 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 Date

datetime

12

The 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 Date

datetime

13

The 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 Date

datetime

14

The 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 Date

datetime

15

The 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 Number

string (30)

16

The driversLicenseNumber property of the customer object.

Drivers License State

string (2)

17

The driversLicenseState property of the customer object.

Drivers License Issue Date

datetime

18

The 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 Date

datetime

19

The 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 Number

string (30)

20

The passportNumber property of the customer object.

Passport Country

string (5)

21

The passportCountry property of the customer object.

Passport Issue Date

datetime

22

The 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 Date

datetime

23

The 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 Address

string (255)

24

The emailAddress property of the customer object.

Is Subject To Backup Withholding

string (1)

25

The isSubjectToBackupWithholding property of the customer object.

  • Y: yes/true
  • N: no/false.

Is Opted In To Bank Communication

string (1)

26

The isOptedInToBankCommunication property of the customer object.

  • Y: yes/true
  • N: no/false.

Is Documents Accepted

string (1)

27

The isDocumentsAccepted property of the customer object.

  • Y: yes/true
  • N: no/false.

Documents Accepted Date

datetime

28

The 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 Locked

string (1)

29

The isLocked property of the customer object.

  • Y: yes/true
  • N: no/false.

Locked Date

datetime

30

The 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 Reason

string (255)

31

The lockedReason property of the customer object.

Residence Line 1

string (100)

32

The addressLine1 property of the address object with type=Residence for this customer.

Residence Line 2

string (100)

33

The addressLine2 property of the address object with type=Residence for this customer.

Residence Line 3

string (100)

34

The addressLine3 property of the address object with type=Residence for this customer.

Residence Line 4

string (100)

35

The addressLine4 property of the address object with type=Residence for this customer.

Residence City

string (50)

36

The city property of the address object with type=Residence for this customer.

Residence State

string (2)

37

The state property of the address object with type=Residence for this customer.

Residence Postal Code

string (50)

38

The postalCode property of the address object with type=Residence for this customer.

Residence Country

string (50)

39

The country property of the address object with type=Residence for this customer.

Mailing Line 1

string (100)

40

The addressLine1 property of the address object with type=Mailing for this customer.

Mailing Line 2

string (100)

41

The addressLine2 property of the address object with type=Mailing for this customer.

Mailing Line 3

string (100)

42

The addressLine3 property of the address object with type=Mailing for this customer.

Mailing Line 4

string (100)

43

The addressLine4 property of the address object with type=Mailing for this customer.

Mailing City

string (50)

44

The city property of the address object with type=Mailing for this customer.

Mailing State

string (2)

45

The state property of the address object with type=Mailing for this customer.

Mailing Postal Code

string (50)

46

The postalCode property of the address object with type=Mailing for this customer.

Mailing Country

string (50)

47

The country property of the address object with type=Mailing for this customer.

Home Phone

string (50)

48

The number property of the phone object with type=Home for this customer.

Mobile Phone

string (50)

49

The number property of the phone object with type=Mobile for this customer.

Office Phone

string (50)

50

The number property of the phone object with type=Office for this customer.

Custom Field 1

string (100)

51

The customField1 property of the customer object.

Custom Field 2

string (100)

52

The customField2 property of the customer object.

Custom Field 3

string (100)

53

The customField3 property of the customer object.

Custom Field 4

string (100)

54

The customField4 property of the customer object.

Custom Field 5

string (100)

55

The customField5 property of the customer object.

Last Activity Date

datetime

56

The lastActivityDate property of the customer object.

Customer Type

string (10)

57

Business or Individual

Business Legal Name

string (300)

58

The businessLegalName property of the customer object.

DBA

string (200)

59

The doingBusinessAs property of the customer object.

Legal Entity Type

string (100)

60

The legalEntityType property of the customer object.

NAICS Code

string (20)

61

The correspondingindustryCode associated with the customer via the customer's industryClassificationCodeId.

Primary Business Line 1

string (200)

62

The addressLine1 property of the address object with type=PrimaryBusiness for this customer.

Primary Business Line 2

string (200)

63

The addressLine2 property of the address object with type=PrimaryBusiness for this customer.

Primary Business Line 3

string (200)

64

The addressLine3 property of the address object with type=PrimaryBusiness for this customer.

Primary Business Line 4

string (200)

65

The addressLine4 property of the address object with type=PrimaryBusiness for this customer.

Primary Business City

string (100)

66

The city property of the address object with type=PrimaryBusiness for this customer.

Primary Business State

string (100)

67

The state property of the address object with type=PrimaryBusiness for this customer.

Primary Business Postal Code

string (100)

68

The postalCode property of the address object with type=PrimaryBusiness for this customer.

Primary Business Country

string (100)

69

The country property of the address object with type=PrimaryBusiness for this customer.

Tax Mailing Line 1

string (200)

70

The addressLine1 property of the address object with type=TaxFormMailing for this customer.

Tax Mailing Line 2

string (200)

71

The addressLine2 property of the address object with type=TaxFormMailing for this customer.

Tax Mailing Line 3

string (200)

72

The addressLine3 property of the address object with type=TaxFormMailing for this customer.

Tax Mailing Line 4

string (200)

73

The addressLine4 property of the address object with type=TaxFormMailing for this customer.

Tax Mailing City

string (100)

74

The city property of the address object with type=TaxFormMailing for this customer.

Tax Mailing State

string (100)

75

The state property of the address object with type=TaxFormMailing for this customer.

Tax Mailing Postal Code

string (100)

76

The postalCode property of the address object with type=TaxFormMailing for this customer.

Tax Mailing Country

string (100)

77

The country property of the address object with type=TaxFormMailing for this customer.

Tax ID Type

string (100)

78

ThetaxIdType property of the customer object.

Residency Status Type

string (200)

79

The residencyStatusType property of the customer object.

Foreign Document Number

string (30)

80

The foreignDocumentNumber property of the customer object.

Foreign Document Type

string (100)

81

The foreignDocumentType property of the customer object.

Foreign Document Country Code

string (3)

82

The foreignDocumentCountryCode property of the customer object.

Foreign Document Expiration Date

datetime

83

The foreignDocumentExpirationDate property of the customer object.

Take me to the Example Customer File

{ "file_type": "tab_delimited" }

Updated 22 days ago