Skip to main content

# ValidationsObject

Validations is an object that contains the results of the validations performed for an attempt. It is returned in response to Validation, Applicants and other requests under the validations key.

Validations contains several blocks of checks.

### Liveness​

Various Liveness checks.

An object contains a filled verdict field which is formed from the verdict-s of all sub-blocks by conjunction. The verdict field may be null if no Liveness checks have been performed.

The sub-block data is stored under the details key in the list.

Each sub-block stores the following fields:

- verdict — verification result.
- score — verification score.
- name — verification name.

note

If sub-block check is disabled, it will be absent from the details list.
If the check should have been executed but was not, the verdict field of sub-block will be null.

The following sub-blocks are possible:

- FaceLiveness - face Liveness check.
- DeepFake - Check for signs of DeepFake technology usage. (Experimental feature)

### Quality​

Various matching checks.

An object contains a filled verdict field which is formed from the verdict-s of all sub-blocks by conjunction. The verdict field may be null if no quality checks have been performed.

The sub-block data is stored under the details key in list. Each sub-block stores following fields:

- verdict — verification result.
- score — verification score.
- name — verification name.

note

If sub-block check is disabled, it will be absent from the details list.
If the check should have been executed but was not, the verdict field of sub-block will be null.

The following sub-blocks are possible:

- FaceQuality - face quality check.

### Matching​

Various quality checks.

An object contains a filled verdict field which is formed from the verdict-s of all sub-blocks by conjunction. The verdict field may be null if no mathing checks have been performed.

The sub-block data is stored under the details key in list. Each sub-block stores following fields:

- verdict — verification result.
- score — verification score.
- name — verification name.

note

If sub-block check is disabled, it will be absent from the details list.
If the check should have been executed but was not, the verdict field of sub-block will be null.

The following sub-blocks are possible:

- FaceMatching - face matching check.

### MotionControl​

Checking the results of video motion control.

An object contains a verdict field that can include the following data:

- true — all actions were performed correctly.
- false — one of the actions was performed incorrectly.
- null — attempt does not contain motion control data.

The motionControlInfo field contains data on motion control results.

The data is a list where each element of the list is an object with the following fields:

- pattern — the name of the pattern to be performed (up, right, left, closer, farther).
- result — whether the pattern was performed by the user or not.

### Example of Validations object:​

    {
      "liveness": {
        "verdict": true,
        "details": [
          {
            "name": "FaceLiveness",
            "verdict": true,
            "score": 0.99,
            "additionalInfo": null
          },
          {
            "name": "LivenessReflection",
            "verdict": true,
            "score": 0.8,
            "additionalInfo": null
          },
          {
            "name": "DeepFake",
            "verdict": false,
            "score": 0.001,
            "additionalInfo": null
          }
        ]
      },
      "quality": {
        "verdict": true,
        "details": [
          {
            "name": "FaceQuality",
            "verdict": true,
            "score": 0.53
          }
        ]
      },
      "matching": {
        "verdict": true,
        "details": [
          {
            "name": "FaceMatching",
            "verdict": true,
            "score": 0.0
          }
        ]
      },
      "motionControl": {
        "verdict": false,
        "motionControlInfo": [
          {
              "pattern": "up",
              "result": true
          },
          {
              "pattern": "left",
              "result": false
          }
        ]
      }
    }