Journey Builder API

The Journey Builder APIs provide a comprehensive set of methods dedicated to the initiation and conclusion of complete identity verification journeys.

These APIs offer a high level of customization and control, allowing you to tailor the verification process to meet your specific business requirements.


Caution for Integration: Backend Use Only

Please refrain from using these APIs when integrating through client SDKs.

They are intended exclusively for backend-to-backend integration.

Check the following page to have more details about when to use each set of APIs

Sequence diagram for backend to backend integration

The following sequence chart illustrates the key steps involved in the backend-to-backend integration with IDWise Backend

Full Example

Here's a comprehensive example demonstrating how to implement the sequence diagram mentioned above.

Journey Builder APIs Overview

API NameDescription
Start JourneyStart a new interactive journey.
Process Journey StepProcess journey's step of the existing journey. you can use this API to submit additional face (i.e faces come from the government database) to be matched with already user submitted selfie or documents.
Complete JourneyIf you wish to finalize the journey and determine the system decision using the data provided thus far, you may utilize this API. However, please note that once this API is invoked, you will be unable to submit or modify any further steps.
Get Journey StatusGet the journey summary so far.