Versions

Version 3

POST https://okaydocdemo.innov8tif.com/ekyc/api/passport/v3/verify

Request Body

Name	Type	Description
caseNo	string	Reference code given by user
apiKey*	string	To be assigned by Innov8tif
country*	string	Deprecated IND - India; SGP - Singapore; IDN - Indonesia; BGD - Bangladesh; MMR - Myanmar NPL - Nepal; PAK - Pakistan; PHL - Philippines; VNM - Vietnam OTHER - other countries
halfSizeImage*	string	Half-sized passport image in base64
fullSizeImage	string	Full-sized passport image in base64

200

{
    "status": "success",
    "messageCode": "api.success",
    "message": null,
    "id": "2b76eea1-b236-4024-aeb0-90bc49a7e3b3",
    "methodList": [
        {
            "method": "landmark",
            "label": "Landmark Analysis Result",
            "componentList": [
                {
                    "code": "header",
                    "label": "Vietnamese Header Landmark",
                    "value": "60.82008481025696",
                    "imageUrl": "/public/passport/image/2b76eea1-b236-4024-aeb0-90bc49a7e3b3?type=header",
                    "refImageUrl": null
                },
                {
                    "code": "passport",
                    "label": "Passport Landmark",
                    "value": "81.83062076568604",
                    "imageUrl": "/public/passport/image/2b76eea1-b236-4024-aeb0-90bc49a7e3b3?type=passport",
                    "refImageUrl": null
                },
                {
                    "code": "type",
                    "label": "Passport Type Landmark",
                    "value": "83.63566994667053",
                    "imageUrl": "/public/passport/image/2b76eea1-b236-4024-aeb0-90bc49a7e3b3?type=type",
                    "refImageUrl": null
                },
                {
                    "code": "code",
                    "label": "Passport Code Landmark",
                    "value": "82.72126913070679",
                    "imageUrl": "/public/passport/image/2b76eea1-b236-4024-aeb0-90bc49a7e3b3?type=code",
                    "refImageUrl": null
                },
                {
                    "code": "passportNo",
                    "label": "Passport Number Landmark",
                    "value": "82.41838216781616",
                    "imageUrl": "/public/passport/image/2b76eea1-b236-4024-aeb0-90bc49a7e3b3?type=passportNo",
                    "refImageUrl": null
                },
                {
                    "code": "fullName",
                    "label": "Full Name Landmark",
                    "value": "76.07124447822571",
                    "imageUrl": "/public/passport/image/2b76eea1-b236-4024-aeb0-90bc49a7e3b3?type=fullName",
                    "refImageUrl": null
                },
                {
                    "code": "nationality",
                    "label": "Nationality Landmark",
                    "value": "66.12950563430786",
                    "imageUrl": "/public/passport/image/2b76eea1-b236-4024-aeb0-90bc49a7e3b3?type=nationality",
                    "refImageUrl": null
                },
                {
                    "code": "vietnamese",
                    "label": "Vietnamese Landmark",
                    "value": "77.0861268043518",
                    "imageUrl": "/public/passport/image/2b76eea1-b236-4024-aeb0-90bc49a7e3b3?type=vietnamese",
                    "refImageUrl": null
                },
                {
                    "code": "dob",
                    "label": "Date Of Birth Landmark",
                    "value": "77.08222270011902",
                    "imageUrl": "/public/passport/image/2b76eea1-b236-4024-aeb0-90bc49a7e3b3?type=dob",
                    "refImageUrl": null
                },
                {
                    "code": "placeOfBirth",
                    "label": "Place Of Birth Landmark",
                    "value": "73.21337461471558",
                    "imageUrl": "/public/passport/image/2b76eea1-b236-4024-aeb0-90bc49a7e3b3?type=placeOfBirth",
                    "refImageUrl": null
                },
                {
                    "code": "sex",
                    "label": "Sex Landmark",
                    "value": "80.52845597267151",
                    "imageUrl": "/public/passport/image/2b76eea1-b236-4024-aeb0-90bc49a7e3b3?type=sex",
                    "refImageUrl": null
                },
                {
                    "code": "idCardNo",
                    "label": "ID Card Number Landmark",
                    "value": "68.65991950035095",
                    "imageUrl": "/public/passport/image/2b76eea1-b236-4024-aeb0-90bc49a7e3b3?type=idCardNo",
                    "refImageUrl": null
                },
                {
                    "code": "issueDate",
                    "label": "Date Of Issue Landmark",
                    "value": "73.93900752067566",
                    "imageUrl": "/public/passport/image/2b76eea1-b236-4024-aeb0-90bc49a7e3b3?type=issueDate",
                    "refImageUrl": null
                },
                {
                    "code": "expiryDate",
                    "label": "Date Of Expiry Landmark",
                    "value": "78.18787097930908",
                    "imageUrl": "/public/passport/image/2b76eea1-b236-4024-aeb0-90bc49a7e3b3?type=expiryDate",
                    "refImageUrl": null
                },
                {
                    "code": "issuePlace",
                    "label": "Place Of Issue Landmark",
                    "value": "74.9876081943512",
                    "imageUrl": "/public/passport/image/2b76eea1-b236-4024-aeb0-90bc49a7e3b3?type=issuePlace",
                    "refImageUrl": null
                }
            ]
        },
        {
            "method": "ocr",
            "label": "Ocr Analysis Result",
            "componentList": [
                {
                    "code": "roi-passportName",
                    "label": "Name",
                    "value": "NA",
                    "imageUrl": "/public/passport/image/2b76eea1-b236-4024-aeb0-90bc49a7e3b3?type=roi-passportName",
                    "refImageUrl": null
                },
                {
                    "code": "roi-passportDob",
                    "label": "DOB",
                    "value": "NA",
                    "imageUrl": "/public/passport/image/2b76eea1-b236-4024-aeb0-90bc49a7e3b3?type=roi-passportDob",
                    "refImageUrl": null
                },
                {
                    "code": "roi-expiryDate",
                    "label": "Expiry Date",
                    "value": "NA",
                    "imageUrl": "/public/passport/image/2b76eea1-b236-4024-aeb0-90bc49a7e3b3?type=roi-expiryDate",
                    "refImageUrl": null
                },
                {
                    "code": "roi-passportNoHalf",
                    "label": "Passport No (Half)",
                    "value": "NA",
                    "imageUrl": "/public/passport/image/2b76eea1-b236-4024-aeb0-90bc49a7e3b3?type=roi-passportNoHalf",
                    "refImageUrl": null
                }
            ]
        },
        {
            "method": "idBlurDetection",
            "label": "Blurriness Detection",
            "componentList": [
                {
                    "code": "idBlurDetection",
                    "label": "Blurriness Detection",
                    "value": "Pass",
                    "imageUrl": null,
                    "refImageUrl": null
                }
            ]
        },
        {
            "method": "idBrightnessDetc",
            "label": "Brightness Detection",
            "componentList": [
                {
                    "code": "idBrightnessDetc",
                    "label": "Brightness Detection",
                    "value": "Pass",
                    "imageUrl": null,
                    "refImageUrl": null
                }
            ]
        },
        {
            "method": "colorMode",
            "label": "Color Detection",
            "componentList": [
                {
                    "code": "colorMode",
                    "label": "Color Detection",
                    "value": "Pass",
                    "imageUrl": null,
                    "refImageUrl": null
                }
            ]
        },
        {
            "method": "screen",
            "label": "Screen Detection",
            "componentList": [
                {
                    "code": "screen",
                    "label": "Screen Detection",
                    "value": "Pass",
                    "imageUrl": null,
                    "refImageUrl": null
                }
            ]
        }
    ],
    "outputImageList": null
}

