Document

The object contains data elements extracted from the document.

JSON Object

Document.Data

The array of key-value pairs of fields obtained from the document via OCR / MRZ / Barcodes(s) decode. The possible values for keys are listed in the fieldTypes csv document provided on demand

Array of Key/Value Pairs

Document.Data.BarcodeSecurity

This field denotes whether the document (including US, Mexican, and Canadian IDs) has successfully passed barcode security validation.

PASS or FAIL

Document.Data.padResult

This field indicates whether the presented document has successfully passed liveness detection. Additional details can be found in the Document.RawData in Ipsidy.Bus.Pad.Score key

PASS or FAIL

Document.Data.documentInjectionAttackDetectionResult

The field indicates that injection attack has been performed at the time of document acquisition.

PASS or FAIL

Document.Data.mismatchMrzOcr

This field denotes if there has been a significant mismatch between the OCR and MRZ/PDF417 data

True (true) on mismatch, otherwise not present

Document.RawData

The array contains various objects depending on features enabled in configuration on a per-customer basis.

Escaped JSON

Document.AdditionalImages

An array containing objects with images cropped from document capture. The “Description” field provides details of the contents of an array element. The contents depend on the document type. Some examples of Description values:

• Document front side  
• Document back side
• Ghost portrait

An array of objects containing base64-encoded images

Document.FacialImage

Contains cropped document owner’s photo (aka mugshot) personalization element, usually found on the “front” side of the document. DataType key is the enum describing image format, refer to the schema.

The object containing base64-encoded image.

CurrentFacialImage

The object contains a live user selfie. DataType key is the enum describing image format, please see schema.

Base64-encoded image

Document.RawData.FacialImageInformation

This field supplies the coordinates of the user's face within the selfie, enabling the Selfie image to be cropped for privacy.

Coordinates of the user's face within the selfie image

Matched

Contains the result of comparing a person’s selfie to a document. Additional information is provided in MatchProbabilty

True or False (true or false)

MatchProbabilty

Contains inverse (1-x) of False Match Probability

Value from 0 to 1

MatchScore

Logarithm-based (base 10) score output of the matching algorithm

Integer (integer)

BiometryProcessingResult

Should be disregarded as it contains technical information. Do NOT use the liveness metrics contained in this object.

LivenessDetectionResult

Contains an object describing the genuine presence detection/presentation attack detection details, the AI model version, quality metric, etc..  IsLive element contains system decision.

LivenessDetectionResult.IsLive

The field indicates if the user's selfie has successfully passed the liveness detection.

True or False (true or false)

Document.Data.selfieInjectionAttackDetectionResult

The field indicates that injection attack has been performed at the time of selfie acquisition.

PASS or FAIL

Geofencing

Contains select elements describing the end user environment.

Check if document biometry matches the user's selfie.

Matched

Contains true or false and shows if the document image matches user biometry (selfie).

Check if the user has passed the genuine presence detection/liveness test.

LivenessDetectionResult.IsLive

Contains true or false stating if the live person was genuinely present, i.e., not a Presentation Attack.

Check if an injection attack occurred instead of taking a selfie.

Document.Data.selfieInjectionAttackDetectionResult

It contains PASS or FAIL and indicates that an injection attack has been performed.
The details of injection attack detection can be found in Document.RawData array, in Ipsidy.Bus.Iad.Score key.

Check for detection event of a potential counterfeit document.

Document.Data.BarcodeSecurity

It contains PASS or FAIL and indicates a potentially counterfeit document. This key is only present for documents with PDF417 barcode.

Check for significant discrepancies between OCR and machine-readable information such as MRZ and barcode(s).

Document.Data.mismatchMrzOcr

This key is present and set to true only if there is a substantial difference between document machine-readable data and OCR data. Otherwise, there is no key (null).

Check for signals from the document manipulation detection AI stack (screen replay/paper copy / etc.).

Document.Data.padResult

It contains PASS or FAIL and indicates potential document manipulation, for example, the Screen Replay attack.
The details of AI pipelines for document manipulation can be found in  Document.RawData array, in Ipsidy.Bus.Pad.Score key.

Check if an injection attack occurred instead of presenting a physical document in front of the device camera.

Document.Data.documentInjectionAttackDetectionResult

It contains PASS or FAIL and indicates that an injection attack has been performed.
The details of injection attack detection can be found in Document.RawData array, in Ipsidy.Bus.Iad.Score key.

Check if document has expired.

Document.Data.DateOfExpiry

The expiration date is provided in the YYYY-MM-DD format. It should be compared to the current date to determine whether the document has expired.

If the value is not present or contains a non-date string (e.g., NonExpiring), the document is considered to have no expiration date

The allow expired documentcapture option must be enabled on your account to allow users to complete a Proof transaction using an expired document.