Australia

1. Direct API integration

a) Perform a Gov val with Passport:

Request:

POST /omni/process/government-validation?countryCode=AUS
{
    "firstName": "VINCE",
    "middleName": "",
    "paternalLastName": "CITIZEN",
    "cic": "PA0001317", // Passport number
    "documentType": "Passport",
    "birthDate": "2013/03/01"
}

Response:

{
   "valid":true,
   "statusCode":0,
   "governmentValidation":{
      "validationStatus":{
         "value":"0",
         "status":"OK",
         "key":"ok"
      },
      "ocrValidation":[
         {
            "value":"true",
            "status":"OK",
            "key":"documentNumber"
         },
         {
            "value":"true",
            "status":"OK",
            "key":"paternalLastName"
         },
         {
            "value":"true",
            "status":"OK",
            "key":"firstName"
         },
         {
            "value":"true",
            "status":"OK",
            "key":"birthDate"
         },
         {
            "value":"true",
            "status":"OK",
            "key":"expirationDate"
         },
         {
            "value":"true",
            "status":"OK",
            "key":"issueDate"
         }
      ],
      "ocrValidationOverall":{
         "value":"100.0",
         "status":"OK"
      },
      "overall":{
         "value":"100.0",
         "status":"OK"
      }
   }
}

b) Perform a Gov val with Driver license:

Request:

POST /omni/process/government-validation?countryCode=AUS

{
    "firstName": "TIM",
    "middleName": "",
    "paternalLastName": "CITIZEN",
    "documentType": "DriversLicense",
    "birthDate": "1970/02/21",
    "refNumber": "A968754", // Card number
    "cic": "1948573847", // License number
    "issuerState": "NSW"
}

Response:


{
   "valid":true,
   "statusCode":0,
   "governmentValidation":{
      "validationStatus":{
         "value":"0",
         "status":"OK",
         "key":"ok"
      },
      "ocrValidation":[
         {
            "value":"true",
            "status":"OK",
            "key":"documentNumber"
         },
         {
            "value":"true",
            "status":"OK",
            "key":"paternalLastName"
         },
         {
            "value":"true",
            "status":"OK",
            "key":"firstName"
         },
         {
            "value":"true",
            "status":"OK",
            "key":"birthDate"
         },
         {
            "value":"true",
            "status":"OK",
            "key":"expirationDate"
         },
         {
            "value":"true",
            "status":"OK",
            "key":"issueDate"
         }
      ],
      "ocrValidationOverall":{
         "value":"100.0",
         "status":"OK"
      },
      "overall":{
         "value":"100.0",
         "status":"OK"
      }
   }
}

2. ID Capture + Gov Val (no need to send any body payload we will take the data needed from OCR)

Accepted OCR docs: Passport, Driver License

This endpoint performs Government Validation using data captured from OCR. No request body is required.

Request:
POST /omni/process/government-validation

Response:

{
   "valid":true,
   "statusCode":0,
   "governmentValidation":{
      "validationStatus":{
         "value":"0",
         "status":"OK",
         "key":"ok"
      },
      "ocrValidation":[
         {
            "value":"true",
            "status":"OK",
            "key":"documentNumber"
         },
         {
            "value":"true",
            "status":"OK",
            "key":"paternalLastName"
         },
         {
            "value":"true",
            "status":"OK",
            "key":"firstName"
         },
         {
            "value":"true",
            "status":"OK",
            "key":"birthDate"
         },
         {
            "value":"true",
            "status":"OK",
            "key":"expirationDate"
         },
         {
            "value":"true",
            "status":"OK",
            "key":"issueDate"
         }
      ],
      "ocrValidationOverall":{
         "value":"100.0",
         "status":"OK"
      },
      "overall":{
         "value":"100.0",
         "status":"OK"
      }
   }
}

Responses types:

Success Response:

{
   "valid":true,
   "statusCode":0,
   "governmentValidation":{
      "validationStatus":{
         "value":"0",
         "status":"OK",
         "key":"ok"
      },
      "ocrValidation":[
         {
            "value":"true",
            "status":"OK",
            "key":"documentNumber"
         },
         {
            "value":"true",
            "status":"OK",
            "key":"paternalLastName"
         },
         {
            "value":"true",
            "status":"OK",
            "key":"firstName"
         },
         {
            "value":"true",
            "status":"OK",
            "key":"birthDate"
         },
         {
            "value":"true",
            "status":"OK",
            "key":"expirationDate"
         },
         {
            "value":"true",
            "status":"OK",
            "key":"issueDate"
         }
      ],
      "ocrValidationOverall":{
         "value":"100.0",
         "status":"OK"
      },
      "overall":{
         "value":"100.0",
         "status":"OK"
      }
   }
}

No match response:

{
    "valid": false,
    "statusCode": 7,
    "governmentValidation": {
        "validationStatus": {
            "value": "7",
            "status": "FAIL",
            "key": "userNotFound"
        },
        "overall": {
            "status": "FAIL"
        }
    },
    "errorDescription": "userNotFound"
}

Connection Error Response

{
    "valid": false,
    "statusCode": 7,
    "governmentValidation": {
        "validationStatus": {
            "value": "17",
            "status": "CONNECTION_ERROR",
            "key": "connectionError"
        },
        "overall": {
            "status": "FAIL"
        }
    },
    "errorDescription": "connectionError"
}

Incomplete data Response

{
    "valid": false,
    "statusCode": 7,
    "governmentValidation": {
        "validationStatus": {
            "value": "9",
            "status": "NOT_ENOUGH_DATA",
            "key": "notEnoughData"
        },
        "overall": {
            "status": "FAIL"
        }
    },
    "errorDescription": "notEnoughData"
}