Result Retrieval API

Introduction

Retrieve verification journey results and related images from your backend after a user completes an IDWise journey.

Use the Result Retrieval APIs to fetch processing outcomes for journeys created through the SDK or the Journey Control API. These APIs help your backend track journey status, retrieve final results, and download submitted or processed images.

Authentication

Authenticate Result Retrieval API requests from your backend using the credentials described in Credentials and Authentication.

AI integration prompt

You are an expert backend API integration engineer.

I am integrating the IDWise Result Retrieval APIs into my backend service to retrieve verification journey outcomes after an IDWise journey is completed.

Use the Result Retrieval API flow from this page and generate a backend implementation plan that includes:

1. Reading IDWise API credentials from backend environment variables or a secrets manager.
2. Accepting or looking up the journey ID produced by the SDK, Web SDK, or Journey Control API.
3. Calling the Get Journey Result API with JOURNEY_ID from the backend only.
4. Handling completed, failed, referred, pending, and error states without exposing credentials to the client.
5. Reading image paths from the journey result when image retrieval is required.
6. Calling the Get Image API with IMAGE_PATH from the backend only.
7. Returning only the minimum required result fields to the frontend.
8. Logging request IDs, error codes, and error messages for troubleshooting.
9. Avoiding retries that could overload the API; use webhook events or controlled polling when results are not ready.

Use these placeholders in the generated code:
- <IDWISE_API_KEY>
- <IDWISE_API_SECRET>
- <JOURNEY_ID>
- <IMAGE_PATH>

Return:
- A backend integration checklist.
- Secure environment variable setup.
- Complete backend code snippets for retrieving a journey result.
- Complete backend code snippets for retrieving an image.
- Error handling and logging guidance.
- Notes explaining which data can be safely returned to the frontend.

Do not call IDWise Result Retrieval APIs from browser, mobile, SDK, or client-side code. Do not invent API endpoints or authentication methods that are not shown in the IDWise documentation.

When to use this API

Use the Result Retrieval APIs when your backend needs to fetch journey outcomes or related images after a verification journey has started or completed.

These APIs apply regardless of whether the journey was created through the SDK or the Journey Control API.

Common use cases include:

• Journey result retrieval: Fetch journey details by JOURNEY_ID after your backend receives a webhook or needs to check the latest processing outcome.
• Image retrieval: Retrieve user-submitted images and images extracted or processed during the verification journey.
• Journey status monitoring: Track whether a journey is completed, referred, failed, or still processing.

Backend-only security requirements

🚧

Call Result Retrieval APIs from your backend only. Do not call them from browsers, mobile apps, SDK code, or any client-side environment.

Result Retrieval APIs rely on backend authentication credentials. If these credentials are exposed publicly, an attacker could retrieve data belonging to other users or submit unauthorized requests.

Store credentials in backend environment variables or a secrets manager, and return only the minimum required result fields to your frontend.

Result Retrieval APIs

Next steps

1. Configure backend authentication using Credentials and Authentication.
2. Retrieve a journey outcome with Get Journey Result.
3. Retrieve journey images with Get Image.