Introducing VIDA Identity Stack: All of VIDA, in one place 🎉
For the complete documentation index, see llms.txt. This page is also available as Markdown.

All Error Scenarios related to OCR+IDV

This page contains the samples for the different error scenarios possible for the OCR+IDV operation.

Note : In case of any error messages in response like 'No card detected' and 'Bad Quality Image, Id Number Extraction Failed' then in this case card details won't be generated.

Response
"card":{
    "country": "COUNTRY",
    "type": "CARD_TYPE",
    "isoAlpha3CountryCode": "Alpha 3 Country Code",
    "isoAlpha2CountryCode": "Alpha 2 Country Code"
},

Success - 5000

Request Sample
{
    "operations": ["ocr","idVerification"],
    "payload": {
        "partnerTrxId": "{{$guid}}",
        "groupId":"{{$guid}}",
        "country": "MYS",
        "idType": "ID_CARD",
        "idSubtype": "MyKas",
        "idFrontSideImage":"", //Base64 encoded image of Front Side ID Card
        "idBackSideImage": "" //Base64 encoded image of Back Side ID Card, If enabled
    },
    "userConsent": {
        "userIp": "226.80.211.232",
        "country": "MYS",
        "obtained": true,
        "obtainedAt": "1680700959"
    }
}
Response Sample
{
    "transactionId": "unique transaction id generated to identify this transaction",
    "partnerTrxId": "partner transaction id submitted by customer in request",
    "groupId": "partner group id submitted by customer in request",    
    "card": {
        "country": "MALAYSIA",
        "type": "MyKad",
        "isoAlpha3CountryCode": "MYS",
        "isoAlpha2CountryCode": "MY"
    },
    "imageQualityResult": {
        "front": {
            "glare": {
                "score": 0,
                "threshold": 0.95
            },
            "blurriness": {
                "score": 0.0008,
                "threshold": 0.95
            },
            "lowLight": {
                "score": 0.076793,
                "threshold": 0.95
            }
        },
        "back": {
            "blurriness": {
                "score": 0.003535,
                "threshold": 0.95
            },
            "lowLight": {
                "score": 0,
                "threshold": 0.95
            }
        }
    },
    "idVerificationResult": {
        "front": {
            "spoofingResult": {
                "message": "Success",
                "code": 5000,
                "recapScore": {
                    "score": 0.156807,
                    "threshold": 0.95
                },
                "blackWhite": {
                    "score": 0.005257,
                    "threshold": 0.95
                }
            },
            "landmarkResult": {
                "code": 5000,
                "message": "Success",
                "threshold": 0.95,
                "containerResult": [
                    {
                        "name": "card_logo",
                        "score": 0.9831
                    },
                    {
                        "name": "chip",
                        "score": 0.9748
                    },
                    {
                        "name": "hibiscus_logo",
                        "score": 0.9832
                    },
                    {
                        "name": "malaysia_flag",
                        "score": 0.9882
                    },
                    {
                        "name": "ghost",
                        "score": 0.9891
                    },
                    {
                        "name": "portrait",
                        "score": 0.9691
                    },
                    {
                        "name": "msc_logo",
                        "score": 0.9785
                    },
                    {
                        "name": "kad_pengenalan_header",
                        "score": 0.9847
                    },
                    {
                        "name": "id_number",
                        "score": 0.9941
                    },
                    {
                        "name": "name",
                        "score": 0.9915
                    }
                ]
            },
            "forgeryResult": {
                "code": 5000,
                "message": "Success",
                "summary": {
                    "score": 0.257167,
                    "threshold": 0.95
                }
            }
        },
        "back": {
            "spoofingResult": {
                "message": "Success",
                "code": 5000,
                "recapScore": {
                    "score": 0.270645,
                    "threshold": 0.95
                },
                "blackWhite": {
                    "score": 0.014498,
                    "threshold": 0.95
                }
            },
            "landmarkResult": {
                "code": 5000,
                "message": "Success",
                "threshold": 0.95,
                "containerResult": [
                    {
                        "name": "coat_of_arm",
                        "score": 0.9956
                    },
                    {
                        "name": "kopiah",
                        "score": 0.995
                    },
                    {
                        "name": "twin_tower",
                        "score": 0.9934
                    },
                    {
                        "name": "state_registrar",
                        "score": 0.9913
                    },
                    {
                        "name": "id_number",
                        "score": 0.9906
                    },
                    {
                        "name": "sn",
                        "score": 0.9911
                    }
                ]
            }
        }
    },
    "ocrResult": {
        "front": {
            "data": {
                "idNumber": {
                    "value": "ID Number from ID Card",
                    "score": 0.993373,
                    "threshold": 0.95
                },
                "name": {
                    "value": "Name",
                    "score": 0.999926,
                    "threshold": 0.95
                },
                "address": {
                    "value": "Address",
                    "score": 0.997141,
                    "threshold": 0.95
                },
                "dob": {
                    "value": "YYYY-MM-DD",
                    "score": 0.993373,
                    "threshold": 0.95
                },
                "citizenship": {
                    "value": "Citizenship",
                    "score": 1,
                    "threshold": 0.95
                },
                "gender": {
                    "value": "Gender from ID Card",
                    "score": 1,
                    "threshold": 0.95
                },
                "religion": {
                    "value": "Religion",
                    "score": 1,
                    "threshold": 0.95
                },
                "portraitImage": "Base64 encoded..."
                 }
        },
        "back": {
            "data": {
                "extendedIdNumber": {
                    "value": "xxxxxx-xx-xxxx-xx-xx",
                    "score": 0.988594,
                    "threshold": 0.95
                }
            }
        }
    }
}

