/ocr/mask_indian_card
1.API Specification
2.Request Params
3.Response Params
4.Error Codes
5.Sample
1.API Specification
This API is used to mask the ID number on the aadhaar card, and return the image with mosaic.
Aadhaar card (2 calls) - Front and back
Image spec
1. Format: JPG(JPEG), PNG, PDF
2. Between 128*128 and 6000*6000 (pixels), Recommended resolution: 1280*1280
3. File size: no larger than 5 MB
Request Method
POST
Request URL
https://cloudapi.accuauth.in/ocr/mask_indian_card
Debugging Tool
2.Request Params
2.1 Request Header
| Parameter | Type | Required | Description |
|---|---|---|---|
| X-DF-API-ID | string | Yes | For API credentials，Please visit API Request |
| X-DF-API-SECRET | string | Yes | For API credentials，Please visit API Request |
2.2 Request Body
| Required | Fields | Type | Description |
|---|---|---|---|
| optional | file | file | Binary data of the image |
| optional | image_base64 | string | Base64 encoded data of image |
| optional | file_type | string | File type: pdf / image, default is image, now we only support pdf format from UIDAI Website |
| optional | file_password | string | PDF file password |
| optional | detect_image_quality | float | Image quality score [0.0-1.0], the greater of the value the higher image quality |
Either parameter
fileorimage_base64must be provided as a request parameter.You MUST add image stream to multipart/form-data section of POST message when using
fileparameter.
3.Response Params
| Fields | Type | Description |
|---|---|---|
| request_id | string | Unique id of each request |
| status | string | Response status, OK means "request success", other means "request failure"；See Error Codes for details |
| image_quality | float | Image quality score [0.0-1.0], the greater of the value the higher image quality |
| masked_images | array | The array of image data with base64 encode, if API detects multiple aadhaar cards, will return corresponding images |
Reponse Syntax
{
"request_id": "TID8bf47ab6eda64476973cc5f5b6ebf57e",
"status": "OK",
"image_quality": 0.981,
"masked_images": ['***image data with base64 encode***']
}
4.Error Codes
| Code | Status Field |
Description |
|---|---|---|
400 |
INVALID_ARGUMENT | Request parameter is invalid |
400 |
DETECTION_FAILED | Detect image failed |
401 |
UNAUTHORIZED | Unauthorized or access is denied |
401 |
KEY_EXPIRED | Your API ID has expired |
403 |
NO_PERMISSION | You are not authorized to use this API |
403 |
OUT_OF_QUOTA | API calls quota exceeded |
403 |
RATE_LIMIT_EXCEEDED | API request frequency exceeds the limit |
404 |
NOT_FOUND | Requested API cannot be found |
500 |
INTERNAL_ERROR | Internal server error |
Comment: For detailed 40X error code descriptions, please refer to below returned reason.
Response Syntax
{
"status": "INVALID_ARGUMENT",
"reason": "must specify 'file' or 'image_base64' argument",
"request_id": "TID8bf47ab6eda64476973cc5f5b6ebf57e"
}