Web Verification Flow
This service provides a fully web-based verification experience that allows you to launch customized identity verification flows through a single API call. You can combine or enable different verification modules based on your needs, including Egyptian National ID OCR, face match, liveness detection, email OTP, and phone OTP.
To get started, please contact us to define and configure your required verification flow. Once the flow is set up and the API key is shared, you can use the API to generate a secure verification link. End users can open this link to complete the requested verification steps through a seamless web experience, without the need to integrate a mobile SDK.
Integration Workflow
Step 1: Generate a verification link from the backend
POST https://verify.valifysolutions.com/api/link/v1/request/?lang=en
Headers
Content-Type*
string
application/json
X-Valify-Api-Key*
string
API Key for backend-to-backend API communications provided by Valify
Request
return_url*
string
The URL to redirect to after verification is complete.
reference_id*
string
The unique identifier for this end user in your database.
expires_at*
date-time
Configurable expiration date for the link (eg. "2026-01-14T07:57:54.972Z")
flow (optional)
UUID
Valify-provided, optional unless multiple flows are configured.
Status Codes
{
"session_token": "e5e6a438-8cdf-429e-ad80-f60480eed874",
"redirect_url ": "https://verify.valifysolutions.com/?token=e5e6a438-8cdf-429e-ad80-f60480eed874"
}{
"message": "Bad Request – invalid request received (e.g. missing Bundle key, required parameters or invalid json) | Make sure all the required parameters are included"
}{
"message": "Unauthorized – your Bundle key is invalid"
}{
"message": "Forbidden – specified access_token could not be found"
}{
"message": "Not Found"
}{
"message": "Unsupported Media Type"
}{
"message": "<error-description>",
"error_code": <valify-error-code>
}Integration
Step 2: Customer Verification Page (Redirection Target)
Purpose:
This is the page hosted by Valify where the customer lands after the Integrator redirects them to the redirect_url.
Behavior:
The customer uploads their card details or required documents.
Valify handles the verification process (card validation, checks, etc.).
Once completed:
Valify redirects the customer back to the return_url provided by client/partner in the initiation request.
Valify also triggers the webhook (configured at the account level in Valify) with the verification result.
Example Flow:
Customer visits: https://verify.valifysolutions.com/?token=abc123.
They see an upload form and submit their card/document.
Verification is processed on Valify’s side.
Once done:
Valify redirects the customer back to the return_url.
Valify calls the client/partner webhook with the verification result.
Last updated