Overview
The Process Journey Step API is designed to support the asynchronous handling of various stages in a user's journey. It is capable of processing different types of steps, such as ID document step, selfie step, and other custom steps that may be required for specific needs.
Usage Guidelines
- Start the Onboarding Journey: To use this API you must initiate a new user onboarding journey by sending a request to the API to process a journey step.
- Make an API Call: Submit the necessary image data and parameters for the journey step through this API. If there are multiple steps involved, repeat this process for each step.
- Monitor Processing Status: Since this API operates asynchronously, check the status of the processing step by using the Get Journey Summary API.
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:
- 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. - 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.
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.
- EU (Default): https://api.idwise.com/
- UAE: https://api-uae.idwise.com/
- Qatar: https://api-qat.idwise.com/
Authentication
For information on API credentials and the authentication process, please visit the API Credentials and Authentication page for comprehensive details.