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/v1/verify

Headers

Name	Type	Description
Content-Type		Format type of request body
Authentication*	String	Bearer <Token>

Request Body

Name	Type	Description
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" }
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.

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.

Malaysian Cards

Request

Request

{
  "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"
  },
  "userConsent": {
    "userIP": "0.0.0.0",
    "country": "MYS",
    "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",
  "imageQualityResult": {
      "statusCode": 5000
   },
  "card":{
     "country": "MALAYSIA",
     "type": "MyKad",
     "isoAlpha3CountryCode": "MYS",
     "isoAlpha2CountryCode": "MY"
   },
   "ocrResult": {
     "idNumber": "Id Number from the card",
     "name": "Name from id card",
     "address": "Address from id card",
     "dob": "Date of birth in YYYYMMDD format",
     "citizenship": "Citizenship from id card",
     "gender": "Gender from id card (M/F/O)",
     "religion": "Religion from id card"
  }
  "idVerificationResult": {
     "statusCode": 5000
   }
}

KTP

Request

Request

{
    "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

{
    "transactionId": "Transaction Id Generated for this transaction",
    "partnerTrxId": "Partner transaction Id sent by the client",
    "groupId": "Group Id sent by the client",
    "imageQualityResult": {
        "statusCode": 5000
    },
    "card": {
        "country": "INDONESIA",
        "type": "KTP",
        "isoAlpha3CountryCode": "IDN",
        "isoAlpha2CountryCode": "ID"
    },
    "idVerificationResult": {
        "statusCode": 5000
    },
    "ocrResult": {
        "idNumber": "ID-Number",
        "name": "NAME",
        "address": "Address",
        ......[TRUNCATED]....
    }
}

Passport

Request

Request

{
    "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": "ae31c00c-404c-4129-bd34-17ad470583a3",
    "partnerTrxId": "dcc75297-bb57-49b8-84cf-b5e10de608a5",
    "groupId": "0a7d2eca-4829-4d7c-93cb-85f144c60e01",
    "card": {
        "country": "India",
        "type": "PASSPORT",
        "isoAlpha3CountryCode": "IND",
        "isoAlpha2CountryCode": "IN"
    },
    "ocrResult": {
        "idNumber": "Id-Number",
        "personalIdNumber": "Personal Id Number",
        "name": "Name from passport",
        ......[TRUNCATED]....
    },
    "idVerificationResult": {
        "statusCode": 5000
    }
}