Here are the OCR KK Sample and Description detail:
Request API:
curl -X POST \
-H "X-ADVAI-KEY: {Your Access Key}" \
-H "Content-Type: multipart/form-data" \
-F "ocrImage=@/Users/lby/Desktop/ocr-image.jpg" \
"https://api.advance.ai/openapi/face-identity/v1/ocr-kk-check"
Request Parameter:
| Parameter | Description |
|---|---|
| ocrImage | file An image（PNG/JPG/JPEG/TIF format） |
Note:
Image Quality requirements:
The services check and extract the necessary information from the uploaded images, hence please ensure the uploaded images satisfy the following criteria:
-
- Is in one of the following image formats: PNG / JPG / JPEG
- Below 2 MB file size
- Minimum resolution of 256 x 256
- Maximum resolution of 4096 x 4096
- For OCR services please also ensure that the uploaded images satisfy the following criteria:
- ID Card’s ratio in the uploaded photo is not so small that the words in the ID Card are unreadable
- ID Card’s orientation is in Vertical or Horizontal position and NOT heavily tilted (around 45 degree)
- Nothing is covering up the words in the ID Card (ex: Light Spot, Dirt, Ink, Shadow, etc)
- Have a clean background (No words or other picture in the background)
Response Description:
| Parameter | Description |
|---|---|
| code | KK OCR Status Code |
| transactionId | The request id, the max length is 64 |
| pricingStrategy | Whether the request will be charged, enum type: FREE, PAY |
| message | Status Code Explanation |
| data | address : Address of the family |
familyHead : Name of the head of family |
|
subDistrict : Sub-district of the family |
|
postcode : Postcode of the family |
|
village : Village of the family |
|
rtrw : RT/RW of the family |
|
province : Province of the family |
|
district : District of the family |
|
personList : please click here for the breakdown of this JSON array object |
|
kk : KK number of the family |
|
| extra | Extra response info (Exception Message) |
Response Object Breakdown:
personList:
| Field Name | Description |
|---|---|
person |
string Preson N |
idNumber |
string ID Number (NIK) of the Person |
name |
string Name of the person |
birthPlace |
string Birthplace of the person |
occupation |
string Occupation of the person |
birthDate |
string Birthday of the person |
religion |
string Religion of the person |
marriageDate |
string Date of Marriage of the person |
bloodType |
string Blood type of the person |
statusInFamily |
string Status in Family of the person |
gender |
string Gender of the person |
education |
string Education of the person |
nationality |
string Nationality of the person |
maritalStatus |
string Marital Status of the person |
passport |
string Passport number of the person |
nameOfFather |
string Father’s Name of the person |
nameOfMother |
string Mother’s Name of the person |
kitap |
string KITAP number of the person |
Response Code:
| Status Code | Message |
|---|---|
PARAMETER_ERROR |
free parameter error details refer to the samples on the right |
OCR_NO_RESULT |
pay OCR check failed, unable to find any kk field in the uploaded picture |
Comments
0 comments