Comment on page
Driver License
Text recognition on Indonesian driver's license (SIM).
This service only supports Indonesian driver's license (SIM)
Method | URL |
POST | $vision /v1/ocr/id/sim |
Header | Value |
Content-Type | application/json |
Authorization |
The OCR inference time may vary. It depends on many factors, one of them is the image size. We recommend you to resize the image before sending it to Kredibel system.
Description
Example (Recommendation)
Example (Verbose)
Field | Type | Description |
image (Required) | <base64:image> | Image binary encoded in base64 without <data:image/png;>.
- Supports: JPG, JPEG, PNG
- Max Size: 2MB
- Recommended size: 1024x768 |
cardDetect | Boolean (Default: true) | Use card detection model |
passCardDetect | Boolean (Default: true) | If false , when identity card is not detected on the image it will return an error message |
flipImage | Boolean (Default: false) | If true , the system will flip your image |
checkFlipImage | Boolean (Default: false) | If true , the system will check whether your image is flipped or not |
You just need to declare image field in order to use this service.
{
"image": "/9j/..."
}
{
"image": "string",
"cardDetect": true,
"passCardDetect": true,
"flipImage": true,
"checkFlipImage": true
}
Description
Example
result
Field | Type | Description |
identityId | String | Identity id |
fullName | String | Full name |
birthPlace | String | Place of birth |
birthDate | Date (dd-mm-yyyy) | Date of birth |
gender | String ["PRIA", "WANITA"] | Gender |
address | String | Address |
occupation | String | Occupation |
expiryDate | Date (dd-mm-yyyy) | Expiry date |
information
Field | Type | Description |
---|---|---|
tilt | Float | Tilt degree (0-360) on identity card. If it is upside-down, then the value is 180. |
cardDetected | Boolean | Return true if out system detected identity card on the image. |
{
"message": "string",
"data": {
"id": "string",
"result": {
"identityId": "string",
"indicator": "string",
"country": "string",
"countryCode": "string",
"fullName": "string",
"nationality": "string",
"nationalityCode": "string",
"birthDate": "string",
"sex": "string",
"personalNumber": "string",
"expirationDate": "string"
},
"information": {
"tilt": float,
"cardDetected": boolean
}
}
}
Error 4XX
Error Type
Structure
Error Type | Description | Is charged? |
---|---|---|
invalid_base64_encoding | Invalid base64 encoding. | false |
card_not_found | There is no identity card found in the image. This error only raised if you set passCardDetect = False . | true |
text_not_found | There is no text found in the image. | true |
invalid_document_type | The document sent does not appear to be the right identity type. | true |
parsing_failed | System fail to parse identity card. | true |
{
"errors":{
"errorId": <log_id:uuid>,
"errorType": <error_type:str>
},
"message": <message:str>
}
Error 5XX
For every 5XX http code response, there will be no charge.
Last modified 1yr ago