Legacy Restful API
1.0.0
1.0.0
  • Introduction
  • Biometric Engines
  • Getting Started
  • User
    • Create User
    • Delete User
  • Face Engine
    • Enroll Face
    • Verify Face
    • Adapt Face
    • Delete User Face Enroll
    • Find User Id by Face
    • Find Multiple Id by Face
    • Find Face Properties
  • Liveness
    • Biometrics Status
    • Biometrics Liveness
  • Voice Engine
    • Enroll Voice
    • Verify Voice
    • Adapt Voice
    • Delete User Voice Enroll
    • Get Available Languages
  • OCR Engine
    • Validate Document
    • Validate Document (base64)
    • Verify document photo
    • Verify document photo (base64)
  • Auxiliar Methods
    • Get enroll Status
    • Has Pending Dialogue
    • Restart User State
    • Find UserId by MacAddress
Powered by GitBook
On this page

Was this helpful?

  1. Face Engine

Delete User Face Enroll

This method is used to delete an user face enrollment on the DB

Delete User Face Enroll

DELETE Https://api.biometrid.com/api/1.0/users/:userId/face/delete

Delete User face enroll.

Path Parameters

Name
Type
Description

userID

string

BiometrID user ID

Headers

Name
Type
Description

x-biometrid-key

string

Application Client Key

x-biometrid-secret

string

Application Client Secret

HTTP/1.1 200 OK
{
    "status": true,
    "data": {
        "message": "USER_FACE_CREDENTIALS_DELETED"
    }
}
HTTP/1.1 400 Bad Request
//User face not enroled on this provider.
    {
        "status": false,
        "data": {
            "message": "ENROLL_USER_FACE_FIRST"
        }
    }
// Missing Headers
 {
    "status": false,
    "data": {
        "message": "AUTHENTICATION_HEADERS_MISSING"
    }
}
HTTP/1.1 401 Unauthorized
{
    "status": false,
    "data": {
        "message": "INVALID_AUTHENTICATION_HEADERS"
    }
}
HTTP/1.1 402 Payment Required
{
    "status": false,
    "data": {
        "message": "REQUEST_LIMIT_REACHED"
    }
}
HTTP/1.1 404 Not Found
// No active engine configuration for this provider.
    {
        "status": false,
        "data": {
            "message": "NO_FACE_ENGINE_CONFIGURATION_AVAILABLE"
        }
    }
 // User's id not exists in biometrid environment.
    {
        "status": false,
        "data": {
            "message": "USERID_NOT_EXISTS"
        }
    }
//Client not found by given key.
    {
        "status": false,
        "data": {
            "message": "CLIENT_NOT_FOUND/CHECK_AUTHENTICATION_HEADERS"
        }
    }
 

PreviousAdapt FaceNextFind User Id by Face

Last updated 6 years ago

Was this helpful?