KwikID DocumentationAPI SuiteData Protection (ML)
Aadhaar Masking
Redact or mask Aadhaar numbers in a document image for safer storage and display. Server-side multipart POST with Bearer auth.
API reference
Try itLoading playground…
Loading…
AuthorizationBearer <token>
JWT Bearer token authentication. Obtain a token from the KwikID dashboard.
In: header
filestring
unique_id?string
Response Body
curl -X POST "https://__mock__/redact" \ -F file="string""string"{
"msg": "string"
}{
"detail": {},
"message": "string"
}Overview
Call POST /redact with Authorization: Bearer <token> and file (JPEG, PNG, or PDF). Optional unique_id. 200 returns masked JPEG or PDF bytes (not JSON). Use the masked artifact for support tickets, CRM attachments, and audit copies when full Aadhaar storage is not permitted.
Key features
- Compliance helper: Reduces accidental exposure of full Aadhaar in downstream systems.
- Pairs with OCR: Run after Aadhaar front OCR when you must retain only masked images.
Implementation
Step 1: Call from your backend
Upload the document as file.
Error handling
| HTTP status | When |
|---|---|
| 400 | Unsupported file or no Aadhaar pattern found. |
| 401 | Invalid token. |
Security notes
- Masking does not replace vaulting, encryption, or access controls.
Benefits
- Safer sharing of document images across teams and tools.