Passport
This method helps you to extract text in Passport image.
🎈Endpoint
| Method | Endpoint |
|---|---|
| POST | https://api.verihubs.com/v2/ocr/passport |
🎈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 | - | - Passport 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 |
| authority date_of_birth date_of_expiry date_of_issue full_name gender nationality passport_no place_of_birth | string | Describes the detail extracted from passport |
| valid_doc | boolean | Describe whether the document is detected as passport. If "valid_doc" : true , then the document is considered as passport. |
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": { "authority": "JAKARTA UTARA", "date_of_birth": "27/06/1977", "date_of_expiry": "23/08/2010", "date_of_issue": "25/08/2005", "full_name": "LINDA ROSE", "gender": "F", "nationality": "INDONESIAN", "passport_no": "X00130410", "place_of_birth": "INDONESIA", "valid_doc": true } } } | Request data parameter is valid. |
| 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