Create User

As a starting point, we need to create a new user on the Biometrid System. To do so, we need to make a request to the method Create User. This method only needs a parameter called reference_id to be sent. This reference_id refers to the user’s identifier on the client’s database. This way Biometrid solution won’t hold any sensitive information regarding the client’s final users. At the end of this creation process it will be returned a Biometrid Identifier to that user, that needs to be stored on the client’s side because it will be used on every process regarding the user itself. If an error occurs, it's necessary to repeat this process until a successful response of the service.

Registration Activity Diagram

Create User

POST Https://api.biometrid.com/api/1.1/users

This endpoint allows you to create a user

Query Parameters

Name	Type	Description
mac_address	string	If set, this field associate a the created user with a device by mac_address.
app_token	string	If using Firebase Notification Service, the app_token provided should be used to create user.
reference_id	string	Client's user identifier on client's database or just user's identifier

Headers

Name	Type	Description
x-biometrid-key	string	Application client key.
x-biometrid-secret	string	Application client secret

200 User Created

HTTP/1.1 200 OK

// new user created
{
    "status": true,
    "data": {
      "message": "NEW_USER_CREATED",
      "id": "59147e5afdda9b0ac0f5e31f"
    }
}

// user already associated with device
{
    "status": true,
    "data": {
      "message": "USER_ALREADY_ASSOCIATED_WITH_DEVICE",
      "id": "59147e5afdda9b0ac0f5e31f"
    }
}

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 or User Limit Reached for Client Plan

HTTP/1.1 402 Payment Required

//Request Limit Reached
    {
        "status": false,
        "data": {
            "message": "REQUEST_LIMIT_REACHED"
        }
    }
//User Limit Reached
    {
        "status": false,
        "data": {
            "message": "NOT_ALLOWED_TO_CREATE_USERS"
        }
    }

404 Client not found by the given key

HTTP/1.1 404 Not Found

{
    "status": false,
    "data": {
        "message": "CLIENT_NOT_FOUND/CHECK_AUTHENTICATION_HEADERS"
    }
}

500 Error during user's creation in the database.

HTTP/1.1 500 Internal Server Error

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