Version 1

POST https://okaydocdemo.innov8tif.com/ekyc/api/v1/ocr

Request Body

NameTypeDescription

apiKey

string

To be assigned by Innov8tif

base64ImageString

string

Front id card/passport image in base64

backImage

string

Back id card in base64

imageFormat

string

Clarify the image format: jpg, jpeg, png, bmp, gif, tiff, tif

imageEnabled

boolean

True - Cropped image will be returned False - No image will be returned

{
    "status": "success",
    "message": "",
    "result": [
        {
            "ListVerifiedFields": {
                "pFieldMaps": [
                    {
                        "wLCID": 0,
                        "FieldType": 1,
                        "wFieldType": 1,
                        "Field_MRZ": null,
                        "Field_Visual": "PHL",
                        "Matrix": [
                            0,
                            0,
                            0,
                            0,
                            0,
                            0,
                            0,
                            0,
                            0,
                            0
                        ]
                    },
                    {
                        "wLCID": 0,
                        "FieldType": 2,
                        "wFieldType": 2,
                        "Field_MRZ": null,
                        "Field_Visual": "xxxxxxxxxx",
                        "Field_Barcode": "xxxxxxxxxxx",
                        "Matrix": [
                            0,
                            0,
                            0,
                            0,
                            0,
                            0,
                            0,
                            0,
                            3,
                            0
                        ]
                    },
                    {
                        "wLCID": 0,
                        "FieldType": 3,
                        "wFieldType": 3,
                        "Field_MRZ": null,
                        "Field_Visual": "2/25/2013",
                        "Field_Barcode": "2/25/2013",
                        "Matrix": [
                            0,
                            0,
                            2,
                            2,
                            0,
                            0,
                            0,
                            0,
                            3,
                            0
                        ]
                    },
                    {
                        "wLCID": 0,
                        "FieldType": 5,
                        "wFieldType": 5,
                        "Field_MRZ": null,
                        "Field_Visual": "2/25/1983",
                        "Field_Barcode": "2/25/1983",
                        "Matrix": [
                            0,
                            0,
                            0,
                            0,
                            0,
                            0,
                            0,
                            0,
                            3,
                            0
                        ]
                    },
                    {
                        "wLCID": 0,
                        "FieldType": 9,
                        "wFieldType": 9,
                        "Field_MRZ": null,
                        "Field_Visual": null,
                        "Field_Barcode": "FAREN xxxxxx KATE",
                        "Matrix": [
                            0,
                            0,
                            0,
                            0,
                            0,
                            0,
                            0,
                            0,
                            0,
                            0
                        ]
                    },
                    {
                        "wLCID": 0,
                        "FieldType": 11,
                        "wFieldType": 11,
                        "Field_MRZ": null,
                        "Field_Visual": "FIL",
                        "Matrix": [
                            0,
                            0,
                            0,
                            0,
                            0,
                            0,
                            0,
                            0,
                            0,
                            0
                        ]
                    },
                    {
                        "wLCID": 0,
                        "FieldType": 12,
                        "wFieldType": 12,
                        "Field_MRZ": null,
                        "Field_Visual": "F",
                        "Field_Barcode": "F",
                        "Matrix": [
                            0,
                            0,
                            0,
                            0,
                            0,
                            0,
                            0,
                            0,
                            3,
                            0
                        ]
                    },
                    {
                        "wLCID": 0,
                        "FieldType": 13,
                        "wFieldType": 13,
                        "Field_MRZ": null,
                        "Field_Visual": "5 ft 2 in",
                        "Field_Barcode": "5 ft 2 in",
                        "Matrix": [
                            0,
                            0,
                            0,
                            0,
                            0,
                            0,
                            0,
                            0,
                            3,
                            0
                        ]
                    },
                    {
                        "wLCID": 0,
                        "FieldType": 14,
                        "wFieldType": 14,
                        "Field_MRZ": null,
                        "Field_Visual": "149 lbs",
                        "Field_Barcode": "149 lbs",
                        "Matrix": [
                            0,
                            0,
                            0,
                            0,
                            0,
                            0,
                            0,
                            0,
                            3,
                            0
                        ]
                    },
                    {
                        "wLCID": 0,
                        "FieldType": 17,
                        "wFieldType": 17,
                        "Field_MRZ": null,
                        "Field_Visual": "Z635 D-2 AGUHO ST JUNA SUB MATINA DC",
                        "Matrix": [
                            0,
                            0,
                            0,
                            0,
                            0,
                            0,
                            0,
                            0,
                            0,
                            0
                        ]
                    },
                    {
                        "wLCID": 0,
                        "FieldType": 22,
                        "wFieldType": 22,
                        "Field_MRZ": null,
                        "Field_Visual": "2",
                        "Matrix": [
                            0,
                            0,
                            0,
                            0,
                            0,
                            0,
                            0,
                            0,
                            0,
                            0
                        ]
                    },
                    {
                        "wLCID": 0,
                        "FieldType": 25,
                        "wFieldType": 25,
                        "Field_MRZ": null,
                        "Field_Visual": null,
                        "Field_Barcode": "FAREN KERSTEEN KATE MANALILI",
                        "Matrix": [
                            0,
                            0,
                            0,
                            0,
                            0,
                            0,
                            0,
                            0,
                            0,
                            0
                        ]
                    },
                    {
                        "wLCID": 0,
                        "FieldType": 38,
                        "wFieldType": 38,
                        "Field_MRZ": null,
                        "Field_Visual": "Philippines",
                        "Matrix": [
                            0,
                            0,
                            0,
                            0,
                            0,
                            0,
                            0,
                            0,
                            0,
                            0
                        ]
                    },
                    {
                        "wLCID": 0,
                        "FieldType": 146,
                        "wFieldType": 146,
                        "Field_MRZ": null,
                        "Field_Visual": null,
                        "Field_Barcode": "MANALILI",
                        "Matrix": [
                            0,
                            0,
                            0,
                            0,
                            0,
                            0,
                            0,
                            0,
                            0,
                            0
                        ]
                    },
                    {
                        "wLCID": 0,
                        "FieldType": 185,
                        "wFieldType": 185,
                        "Field_MRZ": null,
                        "Field_Visual": "37",
                        "Field_Barcode": "37",
                        "Matrix": [
                            0,
                            0,
                            0,
                            0,
                            0,
                            0,
                            0,
                            0,
                            3,
                            0
                        ]
                    },
                    {
                        "wLCID": 0,
                        "FieldType": 351,
                        "wFieldType": 351,
                        "Field_MRZ": null,
                        "Field_Visual": "L02",
                        "Matrix": [
                            0,
                            0,
                            0,
                            0,
                            0,
                            0,
                            0,
                            0,
                            0,
                            0
                        ]
                    },
                    {
                        "wLCID": 0,
                        "FieldType": 364,
                        "wFieldType": 364,
                        "Field_MRZ": null,
                        "Field_Visual": "0",
                        "Field_Barcode": "0",
                        "Matrix": [
                            0,
                            0,
                            2,
                            2,
                            0,
                            0,
                            0,
                            0,
                            3,
                            0
                        ]
                    }
                ]
            }
        }
    ]
}

Input Example

JSON
{
    "base64ImageString": "/9j/4AAQSkZJRgAB...wEwJefc\r\nf//Z\r\n",
    "backImage":"",
    "apiKey":"API_KEY",               
    "imageFormat":".jpg",
    "imageEnabled":true
}

Last updated