Extract structured, typed JSON data from passports, driver's licenses, and national IDs for automated KYC, onboarding, and compliance checks.
Install & Download
1. ClawHub CLI
The fastest way to install a skill directly from the registry.
npx clawhub@latest install deepread-id-documents
2. Manual Installation
Copy the skill folder to one of these locations
~/.openclaw/skills/ <project>/skills/ Priority: Workspace > Local > Bundled
3. Prompt Installation
Copy this prompt to OpenClaw to install it automatically.
Help me install deepread-id-documents using Clawhub. If Clawhub is not installed, install it first (npm i -g clawhub).
Prefer to download?
Get the raw skill files in a ZIP archive.
What is DeepRead ID Documents?
DeepRead ID Documents is a powerful identity verification and document extraction tool designed to streamline user onboarding. By utilizing advanced vision AI, this capability transforms physical identity documents—such as passports, driver's licenses, and national ID cards—into highly structured, typed JSON data.
Integrating this skill as part of your Openclaw Skills workflow ensures high precision with field-level confidence checking. Each extracted item features a flag indicating if physical defects (like glare or worn text) require manual human review, providing a reliable compromise between automated efficiency and risk mitigation.
DeepRead ID Documents Use Cases
- KYC and Customer Onboarding: Automatically parse and verify identity fields from uploaded documents to speed up registrations.
- Age and Expiry Verification: Check dates of birth and detect expired or soon-to-expire documents programmatically.
- Account Recovery and Fraud Operations: Obtain reliable structured data for security workflows and secondary validation.
- Travel and Hospitality Check-In: Instantly capture passport and national ID details to remove friction from check-ins.
How DeepRead ID Documents Works
- Document Upload: The skill posts the image or scan of the ID document to the secure DeepRead API endpoint.
- Vision AI Processing: DeepRead's models parse the document, extracting identity details (names, dates, numbers, nationalities).
- Quality & Review Assessment: The engine assigns a confidence status and sets a 'needs_review' flag on any low-confidence fields.
- Structured JSON Output: A typed JSON response is returned containing the structured data, extraction locations, and warning flags.
- Post-Processing (Optional): Programmatic steps verify validity or trigger image redactions via PII endpoints.
DeepRead ID Documents Setup
Get started by signing up on the DeepRead dashboard and setting up your API keys:
# Open the dashboard to register and retrieve your API key
open "https://www.deepread.tech/dashboard/?utm_source=clawhub"
# Configure your API key as an environment variable
export DEEPREAD_API_KEY="sk_live_your_key_here"
To complement your workflow, you can also install the related Openclaw Skills, such as the PII redaction skill:
clawhub install uday390/deepread-pii
DeepRead ID Documents Data Schema & Taxonomy
The extracted output follows a clean, structured schema mapping key identity metadata fields:
| Field | Type | Description |
|---|---|---|
document_type |
string |
Passport, Driver's License, National ID, etc. |
full_name |
string |
Full name as printed on the document |
document_number |
string |
Unique document or license identifier |
date_of_birth |
string |
DOB format in ISO format (YYYY-MM-DD) |
issue_date |
string or null |
Issue date (YYYY-MM-DD) |
expiry_date |
string or null |
Expiry date (YYYY-MM-DD) |
nationality |
string or null |
ISO 3-letter nationality code if printed |
issuing_country |
string or null |
Issuing country or authority |
sex |
string or null |
Sex/gender if present on card |
DeepRead ID Documents Advanced Features
- Confidence-Based Flags: Individual fields indicate whether they need manual verification via the
needs_reviewproperty, allowing graceful handling of glare or physical damage. - PII Redaction Capabilities: Securely redact ID images post-extraction using the companion skill, ensuring GDPR and compliance requirements are met.
- Pre-Built Expiry Verification Logic: Easily run post-extraction scripts to calculate date-to-expiry margins and automatically flag invalid documents.
- Integrations with Openclaw Skills: Connect seamlessly with deepread-form-fill, deepread-pii, or deepread-ocr to build comprehensive, automated pipelines.
SKILL.md
Loading
Related Openclaw Skills
The Curse of Bigness
An executable toolkit inspired by Tim Wu's framework to analyze antitrust history, economic power concentration, and the modern legal battle against Big Tech monopolies.
Mobile Responsive Layout Fixer
An AI agent skill designed to help product teams diagnose, fix, and verify mobile responsiveness and navigation layout across devices.
USA Business Migration Planner
An automated assistant designed to migrate and configure user interface layouts, specifically helping developers manage the option to use Waffle menus or standard link displays.
OpenAPI Docs Generator
An AI-powered documentation agent that generates, enhances, and validates OpenAPI and Swagger documentation for REST APIs.
That Will Never Work (Netflix Origin AI Guide)
An interactive, execution-focused AI toolkit that teaches startup strategy, product pivots, and business survival using the real-world story of Netflix's co-founder.
The Gates of Europe (Ukrainian History Expert)
An interactive, AI-driven history toolkit based on Serhii Plokhy's acclaimed book to understand Ukraine's critical geopolitical role from ancient times to the modern Russian invasion.
Featured*