400: Bad Request

{
    // Response
}

500: Internal Server Error

{
    // Response
}

Postman Collection

735B

OkayDoc Passport - v3.postman_collection.rar

OkayDoc Passport v3

Version 2

POST https://okaydocdemo.innov8tif.com/ekyc/api/passport/v2/verify

Request Body

Name	Type	Description
caseNo	string	Reference code given by user
apiKey*	string	To be assigned by Innov8tif
country*	string	Deprecated IND - India; SGP - Singapore; IDN - Indonesia; BGD - Bangladesh; MMR - Myanmar NPL - Nepal; PAK - Pakistan; PHL - Philippines; VNM - Vietnam OTHER - other countries This will return color and screen detection result only.
halfSizeImage*	string	Half-sized passport image in base64
fullSizeImage	string	Full-sized passport image in base64

200

{
    "status": "success",
    "messageCode": "api.success",
    "message": null,
    "id": "98a1fb7e-b9b9-4398-a00e-aeee340569cb",
    "methodList": [
        {
            "method": "landmark",
            "label": "Landmark Analysis Result",
            "componentList": [
                {
                    "code": "passport",
                    "label": "Passport Landmark",
                    "value": "82.73033499717712",
                    "imageUrl": "/public/passport/image/98a1fb7e-b9b9-4398-a00e-aeee340569cb?type=passport",
                    "refImageUrl": null
                },
                {
                    "code": "type",
                    "label": "Type Landmark",
                    "value": "69.60739493370056",
                    "imageUrl": "/public/passport/image/98a1fb7e-b9b9-4398-a00e-aeee340569cb?type=type",
                    "refImageUrl": null
                },
                {
                    "code": "countryCode",
                    "label": "Country Code Landmark",
                    "value": "64.17597532272339",
                    "imageUrl": "/public/passport/image/98a1fb7e-b9b9-4398-a00e-aeee340569cb?type=countryCode",
                    "refImageUrl": null
                },
                {
                    "code": "passportNo",
                    "label": "Passport Number Landmark",
                    "value": "54.463547468185425",
                    "imageUrl": "/public/passport/image/98a1fb7e-b9b9-4398-a00e-aeee340569cb?type=passportNo",
                    "refImageUrl": null
                },
                {
                    "code": "surname",
                    "label": "Surname Landmark",
                    "value": "71.06456756591797",
                    "imageUrl": "/public/passport/image/98a1fb7e-b9b9-4398-a00e-aeee340569cb?type=surname",
                    "refImageUrl": null
                },
                {
                    "code": "givenName",
                    "label": "Given Name Landmark",
                    "value": "72.5123405456543",
                    "imageUrl": "/public/passport/image/98a1fb7e-b9b9-4398-a00e-aeee340569cb?type=givenName",
                    "refImageUrl": null
                },
                {
                    "code": "nationality",
                    "label": "Nationality Landmark",
                    "value": "72.50398993492126",
                    "imageUrl": "/public/passport/image/98a1fb7e-b9b9-4398-a00e-aeee340569cb?type=nationality",
                    "refImageUrl": null
                },
                {
                    "code": "dob",
                    "label": "Date Of Birth Landmark",
                    "value": "71.727055311203",
                    "imageUrl": "/public/passport/image/98a1fb7e-b9b9-4398-a00e-aeee340569cb?type=dob",
                    "refImageUrl": null
                },
                {
                    "code": "citizenship",
                    "label": "Citizenship Number Landmark",
                    "value": "58.645421266555786",
                    "imageUrl": "/public/passport/image/98a1fb7e-b9b9-4398-a00e-aeee340569cb?type=citizenship",
                    "refImageUrl": null
                },
                {
                    "code": "sex",
                    "label": "Sex Landmark",
                    "value": "72.27083444595337",
                    "imageUrl": "/public/passport/image/98a1fb7e-b9b9-4398-a00e-aeee340569cb?type=sex",
                    "refImageUrl": null
                },
                {
                    "code": "placeOfBirth",
                    "label": "Place Of Birth Landmark",
                    "value": "64.38571810722351",
                    "imageUrl": "/public/passport/image/98a1fb7e-b9b9-4398-a00e-aeee340569cb?type=placeOfBirth",
                    "refImageUrl": null
                },
                {
                    "code": "issueDate",
                    "label": "Date Of Issue Landmark",
                    "value": "70.86160778999329",
                    "imageUrl": "/public/passport/image/98a1fb7e-b9b9-4398-a00e-aeee340569cb?type=issueDate",
                    "refImageUrl": null
                },
                {
                    "code": "issueAuthority",
                    "label": "Issuing Authority",
                    "value": "53.99036407470703",
                    "imageUrl": "/public/passport/image/98a1fb7e-b9b9-4398-a00e-aeee340569cb?type=issueAuthority",
                    "refImageUrl": null
                },
                {
                    "code": "expiryDate",
                    "label": "Date Of Expiry Landmark",
                    "value": "69.29136514663696",
                    "imageUrl": "/public/passport/image/98a1fb7e-b9b9-4398-a00e-aeee340569cb?type=expiryDate",
                    "refImageUrl": null
                },
                {
                    "code": "holderSignature",
                    "label": "Holder Signature Landmark",
                    "value": "54.51650619506836",
                    "imageUrl": "/public/passport/image/98a1fb7e-b9b9-4398-a00e-aeee340569cb?type=holderSignature",
                    "refImageUrl": null
                }
            ]
        },
        {
            "method": "ocr",
            "label": "Ocr Analysis Result",
            "componentList": [
                {
                    "code": "roi-passportNoDot",
                    "label": "Passport No (Dot)",
                    "value": "NA",
                    "imageUrl": "/public/passport/image/98a1fb7e-b9b9-4398-a00e-aeee340569cb?type=roi-passportNoDot",
                    "refImageUrl": null
                },
                {
                    "code": "roi-passportName",
                    "label": "Name",
                    "value": "NA",
                    "imageUrl": "/public/passport/image/98a1fb7e-b9b9-4398-a00e-aeee340569cb?type=roi-passportName",
                    "refImageUrl": null
                },
                {
                    "code": "roi-passportDob",
                    "label": "DOB",
                    "value": "NA",
                    "imageUrl": "/public/passport/image/98a1fb7e-b9b9-4398-a00e-aeee340569cb?type=roi-passportDob",
                    "refImageUrl": null
                },
                {
                    "code": "roi-expiryDate",
                    "label": "Expiry Date",
                    "value": "NA",
                    "imageUrl": "/public/passport/image/98a1fb7e-b9b9-4398-a00e-aeee340569cb?type=roi-expiryDate",
                    "refImageUrl": null
                },
                {
                    "code": "roi-passportNoHalf",
                    "label": "Passport No (Half)",
                    "value": "NA",
                    "imageUrl": "/public/passport/image/98a1fb7e-b9b9-4398-a00e-aeee340569cb?type=roi-passportNoHalf",
                    "refImageUrl": null
                }
            ]
        },
        {
            "method": "blurrinessDetection",
            "label": "Blurriness Detection",
            "componentList": [
                {
                    "code": "blurrinessDetection",
                    "label": "Blurriness Detection",
                    "value": "Pass",
                    "imageUrl": null,
                    "refImageUrl": null
                }
            ]
        },
        {
            "method": "brightnessDetection",
            "label": "Brightness Detection",
            "componentList": [
                {
                    "code": "brightnessDetection",
                    "label": "Brightness Detection",
                    "value": "Pass",
                    "imageUrl": null,
                    "refImageUrl": null
                }
            ]
        },
        {
            "method": "colorDetection",
            "label": "Color Detection",
            "componentList": [
                {
                    "code": "colorDetection",
                    "label": "Color Detection",
                    "value": "Pass",
                    "imageUrl": null,
                    "refImageUrl": null
                }
            ]
        }
    ],
    "outputImageList": null
}

201 Please note that OTHER will only check for color detection and screen detection

{
    "status": "success",
    "messageCode": "api.success",
    "message": null,
    "id": "cbcd992e-d7c0-47d1-9489-911d68a3eeae",
    "methodList": [
        {
            "method": "colorMode",
            "label": "Color Detection",
            "componentList": [
                {
                    "code": "colorMode",
                    "label": "Color Detection",
                    "value": "Pass",
                    "imageUrl": null,
                    "refImageUrl": null
                }
            ]
        },
        {
            "method": "screen",
            "label": "Screen Detection",
            "componentList": [
                {
                    "code": "screen",
                    "label": "Screen Detection",
                    "value": "Pass",
                    "imageUrl": null,
                    "refImageUrl": null
                }
            ]
        }
    ],
    "outputImageList": null
}

400: Bad Request

{
    // Response
}

500: Internal Server Error

{
    // Response
}

Postman Collection

602B

OkayDoc Passport v2.postman_collection.rar

OkayDoc Passport v2

Version 1 (Deprecated)

POST https://okaydocdemo.innov8tif.com/ekyc/api/passport/v1/verify

Request Body

Name	Type	Description
caseNo	string	Reference code given by user
apiKey*	string	To be assigned by Innov8tif
country*	string	IND - India; SGP - Singapore; IDN - Indonesia; BGD - Bangladesh; MMR - Myanmar NPL - Nepal; PAK - Pakistan; PHL - Philippines; VNM - Vietnam
halfSizeImage*	string	Half-sized passport image in base64
fullSizeImage	string	Full-sized passport image in base64

200

{
    "status": "success",
    "landmarkCheckingList": [
        {
            "landmarkCode": "passport",
            "landmarkLabel": "Passport Landmark",
            "score": 99.89253878593445,
            "imageUrl": "/public/passport/image/xxxxxxxxxxxx?type=passport"
        },
        {
            "landmarkCode": "type",
            "landmarkLabel": "Type Landmark",
            "score": 99.86854791641235,
            "imageUrl": "/public/passport/image/xxxxxxxxxxxxxxxxxxxxxx?type=type"
        },
        {
            "landmarkCode": "countryCode",
            "landmarkLabel": "Country Code Landmark",
            "score": 99.84298348426819,
            "imageUrl": "/public/passport/image/xxxxxxxxxxxxxxxxxxxxxx?type=countryCode"
        },
        {
            "landmarkCode": "passportNo",
            "landmarkLabel": "Passport Number Landmark",
            "score": 99.79193806648254,
            "imageUrl": "/public/passport/image/xxxxxxxxxxxxxxxxxxxxx?type=passportNo"
        },
        {
            "landmarkCode": "surname",
            "landmarkLabel": "Surname Landmark",
            "score": 99.85193610191345,
            "imageUrl": "/public/passport/image/xxxxxxxxxxxxxxxxx?type=surname"
        },
        {
            "landmarkCode": "givenName",
            "landmarkLabel": "Given Name Landmark",
            "score": 99.88807439804077,
            "imageUrl": "/public/passport/image/xxxxxxxxxxxxxxxxxxx?type=givenName"
        },
        {
            "landmarkCode": "nationality",
            "landmarkLabel": "Nationality Landmark",
            "score": 99.88081455230713,
            "imageUrl": "/public/passport/image/xxxxxxxxxxxxxxxxxxxxxxxx?type=nationality"
        },
        {
            "landmarkCode": "dob",
            "landmarkLabel": "Date Of Birth Landmark",
            "score": 99.89277720451355,
            "imageUrl": "/public/passport/image/xxxxxxxxxxxxxxxxxxxxxxxxxx?type=dob"
        },
        {
            "landmarkCode": "citizenship",
            "landmarkLabel": "Citizenship Number Landmark",
            "score": 99.89938735961914,
            "imageUrl": "/public/passport/image/xxxxxxxxxxxxxxxxxxxxx?type=citizenship"
        },
        {
            "landmarkCode": "sex",
            "landmarkLabel": "Sex Landmark",
            "score": 99.86341595649719,
            "imageUrl": "/public/passport/image/xxxxxxxxxxxxxxxxxxxxxxx?type=sex"
        },
        {
            "landmarkCode": "placeOfBirth",
            "landmarkLabel": "Place Of Birth Landmark",
            "score": 99.86541271209717,
            "imageUrl": "/public/passport/image/xxxxxxxxxxxxxxxxxxxxxxxxxxx?type=placeOfBirth"
        },
        {
            "landmarkCode": "fatherName",
            "landmarkLabel": "Father Name Landmark",
            "score": 99.87720251083374,
            "imageUrl": "/public/passport/image/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx?type=fatherName"
        },
        {
            "landmarkCode": "issueDate",
            "landmarkLabel": "Date Of Issue Landmark",
            "score": 99.89170432090759,
            "imageUrl": "/public/passport/image/xxxxxxxxxxxxxxxxxxxxxxxxxxxx?type=issueDate"
        },
        {
            "landmarkCode": "issueAuthority",
            "landmarkLabel": "Issuing Authority",
            "score": 99.8862624168396,
            "imageUrl": "/public/passport/image/xxxxxxxxxxxxxxxxxxxxxxxxxxx?type=issueAuthority"
        },
        {
            "landmarkCode": "expiryDate",
            "landmarkLabel": "Date Of Expiry Landmark",
            "score": 99.88948702812195,
            "imageUrl": "/public/passport/image/xxxxxxxxxxxxxxxxxxxxxxxxxxx?type=expiryDate"
        },
        {
            "landmarkCode": "trackigNo",
            "landmarkLabel": "Tracking Number Landmark",
            "score": 99.90541934967041,
            "imageUrl": "/public/passport/image/xxxxxxxxxxxxxxxxxxxxxxxxxxx?type=trackigNo"
        },
        {
            "landmarkCode": "bookletNo",
            "landmarkLabel": "Booklet Number Landmark",
            "score": 99.87479448318481,
            "imageUrl": "/public/passport/image/xxxxxxxxxxxxxxxxxxxxxxxxxx?type=bookletNo"
        }
    ],
    "ocrRoiList": [
        {
            "ocrRoiCode": "roi-passportNoDot",
            "ocrRoiLabel": "Passport No (Dot)",
            "ocrValue": "",
            "imageUrl": ""
        },
        {
            "ocrRoiCode": "roi-passportName",
            "ocrRoiLabel": "Name",
            "ocrValue": "",
            "imageUrl": "/public/passport/image/xxxxxxxxxxxxxxxxxxxxxxxxxx?type=roi-passportName"
        },
        {
            "ocrRoiCode": "roi-passportDob",
            "ocrRoiLabel": "DOB",
            "ocrValue": "",
            "imageUrl": "/public/passport/image/xxxxxxxxxxxxxxxxxxxxxxxxx?type=roi-passportDob"
        },
        {
            "ocrRoiCode": "roi-expiryDate",
            "ocrRoiLabel": "Expiry Date",
            "ocrValue": "",
            "imageUrl": "/public/passport/image/xxxxxxxxxxxxxxxxxxxxx?type=roi-expiryDate"
        },
        {
            "ocrRoiCode": "roi-passportNoHalf",
            "ocrRoiLabel": "Passport No (Half)",
            "ocrValue": "",
            "imageUrl": "/public/passport/image/xxxxxxxxxxxxxxxxxxxxxx?type=roi-passportNoHalf"
        }
Versio    ]}

400: Bad Request

{
    // Response
}

500: Internal Server Error

{
    // Response
}

Postman Collection

609B

OkayDoc Passport.postman_collection.rar

OkayDoc Passport v1