Skip to content

Face Match with Enrollment API

Send a POST request to https://api.cloud.nodeflux.io/v1beta1/face/match-with-id by providing these arguments as application/json.

Headers

Key Value
Content-type application/json
Authorization Your authorization key.
x-nodeflux-timestamp x-nodeflux-timestamp from the Authorization API.

Request Body

{
   "image":{
      "encoding":"IMAGE_ENCODING_JPEG",
      "content":"{INSERT_JPEG_IMAGE_AS_BASE64_STRING}"
   },
   "id": 301219225937
}

Response Body

HTTP Mapping: 200 OK

{
   "face_match":{
      "similarity":0.97,
      "match": true
   }
}

Protocol Reference

Protocol reference available on nodeflux.analytics.v1beta1.FaceMatch

Errors

Empty Comparison Image

Requested comparison image data in field content is empty.

HTTP Mapping: 400 Bad Request

{
    "error": "Comparison image data is empty",
    "code": 3,
    "message": "Comparison image data is empty",
    "details": []
}

Illegal Image Encoding

Requested comparison image data in field content is wrongly encoded.

HTTP Mapping: 400 Bad Request

{
    "error": "illegal base64 data at input byte 240704",
    "code": 2,
    "message": "illegal base64 data at input byte 240704",
    "details": []
}

Not Found ID

Requested ID in field id is not found in database.

HTTP Mapping: 400 Bad Request

{
    "error": "Requested ID not found",
    "code": 3,
    "message": "Requested ID not found",
    "details": []
}