Manual Journey Review

Usage

This API is used to approve or reject a KYC journey based on specific acceptance criteria set within your system.

Parameters

NameTypeNotes
journey_idstringPart of the path
new_decisionenumThe review decision for the journey. Possible values are:

- Rejected: The entire journey is rejected, typically when the applicant is not eligible for the service.
- Approved: The journey is approved in its current state, usually when the system’s flagged issues are minor and can be tolerated.
- Resubmission Requested: Specific steps are marked for resubmission. This applies when the applicant is eligible but needs to correct parts of the submission before it can be accepted.
commentstring
step_reviewslistIf new_decision is set to Resubmission Requested, this parameter becomes required.
It defines the list of user steps that must be resubmitted.
Each item in the list includes:

- step_id: The identifier of the step.
- review_decision: The updated decision for this step. Supported values are:
- Resubmit: The user must resubmit this step.
- Approve: The step is approved without requiring resubmission, even if it previously failed.When using Resubmission Requested, every step currently in a Failed state must be assigned a new decision (Resubmit or Approve). No step should remain in the Failed state.

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

Language
Credentials
Basic
base64
:
Click Try It! to start a request and see the response here!