`Document`¶

Represents a security or supporting document as part of a document Container.

Document.AspectRatio¶

= AspectRatio

The aspect ratio of the document as defined by the width divided by the height of the document.

Document.Audited¶

= Audited

true if this document has been audited by another operator.

Document.AuditedByUser¶

= AuditedByUser

Identifier of the user who audited this document (if any).

Document.AuditorMessage¶

= AuditorMessage

A message that might have been given by the operator who audited this document.

Document.AuditorStatus¶

= AuditorStatus

The verification status of this document that has been given by the operator who audited this document.

See also

DocumentStatus for more information about the document status.

Document.Blacklisted¶

= Blacklisted

true, if this document is blacklisted according to the blacklisted document number on the TrustID Cloud instance that processed this document. Blacklisted document numbers are managed by administrators of the system.

Document.BlacklistedAt¶

= BlacklistedAt

The date and time when the document number of this document was blacklisted on the TrustID Cloud instance that processed this document.

Document.BranchName¶

= BranchName

The name of the branch for which this document has been processed (if any).

Document.ContainerId¶

= ContainerId

The unique identifier of the document container that this document belongs to.

Document.ContinuedManually¶

= ContinuedManually

true, if an operator stopped re-scanning the document (perhaps due to an operator error or a faulty document) and continued manually instead, in order to process the document manually.

Document.CreatedAt¶

= CreatedAt

The time stamp showing when this record was created.

Document.CustomFieldDictionary¶

= CustomFieldDictionary

List of key/value pairs for document-level custom fields.

The format for this structure is:

[
    {
        "Key": "<name>",
        "Value": {
            // CustomField
            ...
        }
    },
    ...
]

See also

CustomField for more information about custom fields.

Document.CustomFieldKeys¶

= CustomFieldKeys

A list of internal field names of all document-level custom fields that are available for this document.

Document.DetectedOrientation¶

= DetectedOrientation

The orientation of the document image that has been detected automatically.

See also

section ImageOrientation for more information about the document orientation.

Document.DocumentCompleted¶

= DocumentCompleted

true if the document has been completed by an operator and the operator assigned a status to this document. All documents within a document container must be completed first in order to be able to archive the corresponding document container.

Document.DocumentConfiguration¶

= DocumentConfiguration

Allows for the configuration of how documents are processed and/or validated.

See also

DocumentConfiguration for more information about document configuration.

Document.DocumentFields¶

= DocumentFields

A list of document fields that are associated with this document.

See also

DocumentField for more information about an individual document field.

Document.DocumentId¶

= DocumentId

The unique identifier of the document record.

Document.DocumentName¶

= DocumentName

The full name of the document type. The available types of documents are configured on the TrustID Cloud instance that processed this document.

See also

To obtain all configured document types use the endpoint /dataAccess/getDocumentTypeChargeStatuses/.

Document.DocumentResultsSummary¶

= DocumentResultsSummary

A list of feedback properties that indicate a certain assessment risk for this document.

See also

DocumentFeedback for more information on document feedback properties.

Document.DocumentSubType¶

= DocumentSubType

The sub-type of this document in relation to its type according to the knowledge database.

See also

KDBDocumentSubType for more information about the document sub-type (knowledge database).

Document.DocumentType¶

= DocumentType

The internal type of this document.

See also

DocumentType for more information about the document type.

Document.DocumentValidations¶

= DocumentValidations

List of validations that have been carried out for this document.

See also

DocumentValidation for more information about a document validation entry.

Document.DocumentVersion¶

= DocumentVersion

The document version of this document according to the knowledge database, if applicable.

Document.DrivingLicenceCategory¶

= DrivingLicenceCategory

The category for driving licences. Usually, this contains information on the different driving categories the document holder is entitled to.

Document.Editable¶

= Editable

true if this document can be changed by updating its properties.

Document.ExpiryNotification¶

= ExpiryNotification

true if the TrustID Cloud sends an automatic email regarding information on this document, which was about to expire within a certain time frame.

Document.ExternalServices¶

= ExternalServices

List of data was obtained from querying external services regarding this document.

See also

ExternalServiceData for more information on external service result details.

Document.ExternalServicesQueried¶

