Usage

This API is used to process the full onboarding journey, which comprises both the ID verification step and the selfie verification step in a single request. It ensures that both steps are completed and returns a unique journey_id to track the verification process.

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.

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.

Authentication

For detailed authentication instructions, refer to the API Credentials and Authentication page.

Request Model

This API requires a POST request with the following parameters in the request body:

Input Parameter	Description
flow_id	Type: `string` (required) The unique identifier for the verification flow.
reference_no	Type: `string` (required) The reference number associated with this verification request.
id_front	Type: `file` (required) The image file for the front side of the document.
id_back	Type: `file` (optional) The image file for the back side of the document. If the document does not have a back side, this parameter can be omitted.
selfie	Type: `file` (optional) The image file for the user's selfie.

Response Model

Output Parameter	Description
success	Type: `bool` Indicates whether the request was successfully processed.
journey_id	Type: `string` The unique identifier for the verification journey. You can use this `journey_id` to retrieve processing results via the Get Journey Result API.

Error Handling

To effectively handle errors from this API, refer to our comprehensive Error Handling Guide. This page provides detailed explanations of error codes, their meanings, and best practices for handling them in your integration.

200Success

400Bad Request

401Bad Request