Ask me anything
How can I help you with Catalyst today?
Aadhaar
The AADHAAR model is a part of the Document Processing feature of Identity Scanner that enables you to process Indian Aadhaar cards as identity proof documents.
Note:
-
Catalyst does not store any of the files you upload in its systems. The documents you upload are used for one-time processing only. They are not used for ML model training purposes either. Catalyst components are fully compliant with all applicable data protection and privacy laws.
-
Document Processing is only relevant to Indian users and is only available in the IN DC. This feature will not be available to users accessing from the EU, AU, US, JP, SA or CA data centers. Users outside of India from the other DCs can access the general OCR component to read and process textual content.
Process Aadhaar
Description
This API extracts fields of data from an Indian Aadhaar card using an advanced OCR technology. The JSON response will return the parameters recognized from the Aadhaar card, along with confidence scores for each recognition that determine their accuracy. You must provide the path to the image files of the front and back of the Aadhaar card, and specify the model type as AADHAAR in the API request.
Request Details
Request URL
{api-domain}/baas/v1/project/{project_id}/ml/ocr
Request Headers
Authorization: Zoho-oauthtoken {oauth_token}
content-type: multipart/form-data; boundary=—-WebKitFormBoundary7MA4YWxkTrZu0gW
Optional Headers
CATALYST-ORG: {org_id}
Environment: Development
Scope
ZohoCatalyst.mlkit.READ
Request JSON Properties
The image of the front side of the Aadhaar card to be processed. You must provide the path to it in your local system.
Allowed formats: .webp, .jpeg, .png, .bmp, .tiff
File size limit: 15 MB
The image of the back side of the Aadhaar card to be processed. You must provide the path to it in your local system.
Allowed formats: .webp, .jpeg, .png, .bmp, .tiff
File size limit: 15 MB
The model type of the image
Value to be passed: AADHAAR
The language code of the language to be identified. The AADHAAR model supports the Indian languages listed in a table below.
You must pass English and the relevant regional language alone for the AADHAAR type. For example, if you are from Tamil Nadu, you must pass tam and eng in the request.
Languages Supported by the Aadhaar Model Type
| Language | Language Codes |
|---|---|
| English | eng |
| Hindi | hin |
| Bengali | ben |
| Marathi | mar |
| Telugu | tel |
| Tamil | tam |
| Gujarati | guj |
| Urdu | urd |
| Kannada | kan |
| Malayalam | mal |
| Sanskrit | san |
Response Details
The response contains the parameters recognized in the Aadhaar card such as the card holder’s name, address, gender, Aadhaar card number assigned to respective keys. The response also shows a confidence score in the range of 0 to 1 for each of the recognized values.
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/ml/ocr
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type: multipart/form-data; boundary=—-WebKitFormBoundary7MA4YWxkTrZu0gW”
-F aadhaar_front=/Desktop/Aadhaar1.webp
-F aadhaar_back=/Desktop/Aadhaar2.webp
-F model_type=AADHAAR
-F “language=eng,tam”
{
"status":"success",
"data":{
"text": "{\"address\":{\"prob\":0.5,\"value\":\"S/O Tony, Seer 40, S/O Julie, 40, Dewdrops Street, Cherry Hill Pondicherry, Pondicherry ureing4Gen, ureing4Gen 605008 \"},\"gender\":{\"prob\":\"0.9\",\"value\":\"male\"},\"dob\": {\"prob\":\"0.6\", \"value\":\"12/12/2012\"},\"name\":{\"prob\":\"0.8\", \"value\":\"Hari Krishnan\"},\"aadhaar\":{\"prob\":0.8,\"value\":\"1234 5678 0123\"}}"
}
}
Yes
No
Thank you for your feedback!
Send your feedback to us