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

🎈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-- ID image file - File Type JPEG, JPG, PNG and PDF - Max File size: 10MB

🎈Responses

Response Code

CodeDescription
200Successful Response
422 / 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
date_of_birth
full_name
place_of_birth
valid_untill
stringDescribes the detail extracted from ID

Error Code

Response CodeErrror codeError MessageDescription
422OCR_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": "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.