> For the complete documentation index, see [llms.txt](https://docs.vida.id/identity-stack/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.vida.id/identity-stack/verify/document-ai/ocr-and-document-verification/ocr-and-document-verification-v2/full-details-endpoint/perform-ocr-and-id-verification.md). # Perform OCR and ID Verification The OCR + ID Verification service enables simultaneous Optical Character Recognition and Identity Verification. By including both "`ocr`" and "`idVerification`" in the operations list, and supplying the necessary data, users can initiate the processes. **The API concurrently performs both operations and returns the extracted information and verification results.** ### API Description `POST` `https://{vida-host}/api/v2/verify` #### Headers | Name | Type | Description | | ------------------------------------------------ | ---------------- | --------------------------- | | Content-Type | application/json | Format type of request body | | Authentication\* | string | Bearer \ | #### Request Body
NameTypeDescription
operations*String["ocr", "idVerification"]
payload*String

{

"partnerTrxId": "random-uuid",

"groupId": "random-uuid",

"country": "country code",

"idType": "ID_TYPE",

"idSubtype": "IDSubType",

"idFrontSideImage": "Base64 encoded image of ID frontside",

"idBackSideImage": "Base64 encoded image of ID backside" (if enabled)

}

userConsent*String

{

"userIp": "0.0.0.0",

"country": "MYS",

"obtained": true,

"obtainedAt": "1680700959"

}

## Sample Request and Response Example request and response formats are listed below for Malaysian cards, KTP cards and Passports. {% hint style="info" %} **Note:** The response includes a transaction ID, any warnings or errors that arose during processing, and the results of the OCR and ID Verification process. Due to the size of the response, specific result details are truncated in these examples. {% endhint %} ## Malaysian Cards ### Request
Request ```json { "operations": ["ocr", "idVerification"], "payload": { "partnerTrxId": "random-uuid", "groupId": "random-uuid", "idType": "ID_CARD", "country": "MYS", "idSubtype": "MyKad", "idFrontSideImage": "Base64 encoded image of ID front side", "idBackSideImage": "Base64 encoded image of ID back side" //if enabled }, "userConsent": { "userIP": "0.0.0.0", "country": "MYS", "obtained": true, "obtainedAt": "1680700959" } } ```
### Success Response HTTP Status Code: `200` #### MyKad:
Success JSON Response ```json { "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.000444, "threshold": 0.95 }, "lowLight": { "score": 0.065222, "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.098754, "threshold": 0.95 }, "blackWhite": { "score": 0.00696, "threshold": 0.95 }, "colorPrint": { "score": 0.054011, "threshold": 0.95 } }, "landmarkResult": { "code": 5000, "message": "Success", "threshold": 0.95, "containerResult": [ { "name": "card_logo", "score": 0.9832 }, { "name": "hibiscus_logo", "score": 0.9835 }, { "name": "chip", "score": 0.9737 }, { "name": "malaysia_flag", "score": 0.9865 }, { "name": "ghost", "score": 0.9884 }, { "name": "portrait", "score": 0.9632 }, { "name": "msc_logo", "score": 0.9774 }, { "name": "kad_pengenalan_header", "score": 0.9822 }, { "name": "id_number", "score": 0.9933 }, { "name": "name", "score": 0.9879 } ] }, "forgeryResult": { "code": 5000, "message": "Success", "summary": { "score": 0.032141, "threshold": 0.95 } } }, "back": { "spoofingResult": { "message": "Success", "code": 5000, "recapScore": { "score": 0.097883, "threshold": 0.95 }, "blackWhite": { "score": 0.029499, "threshold": 0.95 }, "colorPrint": { "score": 0.1373, "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", "score": 0.997671, "threshold": 0.95 }, "name": { "value": "NAME", "score": 0.999914, "threshold": 0.95 }, "address": { "value": "ADDRESS", "score": 0.995332, "threshold": 0.95 }, "dob": { "value": "YYYYMMDD", "score": 0.997671, "threshold": 0.95 }, "citizenship": { "value": "WARGANEGARA", "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": "Base 64...." } } } ```
#### MyTentera:
Success JSON Response ```json { "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": "MyTentera", "isoAlpha3CountryCode": "MYS", "isoAlpha2CountryCode": "MY" }, "imageQualityResult": { "front": { "blurriness": { "score": 0.03898, "threshold": 0.95 }, "lowLight": { "score": 0.003386, "threshold": 0.95 } }, "back": { "blurriness": { "score": 0.021608, "threshold": 0.95 }, "lowLight": { "score": 0, "threshold": 0.95 } } }, "idVerificationResult": { "front": { "spoofingResult": { "message": "Success", "code": 5000, "recapScore": { "score": 0.105434, "threshold": 0.95 }, "blackWhite": { "score": 0.005061, "threshold": 0.95 }, "colorPrint": { "score": 0.058626, "threshold": 0.95 } }, "landmarkResult": { "code": 5000, "message": "Success", "threshold": 0.95, "containerResult": [ { "name": "chip", "score": 0.9983 }, { "name": "hibiscus_logo", "score": 0.9978 }, { "name": "portrait", "score": 0.9976 }, { "name": "ghost", "score": 0.9973 }, { "name": "name", "score": 0.9972 }, { "name": "card_logo", "score": 0.9969 }, { "name": "msc_logo", "score": 0.9967 }, { "name": "kad_pengenalan_header", "score": 0.9961 }, { "name": "malaysia_flag", "score": 0.9949 }, { "name": "id_number", "score": 0.9929 } ] } }, "back": { "spoofingResult": { "message": "Success", "code": 5000, "recapScore": { "score": 0.127194, "threshold": 0.95 }, "blackWhite": { "score": 0.091711, "threshold": 0.95 }, "colorPrint": { "score": 0.102728, "threshold": 0.95 } }, "landmarkResult": { "code": 5000, "message": "Success", "threshold": 0.95, "containerResult": [ { "name": "kopiah", "score": 0.9976 }, { "name": "military_logo", "score": 0.9952 }, { "name": "coat_of_arm", "score": 0.9948 }, { "name": "state_registrar", "score": 0.9931 }, { "name": "twin_tower", "score": 0.993 }, { "name": "id_number", "score": 0.992 } ] } } }, "ocrResult": { "front": { "data": { "idNumber": { "value": "ID NUMBER", "score": 0.996411, "threshold": 0.95 }, "name": { "value": "NAME", "score": 0.997854, "threshold": 0.95 }, "address": { "value": "ADDRESS", "score": 0.996456, "threshold": 0.95 }, "dob": { "value": "YYYYMMDD", "score": 0.996411, "threshold": 0.95 }, "gender": { "value": "Gender from ID Card (M/F/O)", "score": 1, "threshold": 0.95 }, "religion": { "value": "Religion", "score": 1, "threshold": 0.95 }, "militaryId": { "value": "Military ID", "score": 0.997516, "threshold": 0.95 }, "militaryRank": { "value": "Military Rank", "score": 1, "threshold": 0.95 }, "militaryDivision": { "value": "Military Division", "score": 1, "threshold": 0.95 }, "portraitImage": "{base64}" } }, "back": { "data": { "extendedIdNumber": { "value": "ID NUMBER", "score": 0.993886, "threshold": 0.95 } } } } } ```
#### MyKAS:
Success JSON Response ```json { "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": "MyKas", "isoAlpha3CountryCode": "MYS", "isoAlpha2CountryCode": "MY" }, "imageQualityResult": { "front": { "blurriness": { "score": 0.000004, "threshold": 0.95 }, "lowLight": { "score": 0.114706, "threshold": 0.95 } }, "back": { "blurriness": { "score": 0.000009, "threshold": 0.95 }, "lowLight": { "score": 0, "threshold": 0.95 } } }, "idVerificationResult": { "front": { "spoofingResult": { "message": "Success", "code": 5000, "recapScore": { "score": 0.1315, "threshold": 0.95 }, "blackWhite": { "score": 0.005892, "threshold": 0.95 }, "colorPrint": { "score": 0.063851, "threshold": 0.95 } }, "landmarkResult": { "code": 5000, "message": "Success", "threshold": 0.95, "containerResult": [ { "name": "card_logo", "score": 0.9976 }, { "name": "chip", "score": 0.9968 }, { "name": "portrait", "score": 0.9958 }, { "name": "id_number", "score": 0.9951 }, { "name": "kad_pengenalan_header", "score": 0.9951 }, { "name": "name", "score": 0.9949 }, { "name": "malaysia_flag", "score": 0.9927 } ] } }, "back": { "spoofingResult": { "message": "Success", "code": 5000, "recapScore": { "score": 0.097179, "threshold": 0.95 }, "blackWhite": { "score": 0.040484, "threshold": 0.95 }, "colorPrint": { "score": 0.118763, "threshold": 0.95 } }, "landmarkResult": { "code": 5000, "message": "Success", "threshold": 0.95, "containerResult": [ { "name": "my_logo", "score": 0.9973 }, { "name": "id_number", "score": 0.9963 }, { "name": "coat_of_arm", "score": 0.991 }, { "name": "state_registrar", "score": 0.9846 } ] } } }, "ocrResult": { "front": { "data": { "idNumber": { "value": "ID NUMBER", "score": 0.999603, "threshold": 0.95 }, "name": { "value": "NAME", "score": 0.999227, "threshold": 0.95 }, "address": { "value": "ADDRESS", "score": 0.997943, "threshold": 0.95 }, "dob": { "value": "YYYYMMDD", "score": 0.999603, "threshold": 0.95 }, "dateOfExpiry": { "value": "DATE OF EXPIRY", "score": 0.972226, "threshold": 0.95 }, "citizenship": { "value": "WARGANEGARA", "score": 1, "threshold": 0.95 }, "gender": { "value": "Gender from ID CARD", "score": 1, "threshold": 0.95 }, "religion": { "value": "Religion from ID Card", "score": 1, "threshold": 0.95 }, "portraitImage": "{base64}" } }, "back": { "data": { "extendedIdNumber": { "value": "ID NUMBER", "score": 0.989447, "threshold": 0.95 } } } } } ```
#### MyPR:
Success JSON Response ```json { "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": "MyPR", "isoAlpha3CountryCode": "MYS", "isoAlpha2CountryCode": "MY" }, "imageQualityResult": { "front": { "blurriness": { "score": 0.000053, "threshold": 0.95 }, "lowLight": { "score": 0.166888, "threshold": 0.95 } }, "back": { "blurriness": { "score": 0.000209, "threshold": 0.95 }, "lowLight": { "score": 0, "threshold": 0.95 } } }, "idVerificationResult": { "front": { "spoofingResult": { "message": "Success", "code": 5000, "recapScore": { "score": 0.147336, "threshold": 0.95 }, "blackWhite": { "score": 0.005015, "threshold": 0.95 }, "colorPrint": { "score": 0.355417, "threshold": 0.95 } }, "landmarkResult": { "code": 5000, "message": "Success", "threshold": 0.95, "containerResult": [ { "name": "kad_pengenalan_header", "score": 0.9966 }, { "name": "chip", "score": 0.9965 }, { "name": "portrait", "score": 0.9962 }, { "name": "card_logo", "score": 0.996 }, { "name": "malaysia_flag", "score": 0.9947 }, { "name": "id_number", "score": 0.9946 }, { "name": "name", "score": 0.9935 } ] } }, "back": { "spoofingResult": { "message": "Success", "code": 5000, "recapScore": { "score": 0.116926, "threshold": 0.95 }, "blackWhite": { "score": 0.011473, "threshold": 0.95 }, "colorPrint": { "score": 0.319818, "threshold": 0.95 } }, "landmarkResult": { "code": 5000, "message": "Success", "threshold": 0.95, "containerResult": [ { "name": "coat_of_arm", "score": 0.9972 }, { "name": "id_number", "score": 0.9952 }, { "name": "my_logo", "score": 0.9937 }, { "name": "state_registrar", "score": 0.9927 }, { "name": "negara_asal", "score": 0.9912 } ] } } }, "ocrResult": { "front": { "data": { "idNumber": { "value": "ID NUMBER", "score": 0.998806, "threshold": 0.95 }, "name": { "value": "NAME", "score": 0.999115, "threshold": 0.95 }, "address": { "value": "ADDRESS", "score": 0.99602, "threshold": 0.95 }, "dob": { "value": "YYYYMMDD", "score": 0.998806, "threshold": 0.95 }, "citizenship": { "value": "WARGANEGARA", "score": 1, "threshold": 0.95 }, "gender": { "value": "Gender from ID Card", "score": 1, "threshold": 0.95 }, "religion": { "value": "Religion from ID Card", "score": 1, "threshold": 0.95 }, "portraitImage": "{base64}" } }, "back": { "data": { "extendedIdNumber": { "value": "ID NUMBER", "score": 0.994439, "threshold": 0.95 }, "countryOfOrigin": { "value": "Country of Origin", "score": 0.99833, "threshold": 0.95 } } } } } ```
## KTP ### Request
Request ```json { "operations": ["ocr","idVerification"], "payload": { "partnerTrxId": "{{$guid}}", "groupId":"{{$guid}}", "country": "IDN", "idType": "ID_CARD", "idSubtype": "KTP", "idFrontSideImage":"Base64 encoded image of KTP card" }, "userConsent": { "userIp": "226.80.211.232", "country": "IDN", "obtained": true, "obtainedAt": "1680700959" } } ```
### Success Response HTTP Status Code: `200`
Success JSON Response ```json { "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": "INDONESIA", "type": "KTP", "isoAlpha3CountryCode": "IDN", "isoAlpha2CountryCode": "ID" }, "imageQualityResult": { "front": { "blurriness": { "score": 0.000801, "threshold": 0.95 }, "lowLight": { "score": 0.657333, "threshold": 0.95 }, "overExposure": { "score": 0.508201, "threshold": 0.95 }, "cardDimension": { "card_coordinates": { "x1": 0, "x2": 640, "y1": 1, "y2": 405 }, "card_width": 640, "card_height": 404 } } }, "idVerificationResult": { "front": { "spoofingResult": { "message": "Success", "code": 5000, "recapScore": { "score": 0.154017, "threshold": 0.95 }, "blackWhite": { "score": 0.023498, "threshold": 0.95 }, "colorPrint": { "score": 0.075997, "threshold": 0.95 }, "screenshot": { "score": 0.272087, "threshold": 0.95 } }, "landmarkResult": { "code": 5000, "message": "Success", "threshold": 0.95, "containerResult": [ { "position": { "x": 200, "y": 12, "width": 97, "height": 16 }, "name": "provinsi", "score": 0.9924 }, { "position": { "x": 23, "y": 62, "width": 47, "height": 20 }, "name": "nik", "score": 0.9919 }, { "position": { "x": 20, "y": 99, "width": 39, "height": 12 }, "name": "nama", "score": 0.9907 }, { "position": { "x": 19, "y": 134, "width": 112, "height": 12 }, "name": "tampat-tgl-lahir", "score": 0.9894 }, { "position": { "x": 17, "y": 152, "width": 89, "height": 12 }, "name": "jenis-kelamin", "score": 0.99 }, { "position": { "x": 17, "y": 171, "width": 49, "height": 12 }, "name": "alamat", "score": 0.9908 }, { "position": { "x": 53, "y": 189, "width": 49, "height": 11 }, "name": "rt-rw", "score": 0.9897 }, { "position": { "x": 52, "y": 207, "width": 63, "height": 12 }, "name": "kel-desa", "score": 0.9913 }, { "position": { "x": 52, "y": 226, "width": 76, "height": 12 }, "name": "kecamatan", "score": 0.9905 }, { "position": { "x": 12, "y": 244, "width": 48, "height": 12 }, "name": "agama", "score": 0.9904 }, { "position": { "x": 12, "y": 262, "width": 125, "height": 13 }, "name": "status-perkawinan", "score": 0.9906 }, { "position": { "x": 12, "y": 281, "width": 66, "height": 13 }, "name": "pekerjaan", "score": 0.9913 }, { "position": { "x": 11, "y": 300, "width": 125, "height": 13 }, "name": "kewarganegaraan", "score": 0.9898 }, { "position": { "x": 10, "y": 318, "width": 103, "height": 14 }, "name": "berlaku-hingga", "score": 0.9902 }, { "position": { "x": 314, "y": 152, "width": 72, "height": 11 }, "name": "gol-darah", "score": 0.9923 }, { "position": { "x": 454, "y": 75, "width": 149, "height": 186 }, "name": "portrait", "score": 0.9752 } ], "landmarkTags": [ { "name": "portrait_background_color", "value": "red" } ], "landmarkVerification": [ { "name": "heuristic_check", "status": "pass" } ] }, "forgeryResult": { "code": 5000, "message": "Success", "summary": { "score": 0, "threshold": 0.95 } } } }, "ocrResult": { "front": { "data": { "idNumber": { "value": "ID NUMBER", "score": 0.999994, "threshold": 0.95 }, "name": { "value": "NAME", "score": 0.983342, "threshold": 0.95 }, "address": { "value": "ADDRESS", "score": 0.999744, "threshold": 0.95 }, "dob": { "value": "DD-MM-YYYY", "score": 0.965899, "threshold": 0.95 }, "gender": { "value": "Gender from ID Card", "score": 0.999884, "threshold": 0.95 }, "religion": { "value": "Religion from ID Card", "score": 0.999436, "threshold": 0.95 }, "province": { "value": "Province from ID Card", "score": 0.985587, "threshold": 0.95 }, "city": { "value": "City from ID Card", "score": 0.998896, "threshold": 0.95 }, "placeOfBirth": { "value": "Place of Birth", "score": 0.965899, "threshold": 0.95 }, "bloodType": { "value": "Blood Type", "score": 0.95, "threshold": 0.95 }, "neighborhoodAssociationGroup": { "value": "xxx/xxx", "score": 0.999998, "threshold": 0.95 }, "village": { "value": "Village from ID Card", "score": 0.967507, "threshold": 0.95 }, "subDistrict": { "value": "Sub District from ID Card", "score": 0.999989, "threshold": 0.95 }, "maritalStatus": { "value": "Marital Status", "score": 0.999999, "threshold": 0.95 }, "occupation": { "value": "Occupation from ID Card", "score": 0.999856, "threshold": 0.95 }, "nationality": { "value": "Nationality", "score": 0.980495, "threshold": 0.95 }, "validUntil": { "value": "Card Valid", "score": 0.950421, "threshold": 0.95 }, "portraitImage": "Base 64...." } } }, "duplicateCheckResult": { "docReferences": [], "idNumberReferences": [] } } ```
## Passport ### Request
Request ```json { "operations": ["ocr","idVerification"], "payload": { "partnerTrxId": "{{$guid}}", "groupId":"{{$guid}}", "country": "IND", "idType": "PASSPORT", "idSubtype": "N/A", "idFrontSideImage":"Base64 encoded image of passport front side" }, "userConsent": { "userIp": "226.80.211.232", "country": "IND", "obtained": true, "obtainedAt": "1680700959" } } ```
### Success Response HTTP Status Code: `200`
Success JSON Response 
{
    "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": "COUNTRY",
        "type": "PASSPORT",
        "isoAlpha3CountryCode": "COUNTRY CODE",
        "isoAlpha2CountryCode": "COUNTRY CODE"
    },
    "ocrResult": {
        "front": {
            "data": {
                "idNumber": {
                    "value": "ID NUMBER"
                },
                "name": {
                    "value": "NAME"
                },
                "dob": {
                    "value": "YYYYMMDD"
                },
                "gender": {
                    "value": "Gender from ID Card (M/F)"
                },
                "placeOfBirth": {
                    "value": "Place of Birth"
                },
                "dateOfExpiry": {
                    "value": "Date of Expiry"
                },
                "dateOfIssue": {
                    "value": "Date of Issue"
                },
                "citizenship": {
                    "value": "Citizenship"
                },
                "issuerName": {
                    "value": "Issuer Name"
                },
                "issuerCountry": {
                    "value": "Issuer Country"
                },
                "issuingAuthority": {
                    "value": "Issuing Authority"
                },
                "portraitImage": "Base 64..."
            }
        }
    },
    "idVerificationResult": {
        "front": {
            "spoofingResult": {
                "message": "success",
                "code": 5000
            },
            "landmarkResult": {
                "message": "success",
                "code": 5000
            },
            "forgeryResult": {
                "message": "success",
                "code": 5000
            }
        }
    }
}