/ocr/idcard
1.API Specification 2.Request Params 3.Response Params 4.Error Codes 5.Sample
1.API Specification
This API is used to recognize ID card of Colombia, and extract the key information.
Image spec
1. Format: JPG(JPEG), PNG, e-aadhaar(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.colombia.accuauth.com/ocr/idcard
Debugging Tool
2.Request Params
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
Fields
Type
Description
optional
file file Binary data of the image
optional
image_base64 string Base64 encoded data of image
optional
detect_face integer 1: enable face detection, and the face_region field will be returned; 0: the default value, disable face detection.
Either parameter file or image_base64 must be provided as a request parameter.
You MUST add image stream to multipart/form-data section of POST message when using file parameter.
3.Response Params
Fields
Type
Description
request_id string Unique id of each request
status string Response status, OK if request success, other if failed; See Error Codes for details
results array The array of card ocr results，See results belowed for details
Elements in results:
Fields
Type
Description
card_type string The type of card: old or new
card_side string The side of card: front or back
card_info object The key infomation of card
face_region array Four point coordinates of face rect, format as: [(x1, y1), (x2, y2), (x3, y3), (x4, y4)]; The coordinate is based on the original image, while the points order is based on the face after rotation(top left, top right, bottom right, bottom left).
Elements in the card_info
The front side of new ID card
Fields
Type
Description
id_number string ID card number
last_name string Last name of the person
name string Name of the person
nationality string Nationality of the person
birthday string Date of birth
birthday_s string Formatted date of birth: dd-mm-yyyy
birth_place string Birth place of the person
height string Height of the person
blood_type string Blood type
gender string Gender, M for male and F for female
issue_date string Issue date
issue_date_s string Formatted issue date: dd-mm-yyyy
issue_authority string Issue authority
expiry_date string Expiry date
expiry_date_s string Formatted expiry date: dd-mm-yyyy
The back side of new ID card
Fields
Type
Description
line1 string The first line
line2 string The second line
line3 string The third line
The front side of old ID card
Fields
Type
Description
id_number string ID card number
last_name string Last name of the person
name string Name of the person
The back side of old ID card
Fields
Type
Description
birthday string Date of birth
birthday_s string Formatted date of birth: dd-mm-yyyy
birth_place string Birth place of the person
height string Height of the person
blood_type string Blood type
gender string Gender, M for male and F for female
issue_date string Issue date
issue_date_s string Formatted issue date: dd-mm-yyyy
issue_authority string Issue authority
other_information1 string Other_information1
other_information2 string Other_information2
other_information3 string Other_information3
Response Syntax
Front side of new ID card
{
"request_id" : "TID8bf47ab6eda64476973cc5f5b6ebf57e" ,
"status" : "OK" ,
"results" : [{
"card_type" : "new" ,
"card_side" : "front" ,
"card_info" :{
"id_number" :"1.082.961.796" ,
"last_name" :"TORRES GARCIA" ,
"name" :"SAMIR DE JESUS" ,
"nationality" : "COL" ,
"birthday" :"23-FEB-1991" ,
"birthday_s" :"23-02-1991" ,
"birth_place" :"************ (************)" ,
"height" :"1.70" ,
"gender" :"M" ,
"blood_type" :"O+" ,
"issue_date" :"02-MAR-2009" ,
"issue_date_s" :"02-03-2009" ,
"issue_authority" :"BARRANQUILLA" ,
"expiry_date" :"02-MAR-2029"
"expiry_date_s" :"02-03-2029"
},
"face_region" : [
[
325 ,
1010
],
[
736 ,
1010
],
[
736 ,
1523
],
[
325 ,
1523
]
]
}]
}
{
"request_id" : "TID5053406c77e749b6b1073cf2e75fc087" ,
"results" : [
{
"card_info" : {
"line1" : "ICCOL0000000**<<<<<<<<<<<<<<<<" ,
"line2" : "8808213F3101300COL10346*****<9" ,
"line3" : "MARTINEZ<GARCIA<<*****<*****"
},
"card_side" : "back" ,
"card_type" : "new"
}
],
"status" : "OK"
}
Front side of old ID card
{
"request_id" : "TID8bf47ab6eda64476973cc5f5b6ebf57e" ,
"status" : "OK" ,
"results" : [{
"card_type" : "old" ,
"card_side" : "front" ,
"card_info" :{
"id_number" :"1.082.961.796" ,
"last_name" :"TORRES GARCIA" ,
"name" :"SAMIR DE JESUS"
},
"face_region" : [
[
325 ,
1010
],
[
736 ,
1010
],
[
736 ,
1523
],
[
325 ,
1523
]
]
}]
}
{
"request_id" : "TID8bf47ab6eda64476973cc5f5b6ebf57e" ,
"status" : "OK" ,
"results" : [{
"card_type" : "old" ,
"card_side" : "back" ,
"card_info" :{
"birthday" :"23-FEB-1991" ,
"birthday_s" :"23-02-1991" ,
"birth_place" :"************ (************)" ,
"height" :"1.70" ,
"gender" :"M" ,
"blood_type" :"O+" ,
"issue_date" :"02-MAR-2009" ,
"issue_date_s" :"02-03-2009" ,
"issue_authority" :"BARRANQUILLA" ,
"other_information1" :"************21" ,
"other_information2" :"************ 1" ,
"other_information3" :"************"
}
}]
}
4.Error Codes
Common error codes of this API:
Http Status Code
Status fieldDescription
400INVALID_ARGUMENT
Request parameter is invalid
400DETECTION_FAILED
Detect image failed
401UNAUTHORIZED
Unauthorized or access is denied
401KEY_EXPIRED
Your API ID has expired
403NO_PERMISSION
You are not authorized to use this API
403OUT_OF_QUOTA
API calls quota exceeded
403RATE_LIMIT_EXCEEDED
API request frequency exceeds the limit
404NOT_FOUND
Requested API cannot be found
500INTERNAL_ERROR
Internal server error
Comment: Please see the reason field for details when the above 40X error occurred
Response Syntax
{
"status" : "INVALID_ARGUMENT" ,
"reason" : "must specify 'file' or 'image_base64' argument" ,
"request_id" : "TID8bf47ab6eda64476973cc5f5b6ebf57e"
}
5.Sample