API Documentation

Customer Registration File

A listing of all potential Customers in CorePro 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
  • 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 an Initiated to Verified status on that date -- registration was completed successfully without human review
  • Moved from a Manual Review to Verified status on that date -- registration was completed successfully after a human reviewed it
i.e. Customers 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 the Customer File and the Customer Registration File for that day.

Customer Registration File Definition

This file is created by CorePro 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. Although most other files created and consumed by CorePro are fixed-length in nature, this file is tab-delimited to help reduce the size of file as it may grow considerably over time and possibly contains 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
    • The date in the file name is the creation date of the file. The data it contains will typically be from the end of the previous day.
    • For example, if the file name is 201501080015_CUSTOMERREGISTRATION.TXT, the data it contains will usually -- but not necessarily -- apply to Jan 7 2015.
    • Root-relative path on sftp.corepro.io for that file would be: /Customer/201501080015_CUSTOMERREGISTRATION.TXT

Format Disclaimer
Social Money 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
FileName string (50) 0 The name of this request file excluding path. Will be named following this pattern:
  1. yyyyMMddhhmm_CUSTOMERREGISTRATION.TXT
  2. Example: 201410210148_CUSTOMERREGISTRATION.TXT
RecordCount integer (10) 1 The number of records represented within the file.
FileCreatedDate datetime (34) 2 The date the file was created.
Follows same format as API e.g.: 2014-10-20T10:30:31.456-05:00. See date format details.
FileEffectiveDate datetime (34) 3 The date to which the data in the file pertains.
Follows same format as API e.g.: 2014-10-20T23:59:59.999-05:00. See date format details.

Content Row

Property Data Type (Max Length) Tab Offset Description
CustomerId integer (10) 0 The customerId property of the customer object.
CustomerTag string (50) 1 The tag property of the customer object.
FirstName string (64) 2 The firstName property of the customer object.
MiddleName string (64) 3 The middleName property of the customer object.
LastName string (128) 4 The lastName property of the customer object.
Suffix string (20) 5 The lastName property of the customer object.
BirthDate string (10) 6 The birthDate property of the customer object.
NOTE: Format is yyyy-MM-dd. e.g.: 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.
TaxId string (30) 9 The taxId property of the customer object.
CustomerStatus string (50) 10 The status property of the customer object.
CreatedDate datetime 11 The date the customer object was created and its status property set to Initiated.
Follows same format as API e.g.: 2014-10-20T23:59:59.999-05:00. See date format details.
ArchivedDate datetime 12 The date the status property of the customer object was changed to Archived
Follows same format as API e.g.: 2014-10-20T23:59:59.999-05:00. See date format details.
IdVerificationDate datetime 13 The idVerificationDate property of the customer object.
Follows same format as API e.g.: 2014-10-20T23:59:59.999-05:00. See date format details.
IdVerificationDocumentsReceivedDate datetime 14 The date documents required to verify the customer's identity were received.
Follows same format as API e.g.: 2014-10-20T23:59:59.999-05:00. See date format details.
DeniedDate datetime 15 The 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 e.g.: 2014-10-20T23:59:59.999-05:00. See date format details.
ExpiredDate datetime 16 The date the customer registration was Expired by CorePro
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 e.g.: 2014-10-20T23:59:59.999-05:00. See date format details.
DriversLicenseNumber string (30) 17 The driversLicenseNumber property of the customer object.
DriversLicenseState string (2) 18 The driversLicenseState property of the customer object.
DriversLicenseIssueDate datetime 19 The driversLicenseIssueDate property of the customer object.
Follows same format as API e.g.: 2014-10-20T23:59:59.999-05:00. See date format details.
DriversLicenseExpireDate datetime 20 The driversLicenseExpireDate property of the customer object.
Follows same format as API e.g.: 2014-10-20T23:59:59.999-05:00. See date format details.
PassportNumber string (30) 21 The passportNumber property of the customer object.
PassportCountry string (5) 22 The passportCountry property of the customer object.
PassportIssueDate datetime 23 The passportIssueDate property of the customer object.
Follows same format as API e.g.: 2014-10-20T23:59:59.999-05:00. See date format details.
PassportExpireDate datetime 24 The passportExpireDate property of the customer object.
Follows same format as API e.g.: 2014-10-20T23:59:59.999-05:00. See date format details.
EmailAddress string (255) 25 The emailAddress property of the customer object.
IsSubjectToBackupWithholding string (1) 26 The isSubjectToBackupWithholding property of the customer object.
NOTE: Y represents Yes (true) and N represents No (false)
IsOptedInToBankCommunication string (1) 27 The isOptedInToBankCommunication property of the customer object.
NOTE: Y represents Yes (true) and N represents No (false)
IsDocumentsAccepted string (1) 28 The isDocumentsAccepted property of the customer object.
NOTE: Y represents Yes (true) and N represents No (false)
DocumentsAcceptedDate datetime 29 The date the customer accepted the documents.
Follows same format as API e.g.: 2014-10-20T23:59:59.999-05:00. See date format details.
ResidenceLine1 string (100) 30 The addressLine1 property of the address object associated with the Residence address for this customer.
ResidenceLine2 string (100) 31 The addressLine2 property of the address object associated with the Residence address for this customer.
ResidenceLine3 string (100) 32 The addressLine3 property of the address object associated with the Residence address for this customer.
ResidenceLine4 string (100) 33 The addressLine4 property of the address object associated with the Residence address for this customer.
ResidenceCity string (50) 34 The city property of the address object associated with the Residence address for this customer.
ResidenceState string (2) 35 The state property of the address object associated with the Residence address for this customer.
ResidencePostalCode string (50) 36 The postalCode property of the address object associated with the Residence address for this customer.
ResidenceCountry string (50) 37 The country property of the address object associated with the Residence address for this customer.
MailingLine1 string (100) 38 The addressLine1 property of the address object associated with the Mailing address for this customer.
MailingLine2 string (100) 39 The addressLine2 property of the address object associated with the Mailing address for this customer.
MailingLine3 string (100) 40 The addressLine3 property of the address object associated with the Mailing address for this customer.
MailingLine4 string (100) 41 The addressLine4 property of the address object associated with the Mailing address for this customer.
MailingCity string (50) 42 The city property of the address object associated with the Mailing address for this customer.
MailingState string (2) 43 The state property of the address object associated with the Mailing address for this customer.
MailingPostalCode string (50) 44 The postalCode property of the address object associated with the Mailing address for this customer.
MailingCountry string (50) 45 The country property of the address object associated with the Mailing address for this customer.
HomePhone string (50) 46 The number property of the phone object asociated with the Home phone for this customer.
MobilePhone string (50) 47 The number property of the phone object asociated with the Mobile phone for this customer.
OfficePhone string (50) 48 The number property of the phone object asociated with the Office phone for this customer.
CustomField1 string (100) 49 The customField1 property of the customer object.
CustomField2 string (100) 50 The customField2 property of the customer object.
CustomField3 string (100) 51 The customField3 property of the customer object.
CustomField4 string (100) 52 The customField4 property of the customer object.
CustomField5 string (100) 53 The customField5 property of the customer object.

Example Customer Registration File

Content: See 201505030412_CUSTOMERREGISTRATION.TXT


NOTE: Your browser or text editor may wrap the text to fit the window or silently convert the delimiter tab characters to spaces. Actual source file does not wrap and has delimiter tab characters.

Ready to start a conversation?

Email Us