Restart User State

Restart User State

GET https://api.biometrid.com/api/1.0/users/:userId/restart-state

Restart User's Process State

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": {
        "message": "STATE_RESTARTED_WITH_SUCCESS"
    }
}

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

500 Problem occured while restarting user's state.

HTTP/1.1 500 Internal Server Error

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