Skip to content

Configuring E-Visitor Authentication and Adapter

Required Components

  1. SFA Adapter release version 2.0.17 or above
  2. E-Visitor Authentication Adapter release version 2.0.2 or above

When importing and updating the UIP Configuration, make sure to import the file uip-sfa-eva-stb-integration.json to insert the triggers and workflows needed for communicating to the E-Visitor Adapter from the Kiosk. This also adds a new command to the SFA workflow used for detecting the face in a picture.

E-Visitor Adapter

Decide if you want to install the adapter on the Adapter Hub machine or the UIP.

The Hotel is to ensure that the E-Visitor Adapter machine has system has connectivity to the internet, and to be able to access https://api-test.stb.gov.sg and https://api.stb.gov.sg via port 443.

The Hotel’s IT Team and Development Team is to have access to TIH Development Portal https://tih-dev.stb.gov.sg.

Hoteliers are to assess the Visitor check-in loads at non-peak periods and peak periods to determine the required internet connection speed. STB would like to highlight there are 2 types of data exchange between Hotel and STB: Textual Data and Images.

E-Visitor Authentication Adapter Configuration

Follow the input and instructions on the E-Visitor Authentication Adapter page to configure and start the adapter.

Check the External checkbox if installing on an Adapter Hub.

Enter https://api.stb.gov.sg:443/services/eva/v1/visitors/transactions for the “E-Visitor Check-in API URL”.

Enter https://tih-api.stb.gov.sg:443/oauth/accesstoken for the “OAUTH Access Token API Host URL”.

Follow instructions inline for where to get the remaining values.

//

Kiosk Administrator Configuration for E-Visitor

  • Navigate to Kiosk Administrator -> Global Configuration -> External Validation.
    • Check “Enable External Validation” to turn on E-Visitor guest data send for the Kiosk Client.
    • Do not check "Enable Chip ID Card Reader".
    • Enter the webhook name for the E-Visitor Adapter trigger imported from the “uip-sfa-eva-stb-integration.json” file to the field “External Validation Webhook”.
      • The default name is “externalDocumentValidation”.
    • Enter the webhook name for the SFA adapter trigger imported from the “uip-sfa-eva-stb-integration.json” file to the field “Crop Person Face Webhook”.
      • The default name is “detectFace”.
    • Min Image Size (KB): Minimum image size accepted by the external validation system.
      • Default value is 10.
    • Max Image Size (KB): Maximum image size accepted by the external validation system.
      • Default value is 100.
    • Enlarge Cropping Percentage (%): Need to enlarge the cropped area because face match adapters (like SFA) return coordinates which strictly limit to the face features that are used in the face match (eyes, nose, mouth). We want that cropped image to contain the entire face though, so we need to enlarge the cropped area a little.
      • Default value is 60.

    • Exclude country codes (separated by semicolon): List of country codes to be excluded from external validation. Country codes in Alpha-2 or Alpha-3 format are used for this list.

      IMPORTANT

      To exclude local guests with Singapore country coming from scanned document, enter “SGP”.  STB only needs foreign guest information to be passed.