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. Auxiliar Methods

Find UserId by MacAddress

This helper method is mainly required for device implementations. This method returns the Biometrid ID associated with a device by MAC address.

In the Biometrid Ecosystem a device is associated to a single user per client. For security reasons, this will only allow a user to use the device he was associated to perform authentications. This is an helper method mainly for device application implementations.

Find UserID by MacAddress

GET https://api.biometrid.com/api/1.0/users/find-by-address

Find BiometridID associated with the device.

Headers

Name
Type
Description

x-biometrid-key

string

Application client key.

x-biometrid-secret

string

Application client secret.

Request Body

Name
Type
Description

mac_address

string

Device MAC address.

HTTP/1.1 200 OK
// no user associated to the device.
{
    "status": true,
    "data": {
        "message": "DEVICE_NOT_ASSOCIATED_TO_USER"
    }
}

//user associated to the device.
{
    "status": true,
    "data": {
        "message": "USER_ALREADY_REGISTERED_ON_THIS_DEVICE",
        "id": "5be3000bd3adgd3e152724f2"
    }
}
HTTP/1.1 400 Bad Request
{
    "status": false,
    "data": {
        "message": "AUTHENTICATION_HEADERS_MISSING"
    }
}
HTTP/1.1 401 Unauthorized
{
    "status": false,
    "data": {
        "message": "INVALID_AUTHENTICATION_HEADERS"
    }
}
HTTP/1.1 404 Not Found
// Client not found by given key.
{
    "status": false,
    "data": {
        "message": "CLIENT_NOT_FOUND/CHECK_AUTHENTICATION_HEADERS"
    }
}
// MAC address not present on request body.
{
    "status": false,
    "data": {
        "message": "MAC_ADDRESS_NOT_PRESENT_ON_REQUEST"
    }
}
HTTP/1.1 500 Internal Server Error
{
    "status": false,
    "data": {
        "message": "PROBLEM_OCURRED_REPEAT_REQUEST"
    }
}
Example (JSON)
{
    "mac_address": "00:0a:95:9d:68:16"
}

PreviousRestart User State

Last updated 6 years ago

Was this helpful?