Passport Validation

Overview

Three tiers of passport validation are available, from document-only OCR/MRZ validation through to full liveness detection.

Document Only

Validate passport via MRZ/OCR and authenticity checks

Document + Photo

Validate passport and match against a selfie

Document + Photo + Liveness

Full validation with liveness detection

Validate Passport

POST /Citizen/PassportValidation

curl -X POST "https://citizen.uat.securecitizen.cloud/Citizen/PassportValidation" \
  -H "Authorization: Bearer <access_token>" \
  -H "Content-Type: application/json" \
  -d '{
    "ConsentReceived": true,
    "SCConsentReceived": true,
    "PassportNumber": "A12345678",
    "PassportImage": "<base64_passport_photo_page>",
    "CRef": "REF00001"
  }'

Validate Passport + Photo

POST /Citizen/ValidatePassportAndPhoto

curl -X POST "https://citizen.uat.securecitizen.cloud/Citizen/ValidatePassportAndPhoto" \
  -H "Authorization: Bearer <access_token>" \
  -H "Content-Type: application/json" \
  -d '{
    "ConsentReceived": true,
    "SCConsentReceived": true,
    "PassportNumber": "A12345678",
    "PassportImage": "<base64_passport_photo_page>",
    "FaceString": "<base64_selfie>",
    "CRef": "REF00001"
  }'

Validate Passport + Photo + Liveness

POST /Citizen/ValidatePassportAndPhotoWithLiveness

The request body is the same as for ValidatePassportAndPhoto.

curl -X POST "https://citizen.uat.securecitizen.cloud/Citizen/ValidatePassportAndPhotoWithLiveness" \
  -H "Authorization: Bearer <access_token>" \
  -H "Content-Type: application/json" \
  -d '{
    "ConsentReceived": true,
    "SCConsentReceived": true,
    "PassportNumber": "A12345678",
    "PassportImage": "<base64_passport_photo_page>",
    "FaceString": "<base64_selfie>",
    "CRef": "REF00001"
  }'

Request Fields

All three endpoints share these fields. FaceString applies only to the photo and liveness tiers.

Field	Type	Required	Description
`ConsentReceived`	boolean	Yes	Must be `true`. Confirms you have the subject’s consent to process their personal information
`SCConsentReceived`	boolean	Yes	Confirms you have the subject’s consent for the platform to store their data
`PassportNumber`	string	Yes	Passport number as it appears in the passport
`PassportImage`	string	Yes	Base64-encoded image of the passport photo page
`FaceString`	string	Conditional	Base64-encoded selfie (Data URI format is supported). Required for `ValidatePassportAndPhoto` and `ValidatePassportAndPhotoWithLiveness`
`MobileNumber`	string	No	Subject’s mobile number
`EmailAddress`	string	No	Subject’s email address
`CRef`	string	No	Your transaction reference

Response

All three endpoints return the document validation result:

{
  "response_object": {
    "ocr_result": {
      "document_number": "A12345678",
      "validation_passed": "valid",
      "comparison_field_list": [
        {
          "field_name": "DOCUMENT_NUMBER",
          "mrz_value": "A12345678",
          "visual_zone_value": "A12345678",
          "barcode_value": null,
          "mrz_visual_match_ind_tristate": "true",
          "visual_barcode_match_ind_tristate": "",
          "mrz_barcode_match_ind_tristate": "",
          "valid_ind_tristate": "true"
        },
        {
          "field_name": "SURNAME",
          "mrz_value": "DOE",
          "visual_zone_value": "DOE",
          "barcode_value": null,
          "mrz_visual_match_ind_tristate": "true",
          "visual_barcode_match_ind_tristate": "",
          "mrz_barcode_match_ind_tristate": "",
          "valid_ind_tristate": "true"
        }
      ],
      "image_list": [
        {
          "image_name": "Portrait 1",
          "base64_image": "<base64_portrait>"
        }
      ]
    }
  },
  "result": true,
  "result_code": {
    "name": "Success",
    "id": 0
  },
  "CRef": "REF00001",
  "Status": "Success",
  "Message": "Message"
}

Passport responses use MRZ (Machine Readable Zone) fields in addition to visual zone and barcode fields. The mrz_value field contains the value extracted from the passport’s MRZ strip. See Validate RSA ID Document for a description of each comparison field.

Photo and Liveness Fields

The photo and liveness tiers add fields to the top level of the response:

ValidatePassportAndPhoto adds FaceResult.
ValidatePassportAndPhotoWithLiveness adds FaceResult, LivenessResult, and IsWalletCreated.

{
  "FaceResult": {
    "isIdentical": true,
    "confidence": 0.98
  },
  "LivenessResult": {
    "LivenessResultScore": 1,
    "LivenessResultProbability": 0.8,
    "LivenessResultQuality": 0.8,
    "LivenessResultClass": false,
    "LivenessPassResult": true,
    "LivenessMessage": "Liveness check successful"
  },
  "IsWalletCreated": false
}

Field	Description
`FaceResult.isIdentical`	Whether the selfie matches the face in the passport
`FaceResult.confidence`	Confidence score of the face match
`LivenessResult.LivenessPassResult`	`true` if the liveness check passed
`IsWalletCreated`	`true` only when all validations pass and a wallet is created

See Face Compare for the full list of liveness result fields.

Identity Verification

Biometrics

Compliance & Screening

Financial Verification

Enterprise

Overview

Document Only

Document + Photo

Document + Photo + Liveness

Validate Passport

Validate Passport + Photo

Validate Passport + Photo + Liveness

Request Fields

Response

Photo and Liveness Fields

​Overview

Document Only

Document + Photo

Document + Photo + Liveness

​Validate Passport

​Validate Passport + Photo

​Validate Passport + Photo + Liveness

​Request Fields

​Response

​Photo and Liveness Fields

Overview

Validate Passport

Validate Passport + Photo

Validate Passport + Photo + Liveness

Request Fields

Response

Photo and Liveness Fields