Error - 5001 - Missing required fields in the request parameter

Case - Missing idFrontSideImage

Request Sample
{
    "operations": ["ocr","idVerification"],
    "payload": {
        "partnerTrxId": "{{$guid}}",
        "groupId":"{{$guid}}",
        "country": "MYS",
        "idType": "ID_CARD",
        "idSubtype": "MyKas",
        "idFrontSideImage":"" //Missing idFrontSide base 64 string
    },
    "userConsent": {
        "userIp": "226.80.211.232",
        "country": "MYS",
        "obtained": true,
        "obtainedAt": "1680700959"
    }
}
Response Sample

Case - Multiple mandatory field missing like groupId and idType

Request Sample
Response Sample

Error - 5002 - Unable to decode string in request body

Case - Invalid Base64 String passed in the request

Request Sample
Response Sample

Error - 5003 -Invalid request parameter or Missing request parameter.

Note: The above issue happens when the some validations fail on the request body sent. Some samples of the possible causes 5003 are given below. The message will differ for this error scenario according to the type of validation that fails.

Some samples of this validation failures are given below ->

Case - InValid JSON Payload sent

Request Sample
Response

Case - Invalid Id Type Sent

Request
Response

Case - Invalid Id Subtype Sent

Request
Response

Case - Invalid Country Codes Sent

Request
Response

Case - Duplicate partner transaction Id's are not allowed

Request
Response
Request
Response

Case - Country code size greater than 3.

Request
Response

Case - Partner transaction and groupId size must not be greater than 255.

Request
Response

Error - 5005 -Internal Server Error

Request
Response

Error - 5005 -extraction_failed

Request
Response

Error - 5006 - Unsupported Image Format Detected

Request
Response

Error - 5008 - Data Processing Error

Request
Response

Error - 5009 - Wrong input format of the image given

Request
Response

Error - 5010-Invalid Image Specification

Request
Response

Error - 5012 - Score is above threshold

Note: The above error code occurs when 2 or more spoof check fails for the malayian id cards or KTP cards. The warning's show which spoof checks have failed.

Request
Response

Error - 5014 - Image quality failure

Request
Response

Error - 5016 - Invalid card detected, make sure the lighting and orientation is proper.

Request
Response

Error - 5020 - When the image sent doesn't contain a card

Request
Response

Error - 5022 - Internal Server Error Occurred

Request
Response

Error - 5023 - IdNumber extraction failed.

Note: Currently this error occurs for the malaysia cards only. This happens when the idnumber is not extracted properly causing the dob extraction to fail which is extracted from the idnumber in the malaysian id cards.

Request
Response

Error - 5024 - Forgery failed

Note: This error code occurs when there is forgery failure for the malaysian cards or the KTP forgery failure.

Request
Response

Error - 5025 - The card failed the IdVerification

Note: This error code occurs when there is a IdVerification failure in the summary response api.

Request
Response

Error - 5026 - Extraction failure for ocr fields.

Request
Response

Error - 5029 - Critical Landmarks Fields Missing

Request
Response

Error - 5201 - No portrait image present

Request
Response

Error - 5202 - Image is too blurry

Request
Response

Error - 5203 - Image is too dark

Request
Response

Error - 5204 - Image is too bright

Request
Response

Error - 5205 - Image of the card is too small

Request
Response

Error - 5206 - Provinsi title is missing

Request
Response

Error - 5301 - Image resolution is very small

Request
Response

Error - 5302 - Image resolution is very big

Request
Response

Error - 5303 - Image size is larger than 3 MB.

Request
Response

Error - 5401 - Unknown card orientation

Request
Response

Error - 5101 - No card detected.

Request
Response

Error - 5102 - Error processing input/output

Request
Response

Error - 5103 - Bad Quality Image, Portrait Extraction Failed

Request
Response

Error - 5104 - OCR Min Fields Failed

Request
Response

Error - 5322 - Send Backside image in V1

Request
Response

Error - 5611 - Landmark Min Fields Failed

Request
Response

Error - 5613 - Landmark Positions are not Correct

Request
Response

Last updated