Set face recognition settings

Set face recognition settings. This feature is available on devices with face recognition. A reboot is required after changing the face recognition model

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 panels face recognition 3D mode is not available.

application/json

Request Body required

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]

Default value: software

Face recognition mode

• software - use only software to recognize face
• 3D - also use hardware to recognize face

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]

Default value: software

Face recognition mode

• software - use only software to recognize face
• 3D - also use hardware to recognize face

autostart boolean required

Starts Face recognition when motion detected if enabled.

Responses

• 200
• 400
• 401
• 403
• 404

---

OK

• Wrong similarity param - Wrong mode param
• Missed json body or wrong param. Response sample:

  "error": "Wrong JSON body"

• Required field is not provided. Response sample:

  "error": "Wrong JSON body: no value for `param`"

where param - is a required field that was not provided

• Field was of the wrong type. Response sample:

  "error": "Wrong JSON body: value `param` was of the wrong type"

where param - is a field of the wrong type

application/json

• Schema
• Example (from schema)
• Base
• No value
• Wrong param type
• Wrong similarity
• Wrong Mode

---

Schema

• error string

{
  "error": true
}

{
  "error": "Wrong JSON body"
}

{
  "error": "Wrong JSON body: no value for `param`"
}

{
  "error": "Wrong JSON body: value `param` was of the wrong type"
}

{
  "error": "Wrong similarity field=wrong_similarity. Available values: [low, normal, high]"
}

{
  "error": "Wrong mode field=wrong_mode. Available values: [software, 3D]"
}

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"
}

This feature is disabled on your device

Loading...