Playground biometrics demo BioID home page

JSON Web API SetTemplateTags

You can use tags to group various classes together. Therefore, biometric templates can be associated with tags, which can be used with one-to-many comparisons (see Search) to restrict the search to classes that have matching tags assigned.

Request

PUT /api/face/v1/template/{classId}/tags

Path Parameter

classId

The unique class ID of the biometric face template to associate with the given tags.

Request Body

The HTTP request body contains the array of images to enroll.

Content type: application/json 

[
  "string"
]

List of tags to assign to the template. Any existing tags will be overwritten.

Request Headers

This API requires a valid JWT in the Authorization request header and accepts an optional reference number.

Authorization Required Bearer authentication. Please refer to BWS API Authentication for a description of how to provide a valid JWT here.
Reference-Number Optional, client specific reference number, which will be added to the BWS bookkeeping as well as to the response header. You typically use this reference to link the resulting BWS bookkeeping entries with your logs.

Response

This call has no specific response message.

HTTP Status Codes

The call returns one of the standard HTTP status codes, e.g.:

200 (OK)
The tags have been applied successfully.
400 (Bad Request)
The call failed, typically due to an invalid argument. The response body contains a JSON object with the reported gRPC error code and message.
401 (Unauthorized)
The request does not have valid authentication credentials for the operation.
404 (NotFound)
A biometric face template for the given class ID does not exist.
500 (Internal Server Error)
Server experienced some unexpected behaviour.
503 (Service Unavailable)
The service is currently unavailable. This is a most likely a transient condition and may be corrected by retrying with a backoff.

Response Headers

All successful BWS calls return a response header containing additional information about the request:

jobid The Job-ID (a GUID) that has been assigned to this BWS call.
bws-version The version of the BWS gRPC service.
reference-number An optional reference number as provided in the request header.
date The timestamp when the request has been received at the server.
... Other headers that might have been added by the server (NGINX, Kestrel, ...) that was handling the request.