Get enroll Status

This method is used to get the enroll status for a certain user at any point. This enroll status indicates the state of each enroll of the client's chosen biometric engines.

Get enroll Status

GET https://api.biometrid.com/api/1.1/users/:userId/enroll/status

Get Enroll Status for User.

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.

200 Success

HTTP/1.1 200 OK

{
    "status": true,
    "data": [
      {
        "engines_oid": "586d12dc3e7a0221d76a4be2",
        "type": "voice",
        "enrolled": true
      },
      {
        "engines_oid": "586d12dc3e7a0221d76a4be3",
        "type": "face",
        "enrolled": false
      }
    ]
}

400 Missing Headers

HTTP/1.1 400 Bad Request

{
    "status": false,
    "data": {
        "message": "AUTHENTICATION_HEADERS_MISSING"
    }
}

401 Invalid Headers.

HTTP/1.1 401 Unauthorized

{
    "status": false,
    "data": {
        "message": "INVALID_AUTHENTICATION_HEADERS"
    }
}

402 Request Limit Reached for Client Plan.

HTTP/1.1 402 Payment Required

{
    "status": false,
    "data": {
        "message": "REQUEST_LIMIT_REACHED"
    }
}

404 Not found types

HTTP/1.1 404 Not Found

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