Skip to content

Face Enrollment API

Create Enrollment

Send a POST request to https://api.cloud.nodeflux.io/v1beta1/image-analytic/stream 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

{
  "analytics": [
    {
      "type": "FACE_ENROLLMENT"
    }
  ],
  "image": {
    "encoding": "IMAGE_ENCODING_JPEG",
    "content": "{INSERT_JPEG_IMAGE_AS_BASE64_STRING}"
  }
}

Response Body

HTTP Mapping: 200 OK

{
   "result":{
      "face_enrollments":[
         {
            "face_id":"30604573299179521",
            "variation":"17952130604573299"
         }
      ]
   }
}

Protocol Reference

Protocol reference available on nodeflux.analytics.v1beta1.FaceEnrollment

Custom Face ID

Request Body

{
   "analytics":[
      {
         "type":"FACE_ENROLLMENT",
         "options":{
            "@type":"type.googleapis.com/nodeflux.analytics.v1beta1.FaceEnrollmentOptions",
            "face_id":"123456789"
         }
      }
   ],
   "image":{
      "encoding":"IMAGE_ENCODING_JPEG",
      "content":"{INSERT_JPEG_IMAGE_AS_BASE64_STRING}"
   }
}

Response Body

HTTP Mapping: 200 OK

{
   "result":{
      "face_enrollments":[
         {
            "face_id":"123456789",
            "variation":"17952130604573299"
         }
      ]
   }
}

Delete Enrollment

Send a DELETE request to https://api.cloud.nodeflux.io/v1beta1/face/enrollment 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

{
    "face_ids": [
        "71111845645123585",
        "71111845645123585",
        "71111845645123585"
    ]
}

Response Body

HTTP Mapping: 200 OK

{
    "deleted_face_ids": [
        "71111845645123585",
        "71111845645123585",
        "71111845645123585"
    ]
}