= ExternalServicesQueried

true if at least one external service was queried. This does not necessarily mean that there is a valid result from an external service.

Document.FeedbackFeatures¶

= FeedbackFeatures

List of results from feedback questions that an operator gave. Those questions were derived from the knowledge database, for example, to compare a region of the image in visual light against the same region under infrared light.

See also

DocumentFeatureFeedback for more information about document feature feedback details.

Document.FeedbackHasMrz¶

= FeedbackHasMrz

true if the operator confirmed that the document has a machine readable zone on it.

Document.FeedbackPersonMatches¶

= FeedbackPersonMatches

The answer to the operator question if the document holder is matching the photo on the security document.

Value	Description
`0`	The operator confirmed that the document holder (in person) does not match the facial photo on the document.
`1`	The operator confirmed that the document holder (in person) matches the facial photo.
`2`	The operator indicated that the person is not present or no person has been seen.

Document.FeedbackRFIDImageMatches¶

= FeedbackRFIDImageMatches

Value	Description
`true`	The operator confirmed that the facial image on the document (or the document holder in person) matches the facial image that was obtained from the RFID chip on the travel document.
`false`	The operator confirmed that the facial image on the document (or the document holder in person) does NOT match the facial image that was obtained from the RFID chip on the travel document.
`null`	The question was not asked or not answered.

Document.GeneralDocumentProperties¶

= GeneralDocumentProperties

Return a list of document feedback properties that describe various aspects of the document validation (e.g. photo comparison etc).

See also

DocumentFeedback for more information on document feedback properties.

Document.HasError¶

= HasError

true if there is an issue with the document, for example, an incorrect checksum, negative feedback from an operator etc.

Document.HighRiskCountry¶

= HighRiskCountry

true if the issuing country of this document is considered as a high-risk country. High-risk countries are configured on the TrustID Cloud instance by administrators of the system.

Document.Images¶

= Images

List of document images for this document. May contain front side and/or backside under multiple types of light, such as visual light, infrared or ultraviolet.

See also

Image for more information about image details.

Document.IssuingAuthority¶

= IssuingAuthority

The name of the issuing authority who issues the document.

Document.IssuingCountry¶

= IssuingCountry

The country who issues this document.

See also

KDBCountry for more information about country details.

Document.KDB¶

= KDB

true if this document was processed with the knowledge database installed.

Document.Locked¶

= Locked

true after an auditor reviewed this document and assigned the final document status to this document. Locked documents cannot be modified after they have been locked.

Document.MRZCorrected¶

= MRZCorrected

true if the machine-readable zone (MRZ) was manually changed by an operator in order to correct MRZ errors or OCR issues.

Document.MRZCorrectionProvided¶

= MRZCorrectionProvided

True if a manual correction of the machine-readable zone (MRZ) was provided to an operator.

Document.MaxAgeFailed¶

= MaxAgeFailed

The maximum age that the document holder was required to satisfy but failed to do so; null, if no maximum age restriction test has been performed.

Document.MinAgeFailed¶

= MinAgeFailed

The minimum age that the document holder was required to satisfy but failed to do so; null, if no minimum age restriction test has been performed.

Document.MissingFieldsProperties¶

= MissingFieldsProperties

List of document feedback properties that list missing document fields.

See also

DocumentFeedback for more information on document feedback properties.

Document.Mrz¶

= Mrz

The machine-readable zone data that was obtained through optical character recognition or by other means (may contain multiple lines, separated by newline characters).

Document.MrzCharacterCount¶

= MrzCharacterCount

The number of characters per line of the machine-readable zone (MRZ).

Document.MrzImageType¶

= MrzImageType

The image type of the image on which basis the machine-readable zone (MRZ) has been identified (if any).

Document.MrzLineCount¶

= MrzLineCount

The number of lines of the machine-readable zone (MRZ).

Document.MrzSameLength¶

= MrzSameLength

true if all lines of the machine-readable zone (MRZ) have the same length.

Document.MrzValidationProperties¶

= MrzValidationProperties

List of document feedback properties that describe various aspects of the machine-readable zone (MRZ) validation including checksums etc.

See also

DocumentFeedback for more information on document feedback properties.

