NPWP
This method helps you to extract text in NPWP image.
🎈Endpoint
| Method | Endpoint |
|---|---|
| POST | https://api.verihubs.com/ocr/npwp |
🎈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 | - | - NPWP image file - File Type JPEG, JPG, PNG and PDF - Max File size: 5 MB |
🎈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 |
| address full_name nik npwp | string | Describes the detail extracted from NPWP |
Error Code
| Response Code | Errror code | Error Message | Description |
|---|---|---|---|
| 200 | OCR_200004 | NPWP not detected | There is no npwp detected in the inputted file. |
| 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": "fe83d593-8715-4394-84a5-8e22db96bdb7", "reference_id": "e89f96a3-f9b9-4984-ad78-f574b8e7f376", "result_data": { "npwp": "14.235.842.2-201.000", "name": "MUHAMMADIN", "nik": "317305189293843", "address": "TAMAN RATU INDAH RT 002" } } } | 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. |
| 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 7 days ago