The purpose of OCR is to extract information from Philippines ID cards, which are:

UMID ((Unified Multi-Purpose ID)
SSS (Social Security System ID / Number)
PRC (Professional Regulation Commission ID)
TIN (Taxpayer Identification Number)
Pag-IBIG (HDMF – Home Development Mutual Fund ID)
Voter's ID
Driving License
PHL POST
PhilHealth
Philippines National ID
School ID
PWD
Senior ID
Alien Certificate of Registration

The result will be in “text” format. All the data inside the requested document will be extracted.

🎈Endpoint

Method	Endpoint
POST	https://api.verihubs.com/ocr/id_ph

🎈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	-	Document 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
result_data	string	Describes the detail extracted from ID Philippines

Error Code

Response Code	Errror code	Error Message	Description
400	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	VHB_5000	There's a problem from our system.	Internal server error

HTTP Code	Response	Description
200	{ "message": "Success Extract Data", "data": { "id": "7473ad0f-f9a1-4b53-9ec3-f32899dd3ee3", "reference_id": "f27a11f2-9f6a-459c-9497-a040b030f75f", "result_data": { "address": "28 Payapa St. Bagong Diwa\nSto. Cristobal, Caloocan City", "age": "N/A", "agency_no": "N/A", "barcode_no": "N/A", "blood_type": "N/A", "civil_status": "N/A", "conditions": "N/A", "date_of_birth": "04-09-1994", "date_of_issuance": "02-10-2017", "date_of_registration": "N/A", "digital_id_number": "N/A", "eyes_color": "N/A", "full_name": "Mia Dela Cruz", "gender": "N/A", "height": "N/A", "id_no": "123-456-789-000", "id_type": "TIN", "issuing_post_office": "N/A", "nationality": "N/A", "profession": "N/A", "restrictions": "N/A", "school_address": "N/A", "school_grade": "N/A", "school_name": "N/A", "school_year": "N/A", "valid_until": "N/A", "weight": "N/A", } } }	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" }`	Internal server error.