ID Check Passport MRZ ​

Compatible Cases

About the service ​

ID Check Passport MRZ service IDCheckPassportMRZService is a passport verification service. It checks the validity of the machine readable zone (MRZ), and checks the MRZ against any additional supplied optional parameters.

Product Code: W2-DATA-PASSPORT_MRZ-024

Does this service leave a credit search Footprint? No

Request ​

The following properties pertain to this service.

After performing the search, the validation result (pass, fail, etc.) will be part of the TransactionInformation returned for the service call.

Example request ​

"Data": {
	"MRZ": "MRZ... Data truncated"
}

Response ​

Example response ​

"idCheckPassportMRZResult": {
	"validationErrors": [
	"e.g. MRZ is not 88 characters"
	]
}

Sandbox ​

If the Sandbox query option is set to "true" the following entry will be returned in the ServiceResult:

Example Sandbox Request ​

To use sandbox the following example request can be used.

Remember to include the W2 provided API key in the Authorization Header.

{
    "Bundle": "KYC_PassportMRZ",
    "Data": {
        "PassportNumber":"P< CZESPECIMIN<< VZOR<<<<<<<<<<<<<<<<<<<<<<<<< 99003853< 1CZE1101018M120704611010111<<<<<< 94"
    },
    "Options": {
        "Sandbox": "true"
    },
    "ClientReference": "your-client-reference"
}

Example 1 ​

If the PassportNumber is entered as "P< CZESPECIMIN<< VZOR<<<<<<<<<<<<<<<<<<<<<<<<< 99003853< 1CZE1101018M120704611010111<<<<<< 94": then IDCheckPassportMRZResult will contain an empty, non-null ValidationErrors.

The corresponding ServiceTransactions will show the following properties:

{
    "HaltTriggered": "False",
    "ServiceTransactionResult": "Success",
    "ServiceInterpretResult": "Pass",
    "ServiceTransactionResultMessage": "This call was generated using sandbox mode",
    "ValidationResult": "NotApplicable"
}

Example 2 ​

If the PassportNumber is entered as any other 88 character string then IDCheckPassportMRZResult's ValidationErrors will contain the error "Final checksum is invalid".

The corresponding ServiceTransactions will show the following properties:

{
    "HaltTriggered": "False",
    "ServiceTransactionResult": "Success",
    "ServiceInterpretResult": "Inconclusive",
    "ServiceTransactionResultMessage": "This call was generated using sandbox mode",
    "ValidationResult": "NotApplicable"
}

Example 3 ​

If the PassportNumber is entered as any other string, or null then IDCheckPassportMRZResult's ValidationErrors will contain the error "MRZ is not 18 characters".

The corresponding ServiceTransactions will show the following properties:

{
    "HaltTriggered": "False",
    "ServiceTransactionResult": "Success",
    "ServiceInterpretResult": "Inconclusive",
    "ServiceTransactionResultMessage": "This call was generated using sandbox mode",
    "ValidationResult": "NotApplicable"
}