Generic ID
This method helps you to extract text in Generic ID image. The purpose of OCR Generic ID is to extract information from any ID cards / forms. The result will be in “text” format. Since the service works for all kinds of IDs, only general information that will be extracted, which are:
-Full name
-Date of Birth
-Place of Birth
-Valid Until / Expiry date of the ID’s
If the ID extracted does not contain the information above, the correlated field will show “N/A” in the response.
🎈Endpoint
Method | Endpoint |
---|---|
POST | https://api.verihubs.com/v2/ocr/generic_id |
🎈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 | - | - ID 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 |
date_of_birth full_name place_of_birth valid_untill | string | Describes the detail extracted from ID |
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": "7473ad0f-f9a1-4b53-9ec3-f32899dd3ee3", "reference_id": "f27a11f2-9f6a-459c-9497-a040b030f75f", "result_data": { "date_of_birth": "04-09-1994", "full_name": "Mia Dela Cruz", "place_of_birth": "N/A", "valid_until": "20-05-2026", } } } | 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