Configuration

Represents a list of key/value pairs for individual configuration settings. Configuration data is usually provided as part of the response message of the /session/login/ response:

POST {{server}}/VPE/session/login/
Content-Type: application/json

{
    "DeviceId": "device-id",
    "Username": "admin",
    "Password": "********"
}

which will yield the configuration data as part of the response:

{
    "Success": true,
    "Message": "Operation executed successfully.",
    "Configuration": [
        {
            "Key": "support.pagination",
            "Value": "False"
        },
    ],
    ...
}

The following section lists most common configuration options.

Note

Configuration data is always encoded as a string and needs to be parsed manually.

Configuration.SERVICE_SYSTEM_TYPE

= servicesystemtype

A decimal number indicating various operation types the TrustID Cloud is configured as. Each bit flag represents a different service operation type:

Bit

Numeric

1

1

The service is configured as a stand-alone single desktop system.

2

2

The service is configured to run as an online system running in the cloud.

3

4

Reserved.

4

8

The Right-To-Work scheme is activated for this service.

Configuration.SUPPORT_PAGINATION

= support.pagination

True if the TrustID Cloud supports pagination; otherwise False. Some installations of the TrustID Cloud may not provide pagination depending on the underlying database system used.

Configuration.UI_PHOTO_MATCHES_REQUIRED_ENABLED

= ui.photomatchesrequired.enabled

True if the “require person and photo matches” question should be required.

Configuration.UI_PERSON_NOT_SEEN_REQUIRED_ENABLED

= ui.personnotseenrequired.enabled

True if the “person not seen” option should be available for the photo question.

Configuration.UI_MULTIPLE_DOCUMENTS_PER_APPLICATION_DISABLED

= ui.multiple_documents_per_application.disabled

By default, the TrustID Cloud supports multiple documents per application. If this configuration option is True, then only one single document is permitted per application.

Configuration.UI_DRIVING_LICENCE_SIDE2_MANDATORY_ENABLED

= ui.drivinglicenceside2.mandatory.enabled

If True, then the back side of a driving licence document is mandatory when submitting applications.

Configuration.UI_ID_CARD_SIDE2_MANDATORY_ENABLED

= ui.idcardside2.mandatory.enabled

If True, then the back side of a national identity card is mandatory when submitting applications.