[ID] 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

🎈Request

Headers

KeyTypeNotesDescription
app-idStringRequiredApplication ID that generated from Application Menu in Verihubs Client Dashboard.
To hit in Testing and Live mode you need a Production Application ID.
api-keyStringRequiredAPI-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

ParameterTypeDescriptionExample
imagefile
  • KITAS image file
  • File Type JPEG, JPG, PNG or PDF
  • Max File size: 10MB
  • image is required

🎈Responses

Response Code

CodeDescription
200Successful Response
400Bad Request
401Unauthorized
500Internal Server Error

Response Parameters

KeyTypeDescription
messagestringMessage that describe the overall response.
dataobjectShows the extraction result
data.idstringUsed as the identity of the extraction result.
data.reference_idstringThe identity of the extraction result which want to be pulled
data.result_datastringDescribes the detail extracted from ID

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

Error Code

Response CodeErrror codeError MessageDescription
422OCR_40001There's a problem with your JSON payloadNo value in payload / incorrect payload / missing payload image / invalid image extension / image size exceeds maximum
400OCR_40004You don't have enough quota, please contact our adminInsufficient quota (applicable in testing mode only)
500OCR_50000There's a problem from our system.Internal server error

Sample Responses

Response CodeResponseDescription
200
{
    "message": "Success Extract Data",
    "data": {
        "id": "410fbda7-d4f3-47f3-ae9b-63e9b712a722",
        "reference_id": "ea211cba-eafd-42a6-b0d4-faffb363de83",
        "result_data": {
            "address": "N/A",
            "date_of_birth": "N/A",
            "full_name": "SCHULER DIRK",
            "guarantor": "N/A",
            "nationality": "SPANYOL",
            "niora": "IM2RBS71231",
            "occupation": "N/A",
            "passport_expiry_date": "N/A",
            "passport_number": "C4WJ94C6X",
            "permit_expiry_date": "31-05-2018",
            "permit_index": "N/A",
            "permit_issue_date": "31-05-2017",
            "permit_issue_location": "NGURAH RAI",
            "permit_number": "2C11E10857-R",
            "place_of_birth": "N/A",
            "sex": "N/A",
            "status": "N/A"
        }
    }
}
Request data parameter is valid.
400
{
    "message": "There's a problem with your JSON payload",
    "error_code": "OCR_40001",
    "error_fields": 
}
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.

Did this page help you?