Document.Nationality¶

= Nationality

The country the document holder holds nationality status with.

See also

KDBCountry for more information about country details.

Document.NoInitialFaceImage¶

= NoInitialFaceImage

true if the document does not contain a face image when the document was scanned for the first time without involving the backside of the document. Clients may infer for specific documents that the operator may have to scan the backside of the document because there is no face image available based on the initial scan.

Document.Notes¶

= Notes

Notes regarding this document that was provided by an operator of the system. Notes may be provided by an operator at any stage of the process.

Document.OcrDataApplied¶: = OcrDataApplied

true if data has been obtained through optical character recognition (OCR) and was applied to this document.

Document.OcrFieldData¶

= OcrFieldData

List of data entries for document areas from which data was extracted through optical character recognition (OCR). Matching data may have been applied to this document (see Document.OcrDataApplied); However, this data also contains additional information on the region of the document from which the data was obtained originally.

See also

OcrFieldData for more information about OCR field data.

Document.OperatorMessage¶

= OperatorMessage

Additional information on this document given by the operator who completed this document.

Document.OperatorStatus¶

= OperatorStatus

The document status that was assigned to this document by an operator as the operator completed this document.

See also

DocumentStatus for more information about the document status.

Document.OriginalMrz¶

= OriginalMrz

The machine-readable zone data that was obtained through optical character recognition or otherwise before it may have been corrected manually by an operator.

Document.PartiallyRecognised¶

= PartiallyRecognised

true if the document type was identified correctly, but the machine readable zone data was only partially recognised and contains so many errors that we would need to process the document again. Most likely the document has a machine-readable zone but we could not read it because of alignment issue or other problems.

Document.RFIDFailed¶

= RFIDFailed

true if the TVS client attempted to read the RFID chip on the travel document but was unable to access the chip due to an error condition. We can infer that the document has an RFID chip, but we were unable to read data from it. This property should not be true if the document does not have an RFID chip.

Document.RfidMrz¶

= RfidMrz

The machine-readable zone data that was obtained from the RFID chip of this travel document.

Document.RuleDenied¶

= RuleDenied

true if the system has denied this document based on the rules set up at the time of scanning or last modification.

Document.ScanCounter¶

= ScanCounter

The number of scans that were taken for this document. By default the number of scans is 1; However, operators may rescan documents a number of times for various reasons, for example, incorrect orientation, RFID chip error due to misalignment of the document etc. Each time the document is re-scanned by an operator, the number of scans is incremented by one.

Document.ScannedAt¶

= ScannedAt

Timestamp when this record has been created.

Document.ScannerType¶

= ScannerType

The reader/SDK used to scan the document (if any).

Document.SeenBeforeDocumentContainerId¶

= SeenBeforeDocumentContainerId

The unique identifier of the document container that contains the same (or very similar) information to this document that was seen before by the same TrustID Cloud instance in the past.

Document.SeenBeforeDocumentId¶

= SeenBeforeDocumentId

The unique identifier of the document that contains the same (or very similar) information to this document that was seen before by the same TVS service instance in the past.

Document.SupportingDocumentName¶

= SupportingDocumentName

The type of the supporting document if this document has been classified as a supporting document. The available types of supporting documents are configured on the TrustID Cloud instance that processed this document by an administrator.

Document.Unrecognised¶

= Unrecognised

true if this document was unrecognised, which means that the TVS service was unable to identify the document type and no useful machine readable zone data could be obtained. Most likely the document does not contain a machine-readable zone.

Document.UpdatedAt¶

= UpdatedAt

Timestamp when this document record was updated most recently.

Document.ValidFrom¶

= ValidFrom

The date when this document was issued.

Document.ValidLength¶

= ValidLength

true if the machine-readable zone has a valid length (per line).

Document.VpeDeviceId¶

= VpeDeviceId

The unique identifier of the TrustID Cloud that processed this document.

Document.VpeName¶

= VpeName

The given name of the TrustID Cloud that processed this document.

Document.WizardCompleted¶

= WizardCompleted

true if the operator went through the process of checking the document step-by-step successfully and completed the so-called wizard process for this document.

Document¶

`Document`¶