Documentation
  • Introduction
  • ⚡Quick Guide
  • APIs
    • 🇦🇪UAE Resident ID OCR
    • 🔑OAuth Token
    • 🆔National ID OCR
      • 🔁API Response
    • 🧑‍💼Face Match
      • Face Match (Two Images)
      • Face Match (Image & Transaction ID)
    • ✈️Passport
    • ✈️Libyan passport
    • 🚗Car License
    • ↔️Transliteration
      • National ID Transliteration
      • Commercial Register Translation
      • Names Transliteration
    • 🏫Know Your Business (eKYB)
      • 📖Data Extraction & Verifications
        • Egyptian Commercial Register ID OCR
          • ✅With Verification
        • Egyptian Tax Card OCR
    • 📄Valify Sanction Shield
      • Sanction Shield v2.1.0
    • Sanction Shield v2.0.0
    • 🛡️Supported lists
    • ❓Transaction Inquiry
    • 📷Fetch Images
    • 🔒OTP
      • 📲Send Phone OTP
      • ✅Verify Phone OTP
      • 📥Send Email OTP
      • ✅Verfiy Email OTP
    • Response Data Validation
  • Error Codes
    • Valify Error Codes
    • HTTP Codes
  • References
Powered by GitBook
On this page
  1. APIs

UAE Resident ID OCR

Request Payload:

jsonCopy codePOST /api/v1/ocr/
Content-Type: application/json

{
  "Document_type": "uae_resident_id",
  "bundle_key": "<string>",
  "img": "<base64-image>",
  "lang": "<string>"  // Optional field
}

Success Response:

jsonCopy code{
  "result": {
    "type": "<string>",
    "country": "<string>",
    "number": "<string>",
    "date_of_birth": "<string>",
    "expiration_date": "<string>",
    "nationality": "<string>",
    "sex": "<string>",
    "name": "<string>",
    "surname": "<string>",
    "optional1": "<string>",
    "personal_number": "<string>",
    "validity": <int>,
    "serial_number": "<string>"
  },
  "transaction_id": "<string>",
  "trials_remaining": <int>
}

Failed Response:

The error responses and error codes can be found in the Valify documentation.

PreviousAPIsNextOAuth Token

Last updated 4 months ago

🇦🇪