Message Text for /get-results Response Objects

This page shows the possible message text values returned with /get-results response objects. The message property is typically empty when there is no error condition. However, if there is an error, then message contains a brief description.

The message property is one of four properties that make up a normalized, top-level structure for /get-results response objects:

• success
• result
• message
• data

Here is an example of the facial object found in the /get-results response showing each of the properties.

"facial": {
                "data": {
                    "matchProbability": 1.0,
                    "matchScore": 137,
                    "livenessScore": -3.04,
                    "isLive": false,
                    "matched": true,
                    "livenessProbability": 0.05,
                    "errorMessage": null
                },
                "result": true,
                "success": true,
                "message": ""
            },

• The data object contains response data.
• The result and success properties are boolean values.
• The message property is typically empty when there is no error. But if an error occurs, message contains a brief explanation.

The following table shows the possible message text values for each response object.

In the case of an error, data would be empty and message contains a brief explanation. Here is another example where message contains error text.

"facial": {
                "data": null,
                "result": false,
                "success": false,
                "message": "No image found to process"
            },