Asks the end user to renew their KYC by resubmitting one or more steps of a completed journey.
Usage
Use this API to ask an end user to renew their KYC by resubmitting one or more steps of a completed journey, for example a document or a selfie. You choose which steps to renew and how many days the user has to complete the renewal.
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
journey_id | string | Yes | The ID of the journey to renew. |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
step_ids | array of integers | Yes | The IDs of the steps the user must resubmit. |
renewal_window_days | integer | Yes | How many days the user has to complete the renewal, from 1 to 60. The deadline is the end of the last day. |
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
Please refer to the API Credentials and Authentication page for more detailed information
Error Responses
All errors use this format:
{
"success": false,
"message": "Step 3 is not part of the journey.",
"request_id": "..."
}| HTTP Code | When |
|---|---|
| 400 | renewal_window_days is missing, is not a whole number, or is outside 1–60. |
| 400 | step_ids is missing or empty. |
| 400 | A step ID is not part of the journey, is a document back side, or was not completed (or was skipped). |
| 400 | The journey is not completed |
| 400 | One or more of the steps are already waiting for resubmission. |
| 401 | The API credentials are missing or invalid. |
| 403 | The API credentials do not have the Trigger KYC Renewal permission, or cannot access this journey. |
| 404 | The journey was not found. |
| 409 | The journey is being processed. Retry the request after a short delay. |
What Happens After the Request
- The selected steps are marked as waiting for resubmission. The user can resubmit them in the same journey through the SDK or the web flow.
- No re-KYC webhook is sent when the renewal starts, because your system requested it.
- Any scheduled renewals for the same steps (for example, a document expiry reminder) are replaced by this request.
- If the user does not resubmit before the deadline, you receive the ReKyc Deadline Exceeded webhook, as with scheduled renewals.
- Once the user resubmits, the journey is processed again and you receive the usual journey webhooks with the new result.
- The renewal appears in the journey timeline in the IDWise dashboard as KYC renewal requested manually.
Note: Renewing a step that is already waiting for resubmission is rejected. Wait until the user resubmits it or its deadline passes before you request a new renewal for that step.