VisionFaceVerify vision.face-verify@1

Generated at from openvibe-contracts v0.419.0 and openvibe-sdk v0.161.0.

Version
1.0.0
Owner
vision
Visibility
first-party
Status
active
Compatibility
backward
Schema
https://openvibe.network/contracts/vision/face-verify.v1.json

vision.face-verify@1: POST /api/v1/faces/verify compares this person's own verification attempt with their enrolled template. It always requires that person's verify consent; without it the answer is faces.consent_required whether or not a template exists. A match alone never unlocks anything: liveness and a second factor are separate.

Fields

FieldTypeRequiredDescriptionConstraints
scorenumberyes
  • minimum 0
  • maximum 1
matchbooleanyes
thresholdnumberyes
  • minimum 0
  • maximum 1
livenessenumyes
  • one of "not_checked", "checked"

Examples

From the contract's own test fixtures: valid ones validate, rejected ones must fail.

Valid: one
{
  "score": 0.72,
  "match": true,
  "threshold": 0.363,
  "liveness": "not_checked"
}
Rejected: one
{
  "score": 1.2,
  "match": true,
  "threshold": 0.363,
  "liveness": "not_checked"
}

Validate

const contracts = require('openvibe-contracts');
contracts.validate('vision.face-verify@1', value);   // { valid, errors: [{ path, message }] }