Government-Issued ID – Q2 Documentation

Government ID types are found under the client.webapp.custom.properties Type ID. Below is an example of the configuration for a driver's license:

{
        "idType": "driversLicense",
        "allowPastExpiryDate": false,
        "allowFutureIssueDate": false,
        "label": "idTypeDriversLicense",
        "collectExpiryDate": true,
        "collectIssueDate": true,
        "collectState": true
},

To create another idType, you can copy the above configuration and tailor it to the new ID by changing the idType to another value specific to the new ID (for example, student ID card could be set to studentId) and creating a key message and corresponding message in the client.custom.messages.en and referenced in the label attribute (seen above).

Key	Description	Sample Value
`idType`	Variable name of this idType; used for core configuration.	`driversLicense`
`allowPastExpiryDate`	If set to false, the system will require that the expiration date be in the future for the applicant to continue	`false`
`allowFutureIssueDate`	If set to false, the system will require that the issue date be in the past for the applicant to continue	`false`
`label`	The key of the message that will be displayed in the ID Type drop down. The value of the message key will need to be entered in the `client.custom.messages.en`.	`idTypeDriversLicense`
`collectExpiryDate`	Prompt for an ID Expiration Date	`true`
`collectIssueDate`	Prompt for an ID Issue Date	`true`
`collectState`	Prompt for an ID State	`true`
`collectCountry`	Prompt for an ID Country	`true`

Configuration Value to Web Application Mapping

Front Driver's License Capture

You can enable the front of a driver’s license to be requested by the Gro platform. This change adds a page into the workflow after the Get Started page.

To enable this feature, update the client.webapp.custom.properties Type ID as follows:

{
    "primaryIdCapture":true,
      "jointIdCapture":true,
      "idTypes":[
      {
        "idType":"driversLicense",
        "imageRequiredChannel": [
          "web",
          "native"
        ],
              ...
      },
          {
        "idType":"stateId",
        "imageRequiredChannel": [
          "web",
          "native"
        ],
              ...
      }
      ]
  }

Front Driver's License Capture

IN THIS ARTICLE