BWS 3 Face Recognition is in preview now!
Fetches the biometric face template status of an enrolled person, if available. Additionally the method allows to fetch the thumbnail images, used to enroll the person, if available.
GET /api/face/v1/template/status/{classId}
classId
The unique class ID of the requested face template.
downloadThumbnails
Optional boolean flag indicating whether to fetch the thumbnail images or not.
If set to true
(?downloadThumbnails=true), all stored face thumbnails are returned with the response.
This HTTP request requires no body content.
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. |
Content type: application/json
{
"classId": 0,
"available": true,
"enrolled": "string",
"tags": [
"string"
],
"encoderVersion": 0,
"featureVectors": 0,
"thumbnailsStored": 0,
"thumbnails": [
{
"enrolled": "string",
"image": "string"
}
]
}
On success the API returns a JSON serialized FaceTemplateStatus object.
The call returns one of the standard HTTP status codes, e.g.:
code
and message
.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. |