KITAS
This method helps you to extract text in Kartu Izin Tinggal Terbatas (KITAS) . The purpose of OCR Generic ID is to extract information from any ID cards / forms. The result will be in “text” format.
🎈Endpoint
| Method | Endpoint |
|---|---|
| POST | https://api.verihubs.com/v2/ocr/kitas |
🎈Request
Headers
| Key | Type | Notes | Description |
|---|---|---|---|
| App-ID | String | Required | Application ID that generated from Application Menu in Verihubs Client Dashboard. To hit in Testing and Live mode you need a Production Application ID. |
| API-Key | String | Required | API-Key that generated from Application Menu in Verihubs Client Dashboard that related to specific Application ID. |
You can generate your Application ID and API-Key in the Application page in Verihubs Client Dashboard..
Body Parameters
| Parameter | Type | Notes | Default | Description |
|---|---|---|---|---|
| image | file | Required | none |
|
🎈Responses
Response Code
| Code | Description |
|---|---|
| 200 | Successful Response |
| 422 / 400 | Bad Request |
| 401 | Unauthorized |
| 500 | Internal Server Error |
Details for 200
| Key | Type | Description |
|---|---|---|
| message | string | Message that describe the overall response. |
| data | object | Shows the extraction result |
| id | string | Used as the identity of the extraction result. |
| reference_id | string | The identity of the extraction result which want to be pulled |
| date_of_birth full_name place_of_birth address guarantor nationality niora occupation passport_expiry_date passport_number permit_expiry_date permit_index permit_issue_date permit_issue_location permit_number sex status | string | Describes the detail extracted from ID |
Error Code
| Response Code | Errror code | Error Message | Description |
|---|---|---|---|
| 422 | OCR_40001 | There's a problem with your JSON payload | no value in payload / incorrect payload / missing payload image / invalid image extension / image size exceeds maximum |
| 400 | OCR_40004 | You don't have enough quota, please contact our admin | Insufficient quota (applicable in testing mode only) |
| 500 | OCR_50000 | There's a problem from our system. | Internal server error |
Sample Responses
| Response Code | Response | Description |
|---|---|---|
| 200 |
{
"message": "Success Extract Data",
"data": {
"id": "ce9d5e71-22b9-4243-ad19-24d9de17a12a",
"reference_id": "a2bb082f-8b3c-4673-ab90-a2762c7437bb",
"result_data": {
"address": "JL. LIMAU BLOK.A NO.2, BEKASI, JAWA BARAT",
"date_of_birth": "05-05-1990",
"full_name": "JOHN DOE",
"guarantor": "LINDA DOE",
"nationality": "AUSTRALIA",
"niora": "A1U1RACO10950",
"occupation": "MAHASISWA",
"passport_expiry_date": "10-10-2027",
"passport_number": "AU1095500",
"permit_expiry_date": "15-05-2026",
"permit_index": "IC",
"permit_issue_date": "15-05-2025",
"permit_issue_location": "Bekasi",
"permit_number": "2C25AU1440-A",
"place_of_birth": "MELBOURNE",
"sex": "MALE",
"status": "STUDENT"
}
}
}
| Request data parameter is valid. |
| 400 |
{
"message": "There's a problem with your JSON payload",
"error_code": "OCR_40001"
}
| Invalid Payload. |
| 401 |
{
"message": "Authorization failed"
}
| Authorization Failed; Transaction that unauthorized due to Application ID or API-Key issue. To hit in Testing and Live mode you need a Production Application ID and API-Key. |
| 400 |
{
"message": "You don't have enough quota, please contact our admin",
"error_code": "OCR_40004"
}
| The transaction is in Testing mode and not enough remaining quota. Please contact Verihubs Customer Support. |
| 500 |
{
"message": "Internal server error"
"error_code": "OCR_50000"
}
| Internal server error. |
Updated 9 months ago
Did this page help you?