Web OCR API

This product provides a simple verification link that allows partner organizations to enable their users to capture and validate Egyptian National ID (NID) information through a fully web-based experience.

By implementing this solution, users can complete the NID capture and validation flow using Web OCR, and their verified data can be stored for any future verification needs.

This approach enhances operational efficiency, improves data accuracy, and offers a convenient alternative to integrating the mobile SDK, giving partners flexibility in how they deliver identity verification within their applications.

Integration Workflow

Step 1: Generate a verification link from the backend

POST https://verify.valifysolutions.com/api/link/v1/request/?lang=en

Headers

Name	Type	Description
Content-Type*	string	application/json
Authentication*	string	X-Valify-Api-Key (API Key for backend-to-backend API communications provided by Valify)

Request

Name	Type	Description
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.
flow (optional)	string	Valify-provided, optional unless multiple flows are configured.

Status Codes

✅200 Successful

{
    "session_token": "e5e6a438-8cdf-429e-ad80-f60480eed874",
    "redirect_url ": "https://verify.valifysolutions.com/?token=e5e6a438-8cdf-429e-ad80-f60480eed874"
}

400 Missing input data

401 Invalid bundle key

403 Access token error

404 Check the endpoint

415 The format should be base64

422 Check Valify error codes

500: Internal Server Error

500 Contact us

---

Integration

🚀Postman

3KB

Web OCR.postman_collection.json

Open

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:

1. Customer visits: https://verify.valifysolutions.com/?token=abc123.

2. They see an upload form and submit their card/document.

3. Verification is processed on Valify’s side.

4. Once done:

   1. Valify redirects the customer back to the return_url.

   2. Valify calls the client/partner webhook with the verification result.