External Account File

A listing of all External Accounts in Helix for a given program for all customers with these statuses (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

External Account File Definition

The External Account 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 /ExternalAccount
  8. File name follows a specific, case-sensitive pattern of: yyyyMMdd_EXTERNALACCOUNTEXPORT.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 (Length)Tab OffsetDescription
FileNamestring (50)0The name of this file excluding path.
Format: yyyyMMdd_EXTERNALACCOUNTEXPORT.TXT
Example: 20140716_EXTERNALACCOUNTEXPORT.TXT
RecordCountinteger (10)1The number of records represented within the file. This field is zero-padded on the left side.
Example: 0000000872
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-19T23:59:59.999-05:00
See data format guidelines

Content Row

PropertyData Type (Max Length)Tab OffsetDescription
ExternalAccountIdinteger (10)0The externalAccountId property of the externalAccount object.
CustomerIdinteger (10)1The customerId property of the externalAccount object.
Tagstring (50)2The tag property of the externalAccount object.
Namestring (50)3The name property of the externalAccount object.
RoutingNumberstring (10)4The routingNumber property of the externalAccount object.
RoutingNumberMaskedstring (10)5The routingNumberMasked property of the externalAccount object.
AccountNumberstring (17)6The accountNumber property of the externalAccount object.
AccountNumberMaskedstring (17)7The accountNumberMasked property of the externalAccount object.
Typestring (50)8The type property of the externalAccount object.
NickNamestring (50)9The nickName property of the externalAccount object.
Statusstring (20)10The status property of the externalAccount object.
StatusDatedatetime11The date the externalAccount object had a status change. Follows same format as API.
Example: 2014-10-20T23:59:59.999-05:00
See data format guidelines
LastModifiedDatedatetime12The date the externalAccount object was last modified. Follows same format as API.
Example: 2014-10-20T23:59:59.999-05:00
See data format guidelines
NOCCodestring (10)13The nocCode property of the externalAccount object.
IsActiveboolean14The isActive property of the externalAccount object.
IsLockedboolean15The isLocked property of the externalAccount object.
LockedDatedatetime16The date the externalAccount object was locked. Follows same format as API.
Example: 2014-10-20T23:59:59.999-05:00
See data format guidelines
LockedReasonstring (255)17The lockedReason property of the externalAccount object.
CustomField1string (50)18The customField1 property of the externalAccount object.
CustomField2string (50)19The customField2 property of the externalAccount object.
CustomField3string (50)20The customField3 property of the externalAccount object.
CustomField4string (50)21The customField4 property of the externalAccount object.
CustomField5string (50)22The customField5 property of the externalAccount object.
BusinessNamestring(100)23The name of the business to which the external account belongs

{ "file_type": "tab_delimited" }