BPKB
The purpose of OCR is to extract information from buku pemilikan kendaraan bermotor (BPKB) documents. The result will be in “text” format. All the data inside the document will be extracted. There are 2 main pages in BPKB that can be extracted, which are identitas kendaraan (IK) and identitas pemilik (IP).
🎈Endpoint
| Method | Endpoint | Description |
|---|---|---|
| POST | https://api.verihubs.com/v2/ocr/bpkb_ik | endpoint for BPKB Identitas Kendaraan |
| POST | https://api.verihubs.com/v2/ocr/bpkb_ip | endpoint for BPKB Identitas Pemilik |
🎈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 | - | - BPKB image file - File Type JPEG, JPG, PNG and PDF - Max File size: 10MB |
🎈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 |
| bahan_bakar isi_silinder jenis jumlah_roda jumlah_sumbu merek model no_mesin no_rangka nomor_polisi tahun_pembuatan tipe warna | string | Describes the detail extracted from BPKB Identitas Kendaraan |
| alamat lokasi_dikeluarkan nama_pemilik no_id no_bpkb pekerjaan tanggal_dikeluarkan | string | Describes the detail extracted from BPKB Identitas Pemilik |
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": "f0cf2285-704d-4489-b011-504aab60b5ec", "reference_id": "eba032fc-7596-42c6-8efd-fe27137c5d67", "result_data": { "bahan_bakar": "LISTRIK", "isi_silinder": "800 W", "jenis": "SEPEDA MOTOR", "jumlah_roda": "2", "jumlah_sumbu": "N/A", "merek": "VIAR", "model": "SCOOTER", "no_mesin": "VR00FKB0000000", "no_rangka": "BBR00ABC000000", "nomor_polisi": "B0000UNX", "tahun_pembuatan": "2017", "tipe": "VIQ AST", "warna": "GREY" } } } | Request data parameter is valid. |
| 400 | { "message": "There's a problem with your JSON payload", "error_code": "OCR_40001", "error_fields": be in “text” format. All the data inside the document will be extracted. There are 2 main pages in BPKB that can be extracted, which a } | 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 10 months ago
Did this page help you?
