Get face recognition settings

Get face recognition settings. This feature is available on devices with face recognition.

Different settings for AA/BI panels are available:

For AA panels it's possible to enable/disable face recognition autostart when motion is detected.
For BI panels face recognition turns off only during a call and turns on after 10 seconds of inactivity.
For individual panel face recognition is triggered when motion is detected.

Responses

application/json

Schema
Example (from schema)
A A panels
B I panels
Individual panels

Schema

oneOf

MOD1
MOD2

enable boolean

Default value: false

Enable/Disable feature

similarity string

Possible values: [low, normal, high]

Default value: low

Similarity level

mode string

Possible values: [software, 3D, antispoofing]

Default value: software

Face recognition mode

software - use only software to recognize face
3D - also use hardware to recognize face
antispoofing - use 2 models for more secure access

enable boolean

Default value: false

Enable/Disable feature

similarity string

Possible values: [low, normal, high]

Default value: low

Similarity level

mode string

Possible values: [software, 3D, antispoofing]

Default value: software

Face recognition mode

software - use only software to recognize face
3D - also use hardware to recognize face
antispoofing - use 2 models for more secure access

autostart boolean

Starts Face recognition when motion detected if enabled.

{
  "enable": false,
  "similarity": "low",
  "mode": "software"
}

{
  "similarity": "low",
  "enable": true,
  "autostart": true,
  "mode": "3D",
  "available_modes": [
    "software",
    "3D",
    "antispoofing"
  ]
}

{
  "similarity": "low",
  "enable": true,
  "mode": "3D"
}

{
  "similarity": "low",
  "enable": true,
  "mode": "software",
  "available_modes": [
    "software",
    "3D",
    "antispoofing"
  ]
}

Unauthorized request. Log In

application/json

Schema
Example (from schema)
Log In

Schema

error string

{
  "error": "Log In"
}

{
  "error": "Log In"
}

Administrator rights required. You are currently logged in with different user account. Log In with administrator rights

application/json

Schema
Example (from schema)
Admin Rights Required

Schema

error string

{
  "error": "Administrator rights required"
}

{
  "error": "Administrator rights required"
}

Get face recognition settings​

Get face recognition settings