Result object

The Verifai result object is a JSON-formatted object that contains all the results of the verification process. It can be retrieved with your API key and session ID. More information on obtaining the result can be found here.

{
    "frontImage": "base64-encoded-string",
    "backImage": "base64-encoded-string",
    "faceImage": "base64-encoded-string",
    "frontImageOriginal": "base64-encoded-string",
    "backImageOriginal": "base64-encoded-string",
    "faceImageOriginal": "base64-encoded-string",
    "idModel": { ... },
    "mrzData": { ... },
    "barcodes": [ ... ],
    "vizData": { ... },
    "faceMatchData": { ... }
}

Key	Type	Description	Link
frontImage	str	Base64 encoded (jpeg)	-
backImage	str	Base64 encoded (jpeg)	-
faceImage	str	Base64 encoded (jpeg)	-
frontImageOriginal	str	Base64 encoded (jpeg)	-
backImageOriginal	str	Base64 encoded (jpeg)	-
idModel	object	ID Model object	ID model
mrzData	object	Mrz Data object	Machine Readable Zone
barcodes	array	Barcode objects	Barcodes
vizData	object	VIZ Data object	Visual Inspection Zone
faceMatchData	object	FaceMatch Data object	Face matching

Image objects

Images found in the Verifai Result object refer to the uploaded and used images. Some of these values may therefore be empty. Whenever a document does not require an upload of the back, the value for backImage (or backImageOriginal) will be empty. Similarly, whenever the Face Match feature is disabled, the values for faceImage and faceImageOriginal will be empty.

Furthermore, the -Original suffix indicates an un-cropped image. If this is indicated in the settings, image keys without the suffix will be empty. Likewise, if this setting is turned off, only cropped images will be sent and the -Original will be empty.