Configuring a Mobile ID Document Scanner

Adding a Mobile ID Document Scanner

  1. From the Administration menu, select Interfaces, and select ID Document Scanner.

  2. Click New.


    his is an image of the ID Document Scanners screen.
  3. Select the Property if signed in at Hub level. If signed in at property level, the Property field is populated by default.


    This is an image of the ID Document Scanner Configuration screen.
  4. Select the Scanner Type – Mobile radio button. If ID Document scanning for Desktop configuration already exists for the selected property, you are presented with the following warning message: Mobile scanner configuration for [Property Code] already exists. If you continue and save this new configuration it will overwrite the existing record.


    This is an image of a warning message popup.
  5. Enter the name of the partner into the ID Document Scanner field. This is a free text field.

  6. In the Communication section enter details provided by vendor:

    1. Scan URL – enter the full Scan API URL, including domain, port, and resource location. Example: https://domain.com:443/scan.

    2. Register URL – enter the full Register API URL, including domain, port, and resource location. Example: https://domain.com:443/client-register.

    3. Account ID– value provided by vendor if required for their service.

    4. Access Secret – value provided by vendor if required for their service.

    5. API Key – value provided by vendor if required for their service.


      This screen shows the Communication section.
  7. After entering all values provided by vendor in the Communication section. click Register to identify the property to the vendor and generate a security token if entered details are valid.


    This screen shows an information message.
  8. In the ID Type Mapping section, select the Identification Types configured in Administration > Client Relations > Geographic Management > Identification Types for the supportable ID Document Types displayed.

  9. Click Save.

Editing a Mobile ID Document Scanner

  1. From the Administration menu, select Interfaces, and select ID Document Scanner.

  2. Select the ID Document Scanner configuration entry that has the Mobile column checked.

  3. Click the vertical ellipsis and select Edit.

  4. The following fields are read only:

    1. Property

    2. Scanner Type

  5. You can modify the following fields:

    1. Inactive check box

    2. ID Document Scanner

    3. Scan URL

    4. ID Type Mappings

    5. Register URL

    6. Account ID

    7. Access Secret

    8. API Key

  6. If any of the Communication fields related to scan registration (including Register URL, Account ID, Access Secret, and API Key) have been updated, click Register to update the vendor registration and token.

  7. Click Save.

Deleting a Mobile ID Document Scanner

  1. From the Administration menu, select Interfaces, and select ID Document Scanner.

  2. Select the ID Document Scanner configuration entry that has the Mobile column checked.

  3. Click the vertical ellipsis and select Delete.

  4. Click Delete to confirm.

Inactivating a Mobile ID Document Scanner

  1. From the Administration menu, select Interfaces, and select ID Document Scanner.

  2. Select the ID Document Scanner configuration entry that has the Mobile column checked.

  3. Click the vertical ellipsis and select Edit.

  4. Select the Inactive check box in the upper right corner.

  5. Click Save.