Skip to content
English
Sign in
Submit a Service Request
  • There are no suggestions because the search field is empty.

IDgo "pre-enroll" batch file specification

This specification defines the format of a file shared with IDgo to pre-enroll users into id-go.

  • This file can be shared with IDgo by uploading it to IDgo’s secure FTP site

  • IDgo will issue a local user account to an enterprise specific secure FTP site

    • The account can be setup with a Username/Password and/or SSH keys

  • File should be Comma Separated Values

  • File should contain a header indicating the columns provided in the file.

    • “mobileNumber” is required

  • All values should be wrapped in double quotes

File Name specification

  • Format: “Preenroll-YYYY-MM-DD.csv”

    • Prefix of: Preenroll-

    • Followed by the year, example: 2023

    • Followed by a “-”

    • Followed by the month, example: 06

    • Followed by a “-”

    • Followed by the day, example: 01

    • Suffix of: .csv

  • Folder in the SFTP server should be: preenroll

  • Full example: preenroll/Preenroll-2023-06-25.csv

File Contents specification

File columns:

  1. mobileNumber - (E.164 formatted number). US mobile numbers should be prefixed with ‘+1’.

  2. fullName - The full name of the member (First middle last).

  3. additionalField1 - (Optional) additional fields with names of your choice can be provided. Additional fields can be configure to appear on the successful conclusion of an IDgo authentications. In this example we are using a fictitious field name of “additionalField1”. If your IDgo Agent instance has been configured to collect additional user information, confirm additional field names with the IDgo team.

Example

"mobileNumber","fullName","additionalField1" "+150300000001","John Doe","10101010101" "+150300000002","Jane Doe","20101010101"

File Encoding

File needs to be encoded with UTF-8.

Processing Results

A file will be created using the input file name with “.out” appended. This file will have line by line results for the processed file.

A new column “RC” will indicate the processing result:

0 = success
1 = System Error
2 = Already Enrolled
3 = Not a mobile number (the number provided is not a mobile number)
4 = Non-US numbers are not supported at this time. To detect this condition the country code prefix must be supplied in the mobileNumber column, otherwise it's assumed to be US (+1).