Class `FeedbackProperty`¶

Feedback properties are presented to users of the system as an established fact or outcome of the validation process that the TrustID Cloud carries out, based on the information presented by the identity document.

A good example is whether the document is current or has expired.

var api = new TVS.Api();
api.login('username', 'password').then(function() {
    // get container results...
    return api.retrieveDocumentContainer(containerId);
}).then(function(application) {
    var doc = application.Documents[0];

    // general document properties
    for (var i = 0; i < doc.GeneralDocumentProperties.length; i++) {
        var feedback = doc.GeneralDocumentProperties[i];
        console.log(feedback.Name, ': ', feedback.Value);
    }
});

class FeedbackProperty()¶

Represents an established fact or outcome of the validation process of a document, for example whether a document is in date or has expired.

Properties

FeedbackProperty.Name¶: The name or description of the established fact that this feedback property represents.

FeedbackProperty.Value¶

true if the established fact that this feedback property represents holds true for a document. For example, the document is indeed valid and has not expired.

false if the established fact that this feedback property represents does not hold true for a document. For example, the document has expired.

FeedbackProperty.ValueUndefined¶

The FeedbackProperty.Value is only valid if FeedbackProperty.ValueUndefined is false. If this property is true it means that the outcome or fact that this feedback property represents could not be established.

This may simply indicate that the validation could not be performed, or that it is not applicable in the context of the corresponding document.

It could also indicate an error condition, in which case ErrorMessage provides additional information about the error condition.

FeedbackProperty.ErrorMessage¶: When FeedbackProperty.ValueUndefined is set to true, FeedbackProperty.ErrorMessage may provide additional information if an error condition is present for this feedback property.

Class FeedbackProperty¶

Class `FeedbackProperty`¶