Customer Account Access File

A listing of all customers with access to accounts for a given program. Includes account information, the account access type, and for business customers, the relationship of the individual to the business customer.

Customer Account Access File Definition

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

  1. Tab-delimited
  2. File will be available in the relative directory of /CustomerFiles
  3. File name follows a specific, case-sensitive pattern of: yyyyMMddhhmm_CUSTOMERACCOUNTACCESS.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_CUSTOMERACCOUNTACCESS.TXT
Example: 201410210148_CUSTOMERACCOUNTACCESS.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.
Primary Customer Tagstring (50)1Optional. User-assigned identifier for the primary owner of the account.
Related Customer Idinteger (10)2Optional. Helix-assigned unique ID for the secondary owner of the account.
Related Customer Tagstring (50)3Optional. User-assigned identifier for the secondary owner of the account.
Customer Relationship Typestring (50)4Optional. Relationship between the primary owner and secondary owner of the account.
For a business account, see the relationshipType property of the customer relationship object for values.
For a joint owners account, the value is Joint.
For a minor account, the value is Child.
Entitlementstring (50)5Optional. The description of the 'entitlement` property of the account entitlement object (i.e., FullAccess).
Account Idinteger (10)6The accountID property of the account object.
Product Idinteger (10)7The productID property of the account object.
Account Tagstring (50)8Optional. User-assigned identifier for the account.
Account Numberstring (50)9The accountNumber property of the account object.
Account Namestring (50)10The name property of the account object.
Account Typestring (50)11The type property of the account object.
Account Statusstring (50)12The status property of the account object.
Account Balancestring (50)13The accountBalance property of the account object.
Close Datedatetime (34)14Optional. The closedDate property of the account object.

{ "file_type": "tab_delimited" }