The ID Capture module captures the front and back of a government-issued ID, with auto-capture and quality checks, and produces clean images for processing.
Integrations
✅ Web | ✅ iOS | ✅ Android
How It Works
When the ID Capture module runs, the end user is prompted to present an identity document to their device camera. The module displays visual guidelines to help the user center the document in the frame and provides real-time feedback on framing, focus, and lighting.
By default, the module performs the following:
- Detects the document in the camera frame and applies alignment classification to confirm the ID is properly positioned before accepting the image.
- Automatically captures the front of the ID when image quality criteria are met (autocapture), with configurable timeouts and a configurable maximum number of attempts.
- Prompts the user to capture the back of the ID and, when applicable, reads the barcode on the back.
The module can also be configured to:
- Restrict accepted documents to a specific country or to a defined set of document types (for example, passports only).
- Allow the user to upload an existing image of their ID instead of capturing live, or to submit a digital ID from a device wallet.
- Capture only the front of the ID, only the back, or require both regardless of document type.
- Redact sensitive fields (such as document numbers or personal identifiers) from the captured images on a per-country, per-document-type basis.
Digital ID Wallet Verification
ID Capture supports Digital ID verification alongside physical document capture. Users can verify with a mobile driver's license (mDL) or other supported digital ID from Apple Wallet, Google Wallet, or Samsung Wallet, instead of photographing a physical ID.
Digital IDs are enabled per flow in the Dashboard. Once enabled, the wallet option appears automatically in the Hosted onboarding app's ID chooser, or can be launched from a custom UI using the Web SDK renderWallet API.
For the integration model, end-user experience, and recommended patterns, see Digital ID Wallet Verification.
For the full list of supported wallets, schemes, and attributes by region, see Supported Digital IDs.
Use ID Capture
For instructions on implementing and configuring ID Capture on each supported platform, use the following pages:
- ID Capture (Dashboard)
- ID Capture (iOS)
- ID Scan (Android)
- ID Capture Module (Web SDK)
- ID Scan (React Native)
- ID Scan (Flutter)
- Add ID (Cordova)
To view the end user experience screens and customization options for this module, see ID Capture: Design and UX.