Usage

You can use this API to perform a government database check. Please ensure you have the government check is added and configured on your flow in order to be able to use this API for more information about government database check and how to configure it please refer to this page

Note: you can call this API to start new journey

Base URL by Region

The base URL you should use depends on the region where your services are hosted. Below are the available URLs for each region. By default, the EU region URL is used.

Authentication

Please refer to the API Credentials and Authentication page for more detailed information

Request Model

The request is a POST request with the following parameters sent in the body

Input Parameter	Description
journey_id	Type:* `string` `required` The id of the current journey.
step_id	Type:* `string` `required` The step id of the current step in the process, you can find the step id by selecting the step in Flow Builder .
government_check_fields	Type:* `object` `required` This field is used when the step is a government database check. The input fields to be able to perform the check in the government database. For more details about supported fields under this object this page

Request Response

200200

400400

401401

403403

404404

500500

503503