Read Document (V-Doc)

V-Doc is used to perform OCR extraction, identify the document type and document authentication verification.

Overview

The user will need to provide front document image and back document image to be able to test the API. The main purpose of this API is to perform OCR and extract the data from the ID card. It will output the extracted data for the user to check on the extracted information.

The API will also return cropped ID cards from the submitted image and cropped portraits from the ID card. Users will also need to follow a set of rules that can be found here to make sure the result is accurate.

API Method

POST https://onboard.veryfyglobal.com/api/ekyc/v-doc

Headers

Key	Value
Accept	application/json
Content-Type	multipart/form-data

Input Sample

Key	Type	Value	Description
reference_id	string	a714fccb-2676-40eb-8696-xxxxxxxxxxxx	The reference key from Create Reference ID API
with_flash	boolean	false	Set to true to better detect the hologram on the ID. * Only some ID documents is supported
id_front	file
id_front_flash	file		This field will be required if with_flash is set to true
id_back	file

Response Sample

200: OK

{
    "message": "Ok",
    "data": {
        "document_type": "Philippines - Id Card (2020)",
        "ocr": [
            {
                "label": "Issuing State Code",
                "value": "PHL"
            },
            {
                "label": "Document Number",
                "value": "24984693851XXXXX"
            },
            {
                "label": "Date of Birth",
                "value": "3/22/1985"
            },
            {
                "label": "Surname (PH)",
                "value": "REYMAN"
            },
            {
                "label": "Surname",
                "value": "REYMAN"
            },
            {
                "label": "Given Name (PH)",
                "value": "JOHN DOE"
            },
            {
                "label": "Given Name",
                "value": "JOHN DOE"
            },
            {
                "label": "Surname and Given Names",
                "value": "REYMAN JOHN DOE"
            },
            {
                "label": "Issuing State Name",
                "value": "Philippines"
            },
            {
                "label": "Middle Name (PH)",
                "value": "BARON"
            },
            {
                "label": "Age",
                "value": "30"
            }
        ],
        "landmark": [
            {
                "label": "Landmark Analysis Result",
                "value": [
                    {
                        "label": "Logo 1 Landmark",
                        "value": "93.55"
                    },
                    {
                        "label": "Header Landmark",
                        "value": "89.66"
                    },
                    {
                        "label": "Logo 2 Landmark",
                        "value": "93.08"
                    },
                    {
                        "label": "Last Name Landmark",
                        "value": "85.92999999999999"
                    },
                    {
                        "label": "Given Name Landmark",
                        "value": "84.78999999999999"
                    },
                    {
                        "label": "Middle Name Landmark",
                        "value": "91.32000000000001"
                    },
                    {
                        "label": "DOB Landmark",
                        "value": "82.43"
                    },
                    {
                        "label": "Logo 3 Landmark",
                        "value": "71.08"
                    }
                ]
            },
            {
                "label": "Hologram",
                "value": "Fail"
            },
            {
                "label": "ID Blur Detection",
                "value": "Pass"
            },
            {
                "label": "ID Brightness Detection",
                "value": "Pass"
            },
            {
                "label": "Color Mode",
                "value": "Pass"
            },
            {
                "label": "Screen Detection",
                "value": "Pass"
            }
        ]
    }
}

400: Bad Request

500: Internal Server Error

Image Requirement

1. Document should be fully inside the image;

2. Document should take 70-80% of the image area;

3. Document should not be stuck to image edges;

4. Image should be in focus in the document area;

5. There should be no glares or significant shadow on the document;

6. Image size should be at least 900x600;

7. Max image size: 2.5MB

ID documents that support flash image

• Driving License

• SSS

• UMID