Performs passport validation with face matching and liveness

curl --request POST \
  --url https://citizen.uat.securecitizen.cloud/Citizen/ValidatePassportAndPhotoWithLiveness \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ConsentReceived": true,
  "SCConsentReceived": true,
  "PassportNumber": "<string>",
  "PassportImage": "<string>",
  "FaceString": "<string>",
  "CRef": "<string>",
  "MobileNumber": "<string>",
  "EmailAddress": "<string>"
}
'

import requests

url = "https://citizen.uat.securecitizen.cloud/Citizen/ValidatePassportAndPhotoWithLiveness"

payload = {
    "ConsentReceived": True,
    "SCConsentReceived": True,
    "PassportNumber": "<string>",
    "PassportImage": "<string>",
    "FaceString": "<string>",
    "CRef": "<string>",
    "MobileNumber": "<string>",
    "EmailAddress": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    ConsentReceived: true,
    SCConsentReceived: true,
    PassportNumber: '<string>',
    PassportImage: '<string>',
    FaceString: '<string>',
    CRef: '<string>',
    MobileNumber: '<string>',
    EmailAddress: '<string>'
  })
};

fetch('https://citizen.uat.securecitizen.cloud/Citizen/ValidatePassportAndPhotoWithLiveness', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://citizen.uat.securecitizen.cloud/Citizen/ValidatePassportAndPhotoWithLiveness",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'ConsentReceived' => true,
    'SCConsentReceived' => true,
    'PassportNumber' => '<string>',
    'PassportImage' => '<string>',
    'FaceString' => '<string>',
    'CRef' => '<string>',
    'MobileNumber' => '<string>',
    'EmailAddress' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://citizen.uat.securecitizen.cloud/Citizen/ValidatePassportAndPhotoWithLiveness"

	payload := strings.NewReader("{\n  \"ConsentReceived\": true,\n  \"SCConsentReceived\": true,\n  \"PassportNumber\": \"<string>\",\n  \"PassportImage\": \"<string>\",\n  \"FaceString\": \"<string>\",\n  \"CRef\": \"<string>\",\n  \"MobileNumber\": \"<string>\",\n  \"EmailAddress\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://citizen.uat.securecitizen.cloud/Citizen/ValidatePassportAndPhotoWithLiveness")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"ConsentReceived\": true,\n  \"SCConsentReceived\": true,\n  \"PassportNumber\": \"<string>\",\n  \"PassportImage\": \"<string>\",\n  \"FaceString\": \"<string>\",\n  \"CRef\": \"<string>\",\n  \"MobileNumber\": \"<string>\",\n  \"EmailAddress\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://citizen.uat.securecitizen.cloud/Citizen/ValidatePassportAndPhotoWithLiveness")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"ConsentReceived\": true,\n  \"SCConsentReceived\": true,\n  \"PassportNumber\": \"<string>\",\n  \"PassportImage\": \"<string>\",\n  \"FaceString\": \"<string>\",\n  \"CRef\": \"<string>\",\n  \"MobileNumber\": \"<string>\",\n  \"EmailAddress\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "CRef": "<string>",
  "Message": "<string>",
  "result": true,
  "result_code": {
    "name": "<string>",
    "id": 123
  },
  "response_object": {
    "ocr_result": {
      "document_number": "<string>",
      "validation_passed": "<string>",
      "comparison_field_list": [
        {
          "field_name": "<string>",
          "mrz_value": "<string>",
          "visual_zone_value": "<string>",
          "barcode_value": "<unknown>",
          "mrz_visual_match_ind_tristate": "<string>",
          "visual_barcode_match_ind_tristate": "<string>",
          "mrz_barcode_match_ind_tristate": "<string>",
          "valid_ind_tristate": "<string>"
        }
      ],
      "image_list": [
        {
          "image_name": "<string>",
          "base64_image": "<string>",
          "document_category": "<string>",
          "document_type": "<string>",
          "raw_mrz": "<string>",
          "authenticity_check_list": {
            "List": {
              "List": [
                {
                  "Type": 123,
                  "Result": 123,
                  "List": [
                    {
                      "ElementType": 123,
                      "ElementRect": {
                        "left": 123,
                        "top": 123,
                        "right": 123,
                        "bottom": 123
                      },
                      "Type": 123,
                      "ElementResult": 123,
                      "ElementDiagnose": 123
                    }
                  ]
                }
              ]
            }
          }
        }
      ]
    }
  },
  "FaceResult": {
    "isIdentical": true,
    "confidence": 123
  },
  "LivenessResult": {
    "LivenessResultScore": 123,
    "LivenessResultProbability": 123,
    "LivenessResultQuality": 123,
    "LivenessResultClass": true,
    "LivenessPassResult": true,
    "LivenessMessage": "<string>"
  },
  "IsWalletCreated": true
}

POST

Citizen

ValidatePassportAndPhotoWithLiveness

Performs passport validation with face matching and liveness

curl --request POST \
  --url https://citizen.uat.securecitizen.cloud/Citizen/ValidatePassportAndPhotoWithLiveness \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ConsentReceived": true,
  "SCConsentReceived": true,
  "PassportNumber": "<string>",
  "PassportImage": "<string>",
  "FaceString": "<string>",
  "CRef": "<string>",
  "MobileNumber": "<string>",
  "EmailAddress": "<string>"
}
'

import requests

url = "https://citizen.uat.securecitizen.cloud/Citizen/ValidatePassportAndPhotoWithLiveness"

payload = {
    "ConsentReceived": True,
    "SCConsentReceived": True,
    "PassportNumber": "<string>",
    "PassportImage": "<string>",
    "FaceString": "<string>",
    "CRef": "<string>",
    "MobileNumber": "<string>",
    "EmailAddress": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    ConsentReceived: true,
    SCConsentReceived: true,
    PassportNumber: '<string>',
    PassportImage: '<string>',
    FaceString: '<string>',
    CRef: '<string>',
    MobileNumber: '<string>',
    EmailAddress: '<string>'
  })
};

fetch('https://citizen.uat.securecitizen.cloud/Citizen/ValidatePassportAndPhotoWithLiveness', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://citizen.uat.securecitizen.cloud/Citizen/ValidatePassportAndPhotoWithLiveness",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'ConsentReceived' => true,
    'SCConsentReceived' => true,
    'PassportNumber' => '<string>',
    'PassportImage' => '<string>',
    'FaceString' => '<string>',
    'CRef' => '<string>',
    'MobileNumber' => '<string>',
    'EmailAddress' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://citizen.uat.securecitizen.cloud/Citizen/ValidatePassportAndPhotoWithLiveness"

	payload := strings.NewReader("{\n  \"ConsentReceived\": true,\n  \"SCConsentReceived\": true,\n  \"PassportNumber\": \"<string>\",\n  \"PassportImage\": \"<string>\",\n  \"FaceString\": \"<string>\",\n  \"CRef\": \"<string>\",\n  \"MobileNumber\": \"<string>\",\n  \"EmailAddress\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://citizen.uat.securecitizen.cloud/Citizen/ValidatePassportAndPhotoWithLiveness")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"ConsentReceived\": true,\n  \"SCConsentReceived\": true,\n  \"PassportNumber\": \"<string>\",\n  \"PassportImage\": \"<string>\",\n  \"FaceString\": \"<string>\",\n  \"CRef\": \"<string>\",\n  \"MobileNumber\": \"<string>\",\n  \"EmailAddress\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://citizen.uat.securecitizen.cloud/Citizen/ValidatePassportAndPhotoWithLiveness")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"ConsentReceived\": true,\n  \"SCConsentReceived\": true,\n  \"PassportNumber\": \"<string>\",\n  \"PassportImage\": \"<string>\",\n  \"FaceString\": \"<string>\",\n  \"CRef\": \"<string>\",\n  \"MobileNumber\": \"<string>\",\n  \"EmailAddress\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "CRef": "<string>",
  "Message": "<string>",
  "result": true,
  "result_code": {
    "name": "<string>",
    "id": 123
  },
  "response_object": {
    "ocr_result": {
      "document_number": "<string>",
      "validation_passed": "<string>",
      "comparison_field_list": [
        {
          "field_name": "<string>",
          "mrz_value": "<string>",
          "visual_zone_value": "<string>",
          "barcode_value": "<unknown>",
          "mrz_visual_match_ind_tristate": "<string>",
          "visual_barcode_match_ind_tristate": "<string>",
          "mrz_barcode_match_ind_tristate": "<string>",
          "valid_ind_tristate": "<string>"
        }
      ],
      "image_list": [
        {
          "image_name": "<string>",
          "base64_image": "<string>",
          "document_category": "<string>",
          "document_type": "<string>",
          "raw_mrz": "<string>",
          "authenticity_check_list": {
            "List": {
              "List": [
                {
                  "Type": 123,
                  "Result": 123,
                  "List": [
                    {
                      "ElementType": 123,
                      "ElementRect": {
                        "left": 123,
                        "top": 123,
                        "right": 123,
                        "bottom": 123
                      },
                      "Type": 123,
                      "ElementResult": 123,
                      "ElementDiagnose": 123
                    }
                  ]
                }
              ]
            }
          }
        }
      ]
    }
  },
  "FaceResult": {
    "isIdentical": true,
    "confidence": 123
  },
  "LivenessResult": {
    "LivenessResultScore": 123,
    "LivenessResultProbability": 123,
    "LivenessResultQuality": 123,
    "LivenessResultClass": true,
    "LivenessPassResult": true,
    "LivenessMessage": "<string>"
  },
  "IsWalletCreated": true
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

Example: true

This is an indicator to audit the fact that the controller has obtained consent from the subject to process their personal information and data as per the regulatory requirements pertaining to local and global privacy and data protection legislation.

This is an indication that the client has obtained consent from the consumer for us to store their data.

PassportNumber

string

required

The client is required to input the passport number as seen in the consumers passport.

Minimum string length: 1

PassportImage

string

required

In this field the client would supply the passport image of the consumer whose documentation they would like to verify.

Minimum string length: 1

FaceString

string

required

In this field the client is to provide an image with which a face comparison will be done, the provided image must be in BASE64 format - formats supports include Data URI Scheme.

Minimum string length: 1

CRef

string<string> | null

Example: "REF00001"

This is the unique transaction reference number that can be supplied by the controller. This will be provided in response messages related to the transaction and will be required for identifying transactions for support purposes.

MobileNumber

string | null

The client would share the mobile number provided by the consumer in this field.

EmailAddress

string | null

The client would share the email address provided by the consumer in this field.

Response

Success

CRef

string<string> | null

This field will return the reference provided by the client to track the transaction.

Status

enum<string>

Status values (static strings) to be used for external connection management

Available options:

Success,

Failure,

Unknown,

AuthFailure,

DataDeserializationError,

EmptyResults,

ErrorContactSupport,

FaceDetectionFailure,

FaceComparisonFailure,

NoStatusDefined,

FaceDetectionQualityTooLow,

FaceDetectionTooManyFaces,

FaceDetectionNoFacesFound,

FaceComparisonError,

FaceComparisonNotSame,

GoldenSourceImageNull,

ProvidedImageNull,

GoldenSourceNoFacesFound,

ProvidedImageNoFacesFound,

GoldenSourceHasTooManyFaces,

ProvidedImageHasTooManyFaces,

GoldenSourceQualityTooLow,

ProvidedImageQualityTooLow,

GoldenSourceGUIDIncorrect,

ProvidedImageGUIDIncorrect,

FaceAPIGeneralError,

FaceAPIPublicUrlInputError,

FaceBadInput,

GoldenSourceIncorrectStringFormat,

ProvidedImageIncorrectStringFormat,

SAFPSNPROk,

SAFPSHANISOk,

SAFPSNIISOk,

SAFPSNPRSlow,

SAFPSHANISSlow,

SAFPSNIISSlow,

SAFPSFailure,

SAFPSPossibleFailure,

SAFPSNPRFailure,

SAFPSHANISFailure,

SAFPSNIISFailure,

FaceTooClose,

EyesClosed,

FaceCloseToBorder,

FaceCropped,

FaceIsOccluded,

FaceNotFound,

TooManyFaces,

FaceTooSmall,

AbsoluteFaceTooSmall,

RelativeFaceTooSmall,

FaceAngleTooLarge,

FailedToPredictLandmarks,

Active,

CSuccess,

AsyncCSuccess,

IdentificationNumberInvalid,

IdentificationNumberAgeBelow18,

UnableToVerifyIdentificationNumberOnDocument,

UnableToVerifyIdentificationNumberAtGoldenSource,

GoldenSourceUnavailable,

MandatoryInformationMissing,

NPRSuccess,

HANISNotAvailable,

InvalidIDNCheckDigitTestNotPassed,

NPRNotAvailableOnlyPhotoIsReturned,

IDNRIsNotCurrentlyAValidNPRIDNR,

IDNRIsMarkedForDeletion

Message

string<string> | null

This will return a status of the transaction s well as external tracking information.

result

boolean

This will indicate whether the validation was successful.

result_code

object

Show child attributes

response_object

object

Show child attributes

FaceResult

object

Show child attributes

LivenessResult

object

Show child attributes

IsWalletCreated

boolean

Is wallet created. Only true when all validations pass and a wallet is created.

Secure Citizen Passport Validation (with photo match)Secure Citizen Lookup Refugee verification call

Identity Verification

Biometrics

Compliance & Screening

Financial Verification

Enterprise

Performs passport validation with face matching and liveness

Authorizations

Body

Response