Web Services

Web Services allow administrators to integrate Instant ID as a service with external systems to enable real-time data exchange during enrollment.

Web Services support retrieving data from external systems and sending data back during enrollment processing. Web Services can be integrated during enrollment through configured Search, Read, and Write operations, as well as through step-level actions within the enrollment work-flow.

• Retrieve existing records from an external system
• Populate enrollment fields with external data
• Send updated credential data to external systems

Access Web Services

1. Click Main Menu > Administration.
2. Click Resources.
3. Click Web Services. The Web Services page appears.

Register a Web Service

1. Click the + icon.
2. The Register a Web Service configuration screen appears.

Configure Web Service

1. Web Service Name – Enter a unique name for the web service.

2. Method – Select the method (GET, POST, or PUT).

   • GET is used to retrieve data from an external system.
   • POST is used to send new data to an external system.
   • PUT is used to update existing records in an external system.

3. Web Service URL – Enter the endpoint URL provided by the external system.

4. Parameters – Configure parameters required by the endpoint:

   • Parameter Name – Specify the parameter key.
   • Default Value – Enter a default value.

     The default value is used to initially fetch fields for field connections and may also be used as part of the request payload sent to the external system.

5. Authentication – Select authentication type (for example, OAuth or Basic Authentication) and enter required credentials.

6. Click Save.

Web Service List

The Web Services page displays configured services in a table.

• Web Service Name – Displays the service name
• Web Service URL – Displays the endpoint
• Method – Displays the selected method
• Actions – Test Web Service or Delete

Enable Web Services in Enrollment Design

1. Click Main Menu > Enrollment Designs.
2. Select an enrollment design.
3. Click Settings.
4. In the Data Source Settings section, select Use Web Service.
5. Select the configured Web Service.
6. Select the Web Service type:
   • Search
   • Read
   • Write
7. Click Save.

Web Service Types

1. Search – Retrieves a list of records from the external system.
2. Read – Retrieves detailed data for a selected record.
3. Write – Sends updated data to the external system.

Web Service Integration in Workflow Steps

A Web Service call can be configured within a workflow step and triggered via an action button available at the bottom of the enrollment screen.

Key Details:

• The Web Service endpoint and the action button label are configurable within the Enrollment Design Step Configuration.
• The configured button will appear on the enrollment screen for that specific step.
• When clicked, the button will invoke the associated Web Service.

Constraints:

• Each workflow step supports a maximum of one Web Service call.

Field Connections

Field Connections map data between Web Services and Enrollment Design fields.

Configure Field Connections

1. Open the Field Connections page for the Enrollment Design linked to a web service.
2. Ensure the Source is set to Web Services.
3. Select a Web Service type:
   • Search Web Service
   • Read Web Service
   • Write Web Service
   • Step Action Web Service
   • Select the step with a configured Web Service
4. The Connect Fields from Source to Enrollment Design panel displays the available Web Service fields.
5. Map Web Service fields to Enrollment Design fields.
6. Map Parameter Mappings to Enrollment Design fields.
7. Click Save.

Web Service fields are automatically populated from the response body of the configured Web Service using default parameters.
• For Search Web Service, the first record in the response is used.
• For Read and Write Web Service, the response typically contains a single record and the full response is used.

• Enrollment Design will need proper steps in the workflow to capture and display the mapped fields. A Blank Step can be added for this use case.

Enrollment Workflow with Web Services

Web Services integrate with the enrollment process to retrieve and update data from external systems during enrollment.

1. Search

   The Enrollment Search page uses the Search Web Service to retrieve a list of records from the external system.

2. Read

   The Enrollment Credentials page uses the Read Web Service to retrieve detailed data for a selected record.

3. Write

   The Enrollment Credentials page uses the Write Web Service to send data to the external system. With a Write Web Service configured; while updating or viewing an enrollment record, the Write button replaces the Save button. This can be used to update a record or to retrieve data. The Write Web Service is also triggered on a Print. The response returned from the external system is used to update the enrollment fields dynamically.

4. Step Action Web Service

   On each step of the Enrollment Credentials page, a Step Action Web Service can be configured to send a request to the external system. With this configured, a button is added to the corresponding step. This can be used to update a record or to retrieve data. The response returned from the external system is used to update the enrollment fields dynamically.

Additional Notes