Guidelines

[ID] NPWP

This method helps you to extract text in NPWP image.

🎈Endpoint

MethodEndpoint
POSThttps://api.verihubs.com/ocr/npwp

🎈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

ParameterTypeNotesDefaultDescription
imagefileRequired-
  • NPWP image file
  • File Type JPEG, JPG, PNG and PDF
  • Max File size: 5 MB

🎈Responses

Response Code

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

Details for 200

KeyTypeDescription
messagestringMessage that describe the overall response.
dataobjectShows the extraction result
idstringUsed as the identity of the extraction result.
reference_idstringThe identity of the extraction result which want to be pulled
address
full_name
nik
npwp		stringDescribes the detail extracted from NPWP

Error Code

Response CodeErrror CodeError MessageDescription
200OCR_200004NPWP not detectedThere is no npwp detected in the inputted file.
400OCR_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": "9d23cd94-2163-48d6-9726-9c9a9ea31908",
        "reference_id": "f8ccf7b9-6165-4751-abd9-e671b8df3420",
        "result_data": {
            "address": "PERUM JATIBENING INDAH JL. SERAM BLOK B NO. 204 RT. 006 RW. 010 JATIBENING PONDOKGEDE KOTA BEKASI JAWA BARAT -",
            "full_name": "PRADIPTA MAULANA",
            "nik": "3275080912840014",
            "npwp": "59.175.380.1-432.000"
        }
    }
}
Request data parameter is valid.
200
{
    "message": "NPWP Not Detected",
    "error_code": "OCR_200004"
}
The image attached is not NPWP.
400
{
    "message": "There's a problem with your JSON payload",
    "error_code": "OCR_40001",
    "error_fields": [
        {
            "field": "image",
            "message": "there is a problem with the image provided"
        }
    ]
}
Invalid Payload
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.
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.
500
{
    "message": "Internal server error",
    "error_code": "OCR_50000"
}
Internal server error.

Updated about 6 hours ago

Did this page help you?