KwikID DocumentationIndex
Verification APIs and Machine Learning APIs with details
API Suite Index
📦 Download Complete API Documentation (ZIP)
Bulk testing (Playground): Several Machine Learning endpoints support Bulk mode in the interactive Playground: you upload one .zip of many requests, the browser runs them in order, then you get a results archive (per-call JSON plus a spreadsheet summary where applicable). The flow is the same idea wherever Bulk appears, even if file naming or payload shape differs by API. For a full walkthrough with screenshots, see Sample bulk testing (Facematch). In the left sidebar, endpoints that currently expose Bulk in the playground show a small Bulk tag next to the link.
Verification APIs
| Title | Description | Use Case | Input Type | Response Format | Authentication | Status | Video URL |
|---|---|---|---|---|---|---|---|
| DigiLocker | Verification APIs help you to verify an individual or an entity's identity such Aadhaar, PAN, Driving, Passport, DigiLocker etc. | DigiLocker-based eKYC | JSON | JSON | Bearer Token | ✅ | Watch |
| Aadhaar OVSE | Offline Aadhaar verification via the UIDAI Aadhaar App. Resident authenticates in-app; KwikID decodes the SD-JWT callback. | Consent-based offline Aadhaar | JSON | JSON | Bearer Token | ✅ | |
| PAN | Verification APIs help you to verify an individual or an entity's identity such as Aadhaar, PAN, Driving License, Passport, DigiLocker, etc. | PAN verification (OTP) | JSON | JSON | Bearer Token | ✅ | Watch |
| ITR | Verification APIs help you to verify an individual or an entity's identity such Aadhaar, PAN, Driving, Passport, DigiLocker, ITR etc. | Fetch ITR data | JSON | JSON | Bearer Token | ✅ | Watch |
| PAN-Aadhaar Link | Verification APIs help you to verify an individual or an entity's identity such Aadhaar, PAN, Driving, Passport, DigiLocker etc. | Check PAN-Aadhaar link status | JSON | JSON | Bearer Token | ✅ | Watch |
| Driving License | Verification APIs help you to verify an individual or an entity's identity such Aadhaar, PAN, Driving, Passport, DigiLocker etc. | DL verification | JSON | JSON | Bearer Token | ✅ | Watch |
| V3 Driver's License Verification | Performs Driver's License details verification via KwikID. | Driver's License verification | JSON | JSON | Bearer Token | ✅ | |
| Aadhaar E-Sign | Verification APIs help you to verify an individual or an entity's identity such Aadhaar, PAN, Driving, Passport, DigiLocker etc. | Document signing via Aadhaar | File (form-data) | JSON / File URL | Bearer Token | ✅ | Watch |
| Custom E-sign | Custom Esign (self-signing) | Self-signing documents | File (form-data) | JSON (base64) / JSON | Bearer Token | ✅ | Watch |
| CKYC Search | CKYC Search | Search CKYC records | JSON | JSON | Bearer Token | ✅ | Watch |
| CKYC Download V2 | CKYC download V2 | Download CKYC data | JSON | JSON | Bearer Token | ✅ | Watch |
| GST | Verification APIs help you to verify an individual or an entity's identity such Aadhaar, PAN, Driving, Passport, DigiLocker etc. | Verify GSTIN details | URL Parameter | JSON | Bearer Token | ✅ | Watch |
| Udyam | Verification APIs help you to verify an individual or an entity's identity such Aadhaar, PAN, Driving, Passport, DigiLocker etc. | Verify Udyam registration | URL Parameter | JSON | Bearer Token | ✅ | Watch |
| V3 Udyam Verification | Performs Udyam Registration verification without OTP using KwikID. | Verify Udyam registration | JSON | JSON | Bearer Token | ✅ | |
| Udyog | Verification APIs help you to verify an individual or an entity's identity such Aadhaar, PAN, Driving, Passport, DigiLocker etc. | Verify Udyog registration | URL Parameter | JSON | Bearer Token | ✅ | Watch |
| V3 Shop and Establishment Verification | Verifies Shop and Establishment registration details using the KwikID API. | Shop and Establishment verification | JSON | JSON | Bearer Token | ✅ | |
| V3 TAN Verification | Performs TAN details verification via KwikID. | TAN verification | JSON | JSON | Bearer Token | ✅ | |
| V3 TIN Fetch | Fetches TIN (Taxpayer Identification Number) registration details via KwikID. | TIN fetch | JSON | JSON | Bearer Token | ✅ | |
| IFSC | The Indian Financial System Code is an 11-digit alpha-numeric code used to identify the bank branch. | Verify IFSC code details | URL Parameter | JSON | Bearer Token | ✅ | Watch |
| Electricity Bill | Verification APIs help you to verify an individual or an entity's identity such Aadhaar, PAN, Driving, Passport, DigiLocker etc. | Verify electricity bill | URL Parameters | JSON | Bearer Token | ✅ | Watch |
| V3 Electricity Bill Verification | Authenticates electricity bill details for a consumer using KwikID. | Verify electricity bill | JSON | JSON | Bearer Token | ✅ | |
| Gas Bill | Verification APIs help you to verify an individual or an entity's identity such Aadhaar, PAN, Driving, Passport, DigiLocker etc. | Verify gas bill | URL Parameters | JSON | Bearer Token | ✅ | Watch |
| Verify CVLKRA | Verification APIs help you to verify an individual or an entity's identity such Aadhaar, PAN, Driving, Passport, DigiLocker etc. | Verify KRA status via PAN | JSON | JSON | Bearer Token | ✅ | Watch |
| Verify EPF | Verification APIs help you to verify an individual or an entity's identity such Aadhaar, PAN, Driving, Passport, DigiLocker etc. | Fetch EPF details (OTP) | JSON | JSON | Bearer Token | ✅ | Watch |
| V3 EPF UAN Validation | Fetches employment history for a given UAN via KwikID. | EPF UAN validation | JSON | JSON | Bearer Token | ✅ | |
| MCA Company Search | Verification APIs help you to verify company details from Ministry of Corporate Affairs (MCA) registry. | Search MCA company by name | JSON | JSON | Bearer Token | ✅ | Watch |
| MCA Master Data | Verification APIs help you to fetch master data for a company from MCA (company name, CIN, status, capital, address, contact, etc.). | Fetch MCA company master data | URL Parameter | JSON | Bearer Token | ✅ | Watch |
| Bank Account (Penny Drop) | Verification APIs help you to verify bank account details (account number, name, IFSC) via penny drop. | Verify bank account via penny drop | JSON | JSON | Bearer Token | ✅ | Watch |
| Passport Verification | Verification APIs help you to verify an individual's passport details (passport number, DOB, DOI, file number) with consent. | Passport verification | JSON | JSON | Bearer Token | ✅ | Watch |
| V3 Passport Verification | Performs Passport validity and details verification via KwikID. | Passport verification | JSON | JSON | Bearer Token | ✅ | |
| Voter ID Verification | Verification APIs help you to verify an individual's EPIC (Voter ID) number against national electoral records. | Voter ID (EPIC) verification | JSON | JSON | Bearer Token | ✅ | Watch |
| V3 Voter ID Verification | Performs Voter ID card EPIC details verification via KwikID. | Voter ID verification | JSON | JSON | Bearer Token | ✅ |
Machine Learning APIs
| Title | Description | Use Case | Input Type | Response Format | Authentication | Status | Video URL |
|---|---|---|---|---|---|---|---|
| Aadhaar Masking | Advanced Aadhaar data protection with intelligent masking technology. Ensures regulatory compliance while maintaining document integrity. | Data protection & compliance | File (form-data) | JSON | Bearer Token | ✅ | Watch |
| Facematch | Sophisticated facial recognition with precise biometric authentication. Delivers accurate identity verification through advanced matching algorithms. | Face verification & biometrics | File (form-data) | JSON | Bearer Token | ✅ | Watch |
| Advanced Facematch | Structured response: presentation checks per image, optional pairwise compare (image1_image2_facematch), overall_result / overall_confidence. image2 optional. | Face verification & biometrics | File (form-data) | JSON | Bearer Token | ✅ | Watch |
| Namematch | This API provides a similarity score between two names or strings. | Name matching & validation | JSON | JSON | Bearer Token | ✅ | Watch |
| Aadhaar Front OCR | Extracts details like Aadhaar Number, Aadhaar Validity, Gender, DOB, Name from the front side of Aadhaar Card. | Document OCR | File (form-data) | JSON | Bearer Token | ✅ | Watch |
| Aadhaar Back OCR | Extracts details like Aadhaar Address, Aadhaar Number, Aadhaar Validity from the back side of Aadhaar Card. | Document OCR | File (form-data) | JSON | Bearer Token | ✅ | Watch |
| PAN OCR | Extracts details like Pan Number, Father Name, Name, DOB from the Pan Card. | Document OCR | File (form-data) | JSON | Bearer Token | ✅ | Watch |
| Passport Front | Extracts details like Passport Number, DOB, Date of Expiry, Date of Issue, Name, Nationality, Place of Birth, Sex, Surname from the front side of Passport. | Document OCR | File (form-data) | JSON | Bearer Token | ✅ | Watch |
| Passport Back | Extracts details like Father Name, Mother Name, Spouse Name, Address, Passport Number from the back side of Passport. | Document OCR | File (form-data) | JSON | Bearer Token | ✅ | Watch |
| Liveness Detection | Detect liveness using image and/or video with enhanced multi-frame analysis and face matching capabilities. | Face verification & biometrics | File (form-data) | JSON | Bearer Token | ✅ | Watch |
| Liveness Detection V2 | Same inputs as V1 with a structured JSON response: nested image, video, image_video_facematch, plus overall fields; spoof paths zero confidence with optional prediction_confidence. | Face verification & biometrics | File (form-data) | JSON | Bearer Token | ✅ | Watch |
| Document (Rect) | Detects any document and returns a cropped image of the document. | Document processing | File (form-data) | JSON | Bearer Token | ✅ | Watch |
| Crop Face | Detects any face in an image and returns a cropped image of the face. | Face verification & biometrics | File (form-data) | JSON | Bearer Token | ✅ | Watch |
| Selfie Segmentation | Detects any face in an image and uses a gray filter for the background to return the segmented selfie. | Face verification & biometrics | File (form-data) | JSON | Bearer Token | ✅ | Watch |
| Card Detection | Classifies and detects card types: Aadhaar Front, Aadhaar Back, Pan Card, Passport Front, Passport Back, Driving License, Voter ID. | Document processing | File (form-data) | JSON | Bearer Token | ✅ | Watch |
| Signature Detection | Classifies the clarity of signatures captured in images and provides a confidence score for quality and recognizability. | Document processing | File (form-data) | JSON | Bearer Token | ✅ | Watch |
| Reversible Aadhaar Redact (v2) | Reversible masking: POST /v2/redact/redact embeds encrypted originals; POST /v2/redact/unredact restores with the same secret. | Compliance workflows needing masked display with audited recovery | File (form-data) + secret | PNG / PDF | Bearer Token | ✅ | Watch |
| Index Faces (Rekognition) | Index a face into the AWS Rekognition collection (image, bucket, image_key, external_image_id). | Face gallery & search prep | JSON | JSON | Bearer Token | ✅ | Watch |
| Delete Faces from Collection | Remove a face record by bucket and external_image_id. | Privacy / retention | JSON | JSON | Bearer Token | ✅ | Watch |
| Driving Licence Front OCR | Extracts structured fields from the front of an Indian driving licence. | Document OCR | File (form-data) | JSON | Bearer Token | ✅ | Watch |
| Driving Licence Back OCR | Extracts structured fields from the back; optional front_data JSON improves parsing. | Document OCR | File (form-data) | JSON | Bearer Token | ✅ | Watch |
| Voter ID Front OCR | Extracts EPIC and demographics from the front of a Voter ID with confidence filtering. | Document OCR | File (form-data) | JSON | Bearer Token | ✅ | Watch |
| Voter ID Back OCR | Extracts address and fields from the back of a Voter ID. | Document OCR | File (form-data) | JSON | Bearer Token | ✅ | Watch |
| Facial Analysis | Estimates age and gender from a face photo (JPEG/PNG). | Demographics (policy-bound) | File (form-data) | JSON | Bearer Token | ✅ | Watch |
| Face Verification (v2) | Runs face verification on an upload; returns confidence, face_detected, faces_found. | Quality gate before facematch | File (form-data) | JSON | Bearer Token | ✅ | Watch |
| Crop Face (v2 YOLO) | YOLO-based face crop returning JPEG bytes (/v2/yolocrop/face). | Face chip extraction | File (form-data) | JPEG (binary) | Bearer Token | ✅ | Watch |
| Card Detection (v2) | ONNX model classifies document type (/v2/card_detection/card_detection). | Document routing | File (form-data) | JSON | Bearer Token | ✅ | Watch |
| Card Orientation | Corrects skewed card images (/card_orientation/correct). | OCR prep | File (form-data) | File / JSON | Bearer Token | ✅ | Watch |
| Captcha Break | OCR-style decode for captcha bitmaps sent as base64_image form field. | Supervised automation only | File (form-data) | JSON | Bearer Token | ✅ | Watch |
| Speech-to-Text (Multimodal) | Unified STT wrapper: pick provider (OpenAI, xAI, ElevenLabs, Sarvam, plus common cloud STT), language (en default, BCP-47, or auto), accuracy (low / medium / high), optional accuracy_language_policy for tier-based routing. | Voice KYC, agents, captions | Audio (multipart or JSON URL) | JSON | Bearer Token | ✅ | Watch |