Process Custom Journey Step

Usage

If you want to perform an additional face match between the Selfie image and the government database face you can use this API to submit the government database.

You need to ask IDWise support at [email protected] team to enable this custom step. after enabling the custom step you will be provided the step_id, and step_type.

📘

Note

If you decided for any reason to not submit the government database face you need to explicitly complete the custom steps using this API.

Authentication

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

Supported Image Image

Here you can find more info about the supported image size and dimension

Request Content Types

This API supports two content types for submitting data:

  1. multipart/form-data (Preferred)
    Binary files are sent as multipart form fields alongside other textual/string fields. This is the recommended approach as it is more bandwidth-efficient.
  2. application/json
    All fields are submitted as a JSON payload. Binary files (image, image2) must be base64-encoded strings. Make sure to set the Content-Type header to application/json.
🚧

Base64 encoding binary data increases the payload size by approximately 33%. For large image files, this can significantly impact performance and bandwidth. Use multipart/form-data whenever possible.

Body Params
string
required

The id of the current journey.

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.

file
required

The image file for processing the current step.

Responses

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json