API docs by Redocly

SmartFace REST API (v5_4.29.0.7536)

Download OpenAPI specification:Download

Camera

Retrieves the camera by its Id.

path Parameters
id
required
string <uuid>

Id of the camera.

Responses

Response samples

Content type
application/json
{
  • "spoofDetectorResourceIds": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "source": "string",
  • "enabled": true,
  • "faceDetectorConfig": {
    },
  • "pedestrianDetectorConfig": {
    },
  • "faceDetectorResourceId": "string",
  • "templateGeneratorResourceId": "string",
  • "pedestrianDetectorResourceId": "string",
  • "pedestrianExtractorResourceId": "string",
  • "redetectionTime": 0,
  • "templateGenerationTime": 0,
  • "trackMotionOptimization": "string",
  • "trackSpeedAccuracyMode": "string",
  • "faceSaveStrategy": "string",
  • "pedestrianSaveStrategy": "string",
  • "objectSaveStrategy": "string",
  • "maskImagePath": "string",
  • "saveFrameImageData": true,
  • "imageQuality": 0,
  • "mpeG1PreviewEnabled": true,
  • "mpeG1PreviewPort": 0,
  • "mpeG1VideoBitrate": 0,
  • "previewMaxDimension": 0,
  • "serviceName": "string",
  • "spoofDetectorConfig": {
    },
  • "previewAttributesConfig": {
    },
  • "objectDetectorResourceId": "string",
  • "objectDetectorConfig": {
    }
}

Deletes a camera by its id.

path Parameters
id
required
string <uuid>

Id of the camera.

Responses

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Retrieves all cameras.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Updates the specified camera.

Supported values for FaceDetectorResourceId are:

none, cpu, gpu, accurate_cpu, accurate_gpu, cpu_remote, gpu_remote, any_remote, accurate_cpu_remote, accurate_gpu_remote, accurate_any_remote

Supported values for TemplateGeneratorResourceId are:

cpu, gpu, any

Supported values for PedestrianDetectorResourceId are:

none, cpu_remote, gpu_remote, any_remote, sfe_object_cpu_remote, sfe_object_gpu_remote, sfe_object_any_remote

Supported values for SpoofDetectorResourceIds are:

none, liveness_distant_cpu_remote, liveness_distant_gpu_remote, liveness_distant_any_remote, liveness_nearby_cpu_remote, liveness_nearby_gpu_remote, liveness_nearby_any_remote

Supported values for PedestrianExtractorResourceId are:

cpu, gpu, any, none

Supported values for ObjectDetectorResourceId are:

none, sfe_object_cpu_remote, sfe_object_gpu_remote, sfe_object_any_remote

Supported values for FaceSaveStrategy are:

Balanced, None, All, MatchedOnly

Supported values for PedestrianSaveStrategy are:

Balanced, None, All

Supported values for ObjectSaveStrategy are:

Balanced, None, All
Request Body schema:

New camera configuration.

id
required
string <uuid>
name
required
string
source
required
string
enabled
required
boolean
required
object (VideoFaceDetectorConfig)
object (VideoPedestrianDetectorConfig)
faceDetectorResourceId
required
string
templateGeneratorResourceId
required
string
pedestrianDetectorResourceId
string or null
pedestrianExtractorResourceId
string or null
redetectionTime
required
integer <int32>
templateGenerationTime
required
integer <int32>
trackMotionOptimization
required
string
trackSpeedAccuracyMode
string or null
faceSaveStrategy
required
string
pedestrianSaveStrategy
string or null
maskImagePath
required
string or null
saveFrameImageData
required
boolean
imageQuality
required
integer <int32>
mpeG1PreviewEnabled
required
boolean
mpeG1PreviewPort
required
integer <int32>
mpeG1VideoBitrate
required
integer <int32>
previewMaxDimension
required
integer <int32>
spoofDetectorResourceIds
Array of strings or null
object (CameraSpoofDetectorConfigUpdateRequest)
object (PreviewAttributesConfigUpdateRequest)
objectDetectorResourceId
string or null
objectSaveStrategy
string or null
object (ObjectDetectorConfigUpdateRequest)

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "source": "string",
  • "enabled": true,
  • "faceDetectorConfig": {
    },
  • "pedestrianDetectorConfig": {
    },
  • "faceDetectorResourceId": "string",
  • "templateGeneratorResourceId": "string",
  • "pedestrianDetectorResourceId": "string",
  • "pedestrianExtractorResourceId": "string",
  • "redetectionTime": 0,
  • "templateGenerationTime": 0,
  • "trackMotionOptimization": "string",
  • "trackSpeedAccuracyMode": "string",
  • "faceSaveStrategy": "string",
  • "pedestrianSaveStrategy": "string",
  • "maskImagePath": "string",
  • "saveFrameImageData": true,
  • "imageQuality": 0,
  • "mpeG1PreviewEnabled": true,
  • "mpeG1PreviewPort": 0,
  • "mpeG1VideoBitrate": 0,
  • "previewMaxDimension": 0,
  • "spoofDetectorResourceIds": [
    ],
  • "spoofDetectorConfig": {
    },
  • "previewAttributesConfig": {
    },
  • "objectDetectorResourceId": "string",
  • "objectSaveStrategy": "string",
  • "objectDetectorConfig": {
    }
}

Response samples

Content type
application/json
{
  • "spoofDetectorResourceIds": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "source": "string",
  • "enabled": true,
  • "faceDetectorConfig": {
    },
  • "pedestrianDetectorConfig": {
    },
  • "faceDetectorResourceId": "string",
  • "templateGeneratorResourceId": "string",
  • "pedestrianDetectorResourceId": "string",
  • "pedestrianExtractorResourceId": "string",
  • "redetectionTime": 0,
  • "templateGenerationTime": 0,
  • "trackMotionOptimization": "string",
  • "trackSpeedAccuracyMode": "string",
  • "faceSaveStrategy": "string",
  • "pedestrianSaveStrategy": "string",
  • "objectSaveStrategy": "string",
  • "maskImagePath": "string",
  • "saveFrameImageData": true,
  • "imageQuality": 0,
  • "mpeG1PreviewEnabled": true,
  • "mpeG1PreviewPort": 0,
  • "mpeG1VideoBitrate": 0,
  • "previewMaxDimension": 0,
  • "serviceName": "string",
  • "spoofDetectorConfig": {
    },
  • "previewAttributesConfig": {
    },
  • "objectDetectorResourceId": "string",
  • "objectDetectorConfig": {
    }
}

Creates a new camera.

Supported values for FaceDetectorResourceId are:

none, cpu, gpu, accurate_cpu, accurate_gpu, cpu_remote, gpu_remote, any_remote, accurate_cpu_remote, accurate_gpu_remote, accurate_any_remote

Supported values for TemplateGeneratorResourceId are:

cpu, gpu, any

Supported values for PedestrianDetectorResourceId are:

none, cpu_remote, gpu_remote, any_remote, sfe_object_cpu_remote, sfe_object_gpu_remote, sfe_object_any_remote

Supported values for SpoofDetectorResourceIds are:

none, liveness_distant_cpu_remote, liveness_distant_gpu_remote, liveness_distant_any_remote, liveness_nearby_cpu_remote, liveness_nearby_gpu_remote, liveness_nearby_any_remote

Supported values for PedestrianExtractorResourceId are:

cpu, gpu, any, none

Supported values for ObjectDetectorResourceId are:

none, sfe_object_cpu_remote, sfe_object_gpu_remote, sfe_object_any_remote

Supported values for FaceSaveStrategy are:

Balanced, None, All, MatchedOnly

Supported values for PedestrianSaveStrategy are:

Balanced, None, All

Supported values for ObjectSaveStrategy are:

Balanced, None, All
Request Body schema:

New camera configuration.

name
required
string
Default: "camera name"
source
required
string
Default: "rtsp://user:password@cameraHostnameOrIp:554/Streaming/Channels/101"
enabled
boolean or null
Default: false
object (FaceDetectorConfigCreateRequest)
faceDetectorResourceId
string or null
Default: "cpu"
object (PedestrianDetectorConfigCreateRequest)
pedestrianDetectorResourceId
string or null
Default: "none"
pedestrianExtractorResourceId
string or null
Default: "none"
templateGeneratorResourceId
string or null
Default: "cpu"
redetectionTime
integer or null <int32>
Default: 500
templateGenerationTime
integer or null <int32>
Default: 500
trackMotionOptimization
string or null
Default: "track.motion_optimization.history_long.fast"
trackSpeedAccuracyMode
string or null
Default: "accurate"
faceSaveStrategy
string or null
Default: "FirstFace, BestFace"
pedestrianSaveStrategy
string or null
Default: "Best"
maskImagePath
string or null
Default: null
saveFrameImageData
boolean or null
Default: true
imageQuality
integer or null <int32>
Default: 90
mpeG1PreviewEnabled
boolean or null
Default: true
mpeG1PreviewPort
integer or null <int32>
Default: null
mpeG1VideoBitrate
integer or null <int32>
Default: 450000
previewMaxDimension
integer or null <int32>
Default: 640
serviceName
string or null
Default: ""
spoofDetectorResourceIds
Array of strings or null
Default: ["none"]
object (CameraSpoofDetectorConfigCreateRequest)
object (PreviewAttributesConfigCreateRequest)
objectDetectorResourceId
string or null
Default: "none"
objectSaveStrategy
string or null
Default: "Best"
object (ObjectDetectorConfigCreateRequest)

Responses

Request samples

Content type
{
  • "name": "camera name",
  • "source": "rtsp://user:password@cameraHostnameOrIp:554/Streaming/Channels/101",
  • "enabled": false,
  • "faceDetectorConfig": {
    },
  • "faceDetectorResourceId": "cpu",
  • "pedestrianDetectorConfig": {
    },
  • "pedestrianDetectorResourceId": "none",
  • "pedestrianExtractorResourceId": "none",
  • "templateGeneratorResourceId": "cpu",
  • "redetectionTime": 500,
  • "templateGenerationTime": 500,
  • "trackMotionOptimization": "track.motion_optimization.history_long.fast",
  • "trackSpeedAccuracyMode": "accurate",
  • "faceSaveStrategy": "FirstFace, BestFace",
  • "pedestrianSaveStrategy": "Best",
  • "maskImagePath": null,
  • "saveFrameImageData": true,
  • "imageQuality": 90,
  • "mpeG1PreviewEnabled": true,
  • "mpeG1PreviewPort": null,
  • "mpeG1VideoBitrate": 450000,
  • "previewMaxDimension": 640,
  • "serviceName": "",
  • "spoofDetectorResourceIds": [
    ],
  • "spoofDetectorConfig": {
    },
  • "previewAttributesConfig": {
    },
  • "objectDetectorResourceId": "none",
  • "objectSaveStrategy": "Best",
  • "objectDetectorConfig": {
    }
}

Response samples

Content type
application/json
{
  • "spoofDetectorResourceIds": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "source": "string",
  • "enabled": true,
  • "faceDetectorConfig": {
    },
  • "pedestrianDetectorConfig": {
    },
  • "faceDetectorResourceId": "string",
  • "templateGeneratorResourceId": "string",
  • "pedestrianDetectorResourceId": "string",
  • "pedestrianExtractorResourceId": "string",
  • "redetectionTime": 0,
  • "templateGenerationTime": 0,
  • "trackMotionOptimization": "string",
  • "trackSpeedAccuracyMode": "string",
  • "faceSaveStrategy": "string",
  • "pedestrianSaveStrategy": "string",
  • "objectSaveStrategy": "string",
  • "maskImagePath": "string",
  • "saveFrameImageData": true,
  • "imageQuality": 0,
  • "mpeG1PreviewEnabled": true,
  • "mpeG1PreviewPort": 0,
  • "mpeG1VideoBitrate": 0,
  • "previewMaxDimension": 0,
  • "serviceName": "string",
  • "spoofDetectorConfig": {
    },
  • "previewAttributesConfig": {
    },
  • "objectDetectorResourceId": "string",
  • "objectDetectorConfig": {
    }
}

Retrieves tracklets with faces as a paged collection by their camera Id.

Page number, page size and sorting order can be specified. You can also show total items count.

path Parameters
id
required
string <uuid>

Id of the camera.

query Parameters
Ascending
boolean
PageNumber
integer <int32> [ 1 .. 2147483647 ]
PageSize
integer <int32> [ 1 .. 2147483647 ]
ShowTotalCount
boolean

Responses

Response samples

Content type
application/json
{
  • "totalItemsCount": 0,
  • "items": [
    ],
  • "pageSize": 0,
  • "pageNumber": 0,
  • "previousPage": "string",
  • "nextPage": "string"
}

Retrieves frames as a paged collection by their camera Id.

Page number, page size and sorting order can be specified. You can also show total items count.

path Parameters
id
required
string <uuid>

Id of the camera.

query Parameters
Ascending
boolean
PageNumber
integer <int32> [ 1 .. 2147483647 ]
PageSize
integer <int32> [ 1 .. 2147483647 ]
ShowTotalCount
boolean

Responses

Response samples

Content type
application/json
{
  • "totalItemsCount": 0,
  • "items": [
    ],
  • "pageSize": 0,
  • "pageNumber": 0,
  • "previousPage": "string",
  • "nextPage": "string"
}

Detection

Detects pedestrians and objects on the image

Supported values for PedestrianDetectorResourceId are:

none, sfe_object_cpu_remote, sfe_object_gpu_remote, sfe_object_any_remote

Supported values for ObjectDetectorResourceId are:

none, sfe_object_cpu_remote, sfe_object_gpu_remote, sfe_object_any_remote
Request Body schema:

Detection Request

required
object (ImageData)
pedestrianDetectorResourceId
required
string
Default: "none"
object (PedestrianDetectorConfigCreateRequest)
objectDetectorResourceId
required
string
Default: "none"
object (ObjectDetectorConfigCreateRequest)
includeCrops
boolean
Default: false

Responses

Request samples

Content type
{
  • "image": {
    },
  • "pedestrianDetectorResourceId": "none",
  • "pedestrianDetectorConfig": {
    },
  • "objectDetectorResourceId": "none",
  • "objectDetectorConfig": {
    },
  • "includeCrops": false
}

Response samples

Content type
application/json
{
  • "pedestrians": [
    ],
  • "objects": [
    ]
}

EdgeStream

Retrieves the EdgeStream by its Id.

path Parameters
id
required
string <uuid>

Id of the EdgeStream.

Responses

Response samples

Content type
application/json
{
  • "spoofDetectorResourceIds": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "clientId": "string",
  • "name": "string",
  • "enabled": true,
  • "saveFrameImageData": true,
  • "templateGeneratorResourceId": "string",
  • "faceSaveStrategy": "string",
  • "spoofDetectorConfig": {
    },
  • "settings": {
    },
  • "objectSaveStrategy": "string"
}

Deletes a EdgeStream by its id.

path Parameters
id
required
string <uuid>

Id of the EdgeStream.

Responses

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Retrieves all EdgeStreams.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates a new EdgeStream.

Supported values for TemplateGeneratorResourceId are:

cpu, gpu, any

Supported values for FaceSaveStrategy are:

Balanced, All, MatchedOnly

Supported values for SpoofDetectorResourceIds are:

none, liveness_distant_cpu_remote, liveness_distant_gpu_remote, liveness_distant_any_remote, liveness_nearby_cpu_remote, liveness_nearby_gpu_remote, liveness_nearby_any_remote

Supported values for ObjectSaveStrategy are:

Balanced, All, MatchedOnly
Request Body schema:

New EdgeStream configuration.

enabled
boolean
Default: false
name
required
string
Default: "unspecified"
clientId
required
string
saveFrameImageData
boolean
Default: false
templateGeneratorResourceId
string or null
Default: "cpu"
faceSaveStrategy
string or null
Default: "FirstFace, BestFace"
spoofDetectorResourceIds
Array of strings or null
Default: ["none"]
object (EdgeStreamSpoofDetectorConfigCreateRequest)
object (EdgeStreamSettingsCreateRequest)
objectSaveStrategy
string or null
Default: "Balanced"

Responses

Request samples

Content type
{
  • "enabled": false,
  • "name": "unspecified",
  • "clientId": "string",
  • "saveFrameImageData": false,
  • "templateGeneratorResourceId": "cpu",
  • "faceSaveStrategy": "FirstFace, BestFace",
  • "spoofDetectorResourceIds": [
    ],
  • "spoofDetectorConfig": {
    },
  • "settings": {
    },
  • "objectSaveStrategy": "Balanced"
}

Response samples

Content type
application/json
{
  • "spoofDetectorResourceIds": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "clientId": "string",
  • "name": "string",
  • "enabled": true,
  • "saveFrameImageData": true,
  • "templateGeneratorResourceId": "string",
  • "faceSaveStrategy": "string",
  • "spoofDetectorConfig": {
    },
  • "settings": {
    },
  • "objectSaveStrategy": "string"
}

Updates the specified EdgeStream.

Supported values for TemplateGeneratorResourceId are:

cpu, gpu, any

Supported values for FaceSaveStrategy are:

Balanced, All, MatchedOnly

Supported values for SpoofDetectorResourceIds are:

none, liveness_distant_cpu_remote, liveness_distant_gpu_remote, liveness_distant_any_remote, liveness_nearby_cpu_remote, liveness_nearby_gpu_remote, liveness_nearby_any_remote

Supported values for ObjectSaveStrategy are:

Balanced, All, MatchedOnly
Request Body schema:

New EdgeStream configuration.

id
required
string <uuid>
clientId
required
string
enabled
required
boolean
name
required
string
saveFrameImageData
boolean or null
templateGeneratorResourceId
required
string
faceSaveStrategy
required
string
spoofDetectorResourceIds
Array of strings or null
object (EdgeStreamSpoofDetectorConfigUpdateRequest)
object (EdgeStreamSettingsUpdateRequest)
objectSaveStrategy
string or null

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "clientId": "string",
  • "enabled": true,
  • "name": "string",
  • "saveFrameImageData": true,
  • "templateGeneratorResourceId": "string",
  • "faceSaveStrategy": "string",
  • "spoofDetectorResourceIds": [
    ],
  • "spoofDetectorConfig": {
    },
  • "settings": {
    },
  • "objectSaveStrategy": "string"
}

Response samples

Content type
application/json
{
  • "spoofDetectorResourceIds": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "clientId": "string",
  • "name": "string",
  • "enabled": true,
  • "saveFrameImageData": true,
  • "templateGeneratorResourceId": "string",
  • "faceSaveStrategy": "string",
  • "spoofDetectorConfig": {
    },
  • "settings": {
    },
  • "objectSaveStrategy": "string"
}

Sets the watchlist synchronization for the specified EdgeStream.

Supported values for watchlistSyncOption are: 

None, All, Selected
path Parameters
id
required
string <uuid>
Request Body schema:

Settings for watchlist synchronization

watchlistSyncOption
required
string
Default: "None"
watchlistIds
Array of strings or null

Responses

Request samples

Content type
{
  • "watchlistSyncOption": "None",
  • "watchlistIds": [
    ]
}

Response samples

Content type
application/json
{
  • "watchlistSyncOption": "string",
  • "watchlistIds": [
    ]
}

Retrieves watchlist synchronization settings for the specified EdgeStream.

path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "watchlistSyncOption": "string",
  • "watchlistIds": [
    ]
}

Face

Retrieves the face by its Id.

path Parameters
id
required
string <uuid>

Id of the face.

Responses

Response samples

Content type
application/json
{
  • "trackletId": "18b0bea4-b937-4751-a328-bee6bf88d141",
  • "quality": 0,
  • "templateQuality": 0,
  • "state": "New",
  • "imageDataId": "b24530bd-cd48-48ab-ad8c-8f8a9678282e",
  • "processedAt": "2019-08-24T14:15:22Z",
  • "cropLeftTopX": 0.1,
  • "cropLeftTopY": 0.1,
  • "cropRightTopX": 0.1,
  • "cropRightTopY": 0.1,
  • "cropLeftBottomX": 0.1,
  • "cropLeftBottomY": 0.1,
  • "cropRightBottomX": 0.1,
  • "cropRightBottomY": 0.1,
  • "leftEyeX": 0.1,
  • "leftEyeY": 0.1,
  • "rightEyeX": 0.1,
  • "rightEyeY": 0.1,
  • "frameId": "64f96310-c601-4761-a13a-8f7335bbd0b0",
  • "type": "Regular",
  • "age": 0.1,
  • "gender": 0.1,
  • "faceMaskConfidence": 0.1,
  • "noseTipConfidence": 0.1,
  • "faceMaskStatus": "Unknown",
  • "faceArea": 0.1,
  • "size": 0.1,
  • "faceOrder": 0,
  • "facesOnFrameCount": 0,
  • "faceAreaChange": 0.1,
  • "yawAngle": 0.1,
  • "pitchAngle": 0.1,
  • "rollAngle": 0.1,
  • "autolearnClusterType": "string",
  • "sharpness": 0.1,
  • "brightness": 0.1,
  • "tintedGlasses": 0.1,
  • "heavyFrame": 0.1,
  • "glassStatus": 0.1,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Deletes the face by its Id.

path Parameters
id
required
string <uuid>

Id of the face to delete.

Responses

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Retrieves faces as a paged collection.

Page number, page size and sorting order can be specified. You can also show total items count.

query Parameters
Ascending
boolean
PageNumber
integer <int32> [ 1 .. 2147483647 ]
PageSize
integer <int32> [ 1 .. 2147483647 ]
ShowTotalCount
boolean

Responses

Response samples

Content type
application/json
{
  • "totalItemsCount": 0,
  • "items": [
    ],
  • "pageSize": 0,
  • "pageNumber": 0,
  • "previousPage": "string",
  • "nextPage": "string"
}

Searches for similar stored faces based on the given image.

Supported values for FaceDetectorResourceId are:

cpu, gpu, any, accurate_cpu, accurate_gpu, accurate_any

Supported values for TemplateGeneratorResourceId are:

cpu, gpu, any
Request Body schema:

Request containing reference image to be searched.

required
object (ImageData)
threshold
integer <int32>
Default: 30
object (FaceSearchDetectorConfig)
faceDetectorResourceId
string
Default: "cpu"
templateGeneratorResourceId
string
Default: "cpu"

Responses

Request samples

Content type
{
  • "image": {
    },
  • "threshold": 30,
  • "faceDetectorConfig": {
    },
  • "faceDetectorResourceId": "cpu",
  • "templateGeneratorResourceId": "cpu"
}

Response samples

Content type
application/json
{
  • "searchSessionId": "818068ab-dd15-41d8-9a25-820e16c4e745"
}

Checks liveness of one face on the given image.

Supported values for FaceDetectorResourceId are:

cpu, gpu, any, accurate_cpu, accurate_gpu, accurate_any

Supported values for SpoofDetectorResourceId are:

liveness_distant_any_remote, liveness_distant_cpu_remote, liveness_distant_gpu_remote
liveness_nearby_any_remote, liveness_nearby_cpu_remote, liveness_nearby_gpu_remote


SpoofCheckConfig.KeepEvaluatingConditionsAfterFirstFail is used

to evaluate all conditions supplied with Nearby/Distant LivenessConditions.

When true it can have slight performance impact, because all conditions are evaluated

Request Body schema:

Request containing reference image to be checked and configuration.

required
object (ImageData)
object (FaceSearchDetectorConfig)
faceDetectorResourceId
string
Default: "cpu"
spoofDetectorResourceIds
Array of strings
Default: ["liveness_distant_cpu_remote"]
object (SpoofCheckConfig)

Responses

Request samples

Content type
{
  • "image": {
    },
  • "faceDetectorConfig": {
    },
  • "faceDetectorResourceId": "cpu",
  • "spoofDetectorResourceIds": [
    ],
  • "spoofCheckConfig": {
    }
}

Response samples

Content type
application/json
{
  • "performed": true,
  • "passed": true,
  • "distantLivenessSpoofCheck": {
    },
  • "nearbyLivenessSpoofCheck": {
    }
}

Calculates confidence that two faces on sent photos belong to the same person.

Supported values for FaceDetectorResourceId are:

cpu, gpu, any, accurate_cpu, accurate_gpu, accurate_any

Supported values for TemplateGeneratorResourceId are:

cpu, gpu, any
Request Body schema:

Request containing images with faces to be compared

required
object (FaceProbe)
required
object (FaceProbe)

Responses

Request samples

Content type
{
  • "probeImage": {
    },
  • "referenceImage": {
    }
}

Response samples

Content type
application/json
{
  • "confidence": 0.1,
  • "probeFaceDetails": {
    },
  • "referenceFaceDetails": {
    }
}

Frame

Retrieves the frame by its Id.

path Parameters
id
required
string <uuid>

Id of the frame.

Responses

Response samples

Content type
application/json
{
  • "state": "New",
  • "imageDataId": "b24530bd-cd48-48ab-ad8c-8f8a9678282e",
  • "receivedAt": "2019-08-24T14:15:22Z",
  • "positionInMs": 0,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Deletes the frame by its Id.

path Parameters
id
required
string <uuid>

Id of the frame to delete.

Responses

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Retrieves frames as a paged collection.

Page number, page size and sorting order can be specified. You can also show total items count.

query Parameters
Ascending
boolean
PageNumber
integer <int32> [ 1 .. 2147483647 ]
PageSize
integer <int32> [ 1 .. 2147483647 ]
ShowTotalCount
boolean

Responses

Response samples

Content type
application/json
{
  • "totalItemsCount": 0,
  • "items": [
    ],
  • "pageSize": 0,
  • "pageNumber": 0,
  • "previousPage": "string",
  • "nextPage": "string"
}

Image

Retrieves the image by its Id.

Two optional parameters can be specified that allow the image to be resize to given values. More specifically, minSize will resize the smaller edge to minSize, maxSize will resize the larger edge to maxSize.

path Parameters
id
required
string <uuid>

Id of the image.

query Parameters
minSize
integer <int32>

Minimum size of the smaller edge.

maxSize
integer <int32>

Maximum size of the larger edge.

Responses

Individual

Retrieves the individual by its Id.

path Parameters
id
required
string <uuid>

Id of the individual.

Responses

Response samples

Content type
application/json
{
  • "entranceTime": "2019-08-24T14:15:22Z",
  • "exitTime": "2019-08-24T14:15:22Z",
  • "bestFaceId": "e31e4289-5708-47d5-b6ca-d84960c86859",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Deletes the individual by its Id.

path Parameters
id
required
string <uuid>

Id of the individual to delete.

Responses

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Retrieves individuals as a paged collection.

Page number, page size and sorting order can be specified. You can also show total items count.

query Parameters
Ascending
boolean
PageNumber
integer <int32> [ 1 .. 2147483647 ]
PageSize
integer <int32> [ 1 .. 2147483647 ]
ShowTotalCount
boolean

Responses

Response samples

Content type
application/json
{
  • "totalItemsCount": 0,
  • "items": [
    ],
  • "pageSize": 0,
  • "pageNumber": 0,
  • "previousPage": "string",
  • "nextPage": "string"
}

Retrieves the tracklets with faces by their individual Id.

Page number, page size and sorting order can be specified. You can also show total items count.

path Parameters
id
required
string <uuid>

Id of the individual.

query Parameters
Ascending
boolean
PageNumber
integer <int32> [ 1 .. 2147483647 ]
PageSize
integer <int32> [ 1 .. 2147483647 ]
ShowTotalCount
boolean

Responses

Response samples

Content type
application/json
{
  • "totalItemsCount": 0,
  • "items": [
    ],
  • "pageSize": 0,
  • "pageNumber": 0,
  • "previousPage": "string",
  • "nextPage": "string"
}

Searches for individuals by image in the specified grouping.

Supported values for FaceDetectorResourceId are:

cpu, gpu, any, accurate_cpu, accurate_gpu, accurate_any

Supported values for TemplateGeneratorResourceId are:

cpu, gpu, any
Request Body schema:

Request containing image, grouping id and resources.

required
object (ImageData)
groupingId
required
string <uuid>
matchThreshold
integer <int32>
object (FaceDetectorConfig)
faceDetectorResourceId
string
templateGeneratorResourceId
string

Responses

Request samples

Content type
{
  • "image": {
    },
  • "groupingId": "0623992d-dd3b-464d-ac71-6d3dae8b6747",
  • "matchThreshold": 0,
  • "faceDetectorConfig": {
    },
  • "faceDetectorResourceId": "string",
  • "templateGeneratorResourceId": "string"
}

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Splits specified individual, assigns specified tracklets to the newly created individual.

Specified tracklets must be part of the previous individual.

Request Body schema:

Request containing tracklets and previous individual id.

trackletsIds
required
Array of strings <uuid> non-empty [ items <uuid > ]
previousIndividualId
required
string <uuid>

Responses

Request samples

Content type
{
  • "trackletsIds": [
    ],
  • "previousIndividualId": "24934456-8c83-4d91-85e7-dad15bdbd3a0"
}

Response samples

Content type
application/json
{
  • "individualId": "71e477fd-125d-45ef-9857-0e1cc3fa4b98"
}

Merges multiple individuals into one individual.

Individuals are merged into a individual, whose id is the first id in the request array of individuals.

Request Body schema:

Request containing array of individuals to be merged.

individualIds
required
Array of strings <uuid> >= 2 items [ items <uuid > ]

Responses

Request samples

Content type
{
  • "individualIds": [
    ]
}

Response samples

Content type
application/json
{
  • "individualId": "71e477fd-125d-45ef-9857-0e1cc3fa4b98"
}

LiveGrouping

Retrieves the live grouping by its id.

path Parameters
groupingId
required
string <uuid>

Id of the live grouping.

Responses

Response samples

Content type
application/json
{
  • "config": {
    },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "description": "string"
}

Deletes a live grouping by its id.

path Parameters
groupingId
required
string <uuid>

Id of the live grouping.

Responses

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Retrieves all live groupings.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates a new live grouping.

Request Body schema:

Request containing live grouping properties

object (LiveGroupingConfigCreateRequest)
description
string or null

Responses

Request samples

Content type
{
  • "config": {
    },
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "config": {
    },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "description": "string"
}

Updates the specified live grouping.

Request Body schema:
required
object (LiveGroupingConfigUpdateRequest)
id
required
string <uuid>
description
required
string or null

Responses

Request samples

Content type
{
  • "config": {
    },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "config": {
    },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "description": "string"
}

Retrieves streams belonging to a live grouping with given id.

path Parameters
groupingId
required
string <uuid>

Id of the live grouping.

Responses

Response samples

Content type
application/json
{
  • "cameras": [
    ],
  • "edgeStreams": [
    ]
}

Retrieves cameras belonging to a live grouping with given id.

path Parameters
groupingId
required
string <uuid>

Id of the live grouping.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieves the individuals belonging to a live grouping with given id.

Page number, page size and sorting order can be specified. You can also show total items count.

path Parameters
groupingId
required
string <uuid>

Id of the live grouping.

query Parameters
Ascending
boolean
PageNumber
integer <int32> [ 1 .. 2147483647 ]
PageSize
integer <int32> [ 1 .. 2147483647 ]
ShowTotalCount
boolean

Responses

Response samples

Content type
application/json
{
  • "totalItemsCount": 0,
  • "items": [
    ],
  • "pageSize": 0,
  • "pageNumber": 0,
  • "previousPage": "string",
  • "nextPage": "string"
}

Retrieves the frames belonging to a live grouping with given id.

Page number, page size and sorting order can be specified. You can also show total items count.

path Parameters
groupingId
required
string <uuid>

Id of the live grouping.

query Parameters
Ascending
boolean
PageNumber
integer <int32> [ 1 .. 2147483647 ]
PageSize
integer <int32> [ 1 .. 2147483647 ]
ShowTotalCount
boolean

Responses

Response samples

Content type
application/json
{
  • "totalItemsCount": 0,
  • "items": [
    ],
  • "pageSize": 0,
  • "pageNumber": 0,
  • "previousPage": "string",
  • "nextPage": "string"
}

Links specified streams to a given live grouping.

path Parameters
groupingId
required
string <uuid>

Id of the live grouping.

Request Body schema:

Request containing camera ids.

ids
required
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Unlink specified streams from a live grouping.

path Parameters
groupingId
required
string <uuid>

Id of the live grouping

Request Body schema:

Request containing camera ids.

ids
required
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Links specified cameras to a given live grouping.

path Parameters
groupingId
required
string <uuid>

Id of the live grouping.

Request Body schema:

Request containing camera ids.

ids
required
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Unlink specified cameras from a live grouping.

path Parameters
groupingId
required
string <uuid>

Id of the live grouping

Request Body schema:

Request containing camera ids.

ids
required
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Pedestrian

Retrieves the pedestrian by its Id.

path Parameters
id
required
string <uuid>

Id of the pedestrian.

Responses

Response samples

Content type
application/json
{
  • "trackletId": "18b0bea4-b937-4751-a328-bee6bf88d141",
  • "frameId": "64f96310-c601-4761-a13a-8f7335bbd0b0",
  • "streamId": "22cb260b-fac8-4ce4-8488-8f1949304300",
  • "imageDataId": "b24530bd-cd48-48ab-ad8c-8f8a9678282e",
  • "processedAt": "2019-08-24T14:15:22Z",
  • "quality": 0,
  • "cropLeftTopX": 0.1,
  • "cropLeftTopY": 0.1,
  • "cropRightTopX": 0.1,
  • "cropRightTopY": 0.1,
  • "cropLeftBottomX": 0.1,
  • "cropLeftBottomY": 0.1,
  • "cropRightBottomX": 0.1,
  • "cropRightBottomY": 0.1,
  • "areaOnFrame": 0.1,
  • "size": 0.1,
  • "objectOrderOnFrameForType": 0,
  • "objectsOnFrameCountForType": 0,
  • "poses": [
    ],
  • "earLeftX": 0.1,
  • "earLeftY": 0.1,
  • "earRightX": 0.1,
  • "earRightY": 0.1,
  • "eyeLeftX": 0.1,
  • "eyeLeftY": 0.1,
  • "eyeRightX": 0.1,
  • "eyeRightY": 0.1,
  • "noseX": 0.1,
  • "noseY": 0.1,
  • "neckX": 0.1,
  • "neckY": 0.1,
  • "shoulderLeftX": 0.1,
  • "shoulderLeftY": 0.1,
  • "shoulderRightX": 0.1,
  • "shoulderRightY": 0.1,
  • "elbowLeftX": 0.1,
  • "elbowLeftY": 0.1,
  • "elbowRightX": 0.1,
  • "elbowRightY": 0.1,
  • "wristLeftX": 0.1,
  • "wristLeftY": 0.1,
  • "wristRightX": 0.1,
  • "wristRightY": 0.1,
  • "hipLeftX": 0.1,
  • "hipLeftY": 0.1,
  • "hipRightX": 0.1,
  • "hipRightY": 0.1,
  • "kneeLeftX": 0.1,
  • "kneeLeftY": 0.1,
  • "kneeRightX": 0.1,
  • "kneeRightY": 0.1,
  • "ankleLeftX": 0.1,
  • "ankleLeftY": 0.1,
  • "ankleRightX": 0.1,
  • "ankleRightY": 0.1,
  • "objectAttributes": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Deletes the pedestrian by its Id.

path Parameters
id
required
string <uuid>

Id of the pedestrian to delete.

Responses

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Retrieves pedestrians as a paged collection.

Page number, page size and sorting order can be specified. You can also show total items count.

query Parameters
Ascending
boolean
PageNumber
integer <int32> [ 1 .. 2147483647 ]
PageSize
integer <int32> [ 1 .. 2147483647 ]
ShowTotalCount
boolean

Responses

Response samples

Content type
application/json
{
  • "totalItemsCount": 0,
  • "items": [
    ],
  • "pageSize": 0,
  • "pageNumber": 0,
  • "previousPage": "string",
  • "nextPage": "string"
}

RecordGrouping

Retrieves a record grouping by its id.

path Parameters
groupingId
required
string <uuid>

Id of the record grouping.

Responses

Response samples

Content type
application/json
{
  • "config": {
    },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "description": "string"
}

Deletes a record grouping by its id.

path Parameters
groupingId
required
string <uuid>

Id of the record grouping.

Responses

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Retrieves all record groupings.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates a new record grouping.

Request Body schema:

Request containing new record grouping configuration.

object (RecordGroupingConfigCreateRequest)
description
string or null

Responses

Request samples

Content type
{
  • "config": {
    },
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "config": {
    },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "description": "string"
}

Updates a specified record grouping.

Request Body schema:

New record grouping configuration.

required
object (RecordGroupingConfig)
id
required
string <uuid>
description
required
string or null

Responses

Request samples

Content type
{
  • "config": {
    },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "config": {
    },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "description": "string"
}

Retrieves video records belonging to record grouping with given id.

path Parameters
groupingId
required
string <uuid>

Id of the record grouping.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieves individuals belonging to a record grouping with given id.

Page number, page size and sorting order can be specified. You can also show total items count.

path Parameters
groupingId
required
string <uuid>

Id of the record grouping.

query Parameters
Ascending
boolean
PageNumber
integer <int32> [ 1 .. 2147483647 ]
PageSize
integer <int32> [ 1 .. 2147483647 ]
ShowTotalCount
boolean

Responses

Response samples

Content type
application/json
{
  • "totalItemsCount": 0,
  • "items": [
    ],
  • "pageSize": 0,
  • "pageNumber": 0,
  • "previousPage": "string",
  • "nextPage": "string"
}

Retrieves frames belonging to a record grouping with given id.

Page number, page size and sorting order can be specified. You can also show total items count.

path Parameters
groupingId
required
string <uuid>

Id of the record grouping.

query Parameters
Ascending
boolean
PageNumber
integer <int32> [ 1 .. 2147483647 ]
PageSize
integer <int32> [ 1 .. 2147483647 ]
ShowTotalCount
boolean

Responses

Response samples

Content type
application/json
{
  • "totalItemsCount": 0,
  • "items": [
    ],
  • "pageSize": 0,
  • "pageNumber": 0,
  • "previousPage": "string",
  • "nextPage": "string"
}

Uploads the image to a specified record grouping.

Supported values for FaceDetectorResourceId are:

cpu, gpu, any, accurate_cpu, accurate_gpu, accurate_any
path Parameters
groupingId
required
string <uuid>

Id of the record grouping.

Request Body schema:

Request containing image data.

required
object (ImageData)
object (FaceDetectorConfig)
faceDetectorResourceId
string

Responses

Request samples

Content type
{
  • "imageData": {
    },
  • "faceDetectorConfig": {
    },
  • "faceDetectorResourceId": "string"
}

Response samples

Content type
application/json
{
  • "frameId": "64f96310-c601-4761-a13a-8f7335bbd0b0",
  • "frameImageDataId": "560155aa-cea0-4cc8-9a81-2a52f9f10c7f"
}

Retrieves the state of the record grouping.

path Parameters
groupingId
required
string <uuid>

Id of the record grouping.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "numNewFrames": 0,
  • "numUnprocFrames": 0,
  • "status": "Processing"
}

Triggers a start of the record grouping.

path Parameters
groupingId
required
string <uuid>

Id of the record grouping.

Responses

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Links specified video records to a given record grouping.

path Parameters
groupingId
required
string <uuid>

Id of the record grouping.

Request Body schema:

Request containing video record ids.

ids
required
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Unlinks specified video records from a record grouping.

path Parameters
groupingId
required
string <uuid>

Id of the record grouping

Request Body schema:

Request containing video records ids.

ids
required
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

SetupDataStorage

Retrieves the current video data storage config.

Responses

Response samples

Content type
application/json
{
  • "storageMode": "None"
}

Updates the video data storage config with specified values.

Request Body schema:

The new video data storage configuration.

storageMode
required
string (VideoDataStorageMode)
Enum: "None" "All"

Responses

Request samples

Content type
{
  • "storageMode": "None"
}

Response samples

Content type
application/json
{
  • "storageMode": "None"
}

SetupDbCleanup

Retrieves current database cleanup config.

Responses

Response samples

Content type
application/json
{
  • "cleanupAmount": 0,
  • "enabled": true,
  • "maxFramesCount": 0,
  • "maxImageDataAge": 0,
  • "cleanupStart": "string",
  • "deleteSql": true,
  • "deleteMatchResults": true
}

Updates the database cleanup config with specified values.

Request Body schema:

The new database cleanup configuration.

cleanupAmount
integer or null <int32>
Deprecated
enabled
required
boolean
maxFramesCount
required
integer or null <int32>
maxImageDataAge
required
integer or null <int32>
cleanupStart
required
string or null <date-span>
deleteSql
required
boolean or null
deleteMatchResults
required
boolean or null

Responses

Request samples

Content type
{
  • "cleanupAmount": 0,
  • "enabled": true,
  • "maxFramesCount": 0,
  • "maxImageDataAge": 0,
  • "cleanupStart": "string",
  • "deleteSql": true,
  • "deleteMatchResults": true
}

Response samples

Content type
application/json
{
  • "cleanupAmount": 0,
  • "enabled": true,
  • "maxFramesCount": 0,
  • "maxImageDataAge": 0,
  • "cleanupStart": "string",
  • "deleteSql": true,
  • "deleteMatchResults": true
}

SetupFeatures

Retrieves current features config.

Responses

Response samples

Content type
application/json
{
  • "faceFeaturesConfig": {
    }
}

Updates the features config with specified values.

Request Body schema:

The new features configuration.

required
object (FeaturesConfigUpdateRequest)

Responses

Request samples

Content type
{
  • "faceFeaturesConfig": {
    }
}

Response samples

Content type
application/json
{
  • "faceFeaturesConfig": {
    }
}

SetupPreview

Retrieves current preview config.

Responses

Response samples

Content type
application/json
{
  • "faceBoundingBoxColor": "string",
  • "pedestrianBoundingBoxColor": "string",
  • "objectBoundingBoxColor": "string"
}

Updates the preview config with specified values.

Default value for FaceBoundingBoxColor is #ecec5e

Default value for PedestrianBoundingBoxColor is #80b5ff

Default value for ObjectBoundingBoxColor is #e638d3

Request Body schema:

The new preview configuration.

faceBoundingBoxColor
required
string
pedestrianBoundingBoxColor
required
string
objectBoundingBoxColor
string or null

Responses

Request samples

Content type
{
  • "faceBoundingBoxColor": "string",
  • "pedestrianBoundingBoxColor": "string",
  • "objectBoundingBoxColor": "string"
}

Response samples

Content type
application/json
{
  • "faceBoundingBoxColor": "string",
  • "pedestrianBoundingBoxColor": "string",
  • "objectBoundingBoxColor": "string"
}

SetupSearchSessionsCleanup

Retrieves current search sessions cleanup config.

Responses

Response samples

Content type
application/json
{
  • "enabled": true,
  • "maxItemsCount": 0,
  • "maxSessionAge": "string",
  • "interval": "string"
}

Updates the search sessions cleanup config with specified values.

Request Body schema:

The new search sessions cleanup configuration.

enabled
required
boolean
maxItemsCount
required
integer or null <int32>
maxSessionAge
required
string or null <date-span>
interval
required
string or null <date-span>

Responses

Request samples

Content type
{
  • "enabled": true,
  • "maxItemsCount": 0,
  • "maxSessionAge": "string",
  • "interval": "string"
}

Response samples

Content type
application/json
{
  • "enabled": true,
  • "maxItemsCount": 0,
  • "maxSessionAge": "string",
  • "interval": "string"
}

SetupWatchlistAutoLearn

Retrieves the current watchlist autolearn config.

Responses

Response samples

Content type
application/json
{
  • "enabled": true,
  • "executionStartTime": "string",
  • "maxAutoLearnFacesCount": 0,
  • "selectionThreshold": 0,
  • "maskedSelectionThreshold": 0,
  • "noFaceMaskConfidenceThreshold": 0.1,
  • "faceMaskConfidenceThreshold": 0.1
}

Updates the watchlist autolearn config with specified values.

Request Body schema:

The new watchlist autolearn configuration.

enabled
required
boolean
executionStartTime
required
string or null <date-span>
maxAutoLearnFacesCount
required
integer <int32>
selectionThreshold
required
integer <int32>
maskedSelectionThreshold
integer <int32>
noFaceMaskConfidenceThreshold
number <double>
faceMaskConfidenceThreshold
number <double>

Responses

Request samples

Content type
{
  • "enabled": true,
  • "executionStartTime": "string",
  • "maxAutoLearnFacesCount": 0,
  • "selectionThreshold": 0,
  • "maskedSelectionThreshold": 0,
  • "noFaceMaskConfidenceThreshold": 0.1,
  • "faceMaskConfidenceThreshold": 0.1
}

Response samples

Content type
application/json
{
  • "enabled": true,
  • "executionStartTime": "string",
  • "maxAutoLearnFacesCount": 0,
  • "selectionThreshold": 0,
  • "maskedSelectionThreshold": 0,
  • "noFaceMaskConfidenceThreshold": 0.1,
  • "faceMaskConfidenceThreshold": 0.1
}

Tracklet

Retrieves the tracklet by its id.

path Parameters
id
required
string <uuid>

Id of the tracklet.

Responses

Response samples

Content type
application/json
{
  • "timeAppeared": "2019-08-24T14:15:22Z",
  • "timeDisappeared": "2019-08-24T14:15:22Z",
  • "timeAppearedRelativeMs": 0,
  • "timeDisappearedRelativeMs": 0,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Deletes the tracklets by its id.

path Parameters
id
required
string <uuid>

Id of the tracklet to delete.

Responses

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Retrieves tracklets as a paged collection.

Page number, page size and sorting order can be specified. You can also show total items count.

query Parameters
Ascending
boolean
PageNumber
integer <int32> [ 1 .. 2147483647 ]
PageSize
integer <int32> [ 1 .. 2147483647 ]
ShowTotalCount
boolean

Responses

Response samples

Content type
application/json
{
  • "totalItemsCount": 0,
  • "items": [
    ],
  • "pageSize": 0,
  • "pageNumber": 0,
  • "previousPage": "string",
  • "nextPage": "string"
}

Retrieves faces for given tracklet id as a paged collection.

Page number, page size and sorting order can be specified. You can also show total items count.

path Parameters
id
required
string <uuid>

Id of the tracklet.

query Parameters
Ascending
boolean
PageNumber
integer <int32> [ 1 .. 2147483647 ]
PageSize
integer <int32> [ 1 .. 2147483647 ]
ShowTotalCount
boolean

Responses

Response samples

Content type
application/json
{
  • "totalItemsCount": 0,
  • "items": [
    ],
  • "pageSize": 0,
  • "pageNumber": 0,
  • "previousPage": "string",
  • "nextPage": "string"
}

Version

Retrieves the version information.

Responses

Response samples

Content type
application/json
{
  • "databaseVersion": "string",
  • "databaseVersionCreationTime": "2019-08-24T14:15:22Z",
  • "databaseVersionUpdatedTime": "2019-08-24T14:15:22Z",
  • "assemblyVersion": "string",
  • "assemblyLastModifiedTime": "2019-08-24T14:15:22Z",
  • "fullVersion": "string"
}

VideoRecord

Retrieve a video record by its id.

path Parameters
id
required
string <uuid>

Id of the video record.

Responses

Response samples

Content type
application/json
{
  • "state": "Ready",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "source": "string",
  • "recordedAt": "2019-08-24T14:15:22Z",
  • "videoDurationMs": 0,
  • "enabled": true,
  • "faceDetectorConfig": {
    },
  • "faceDetectorResourceId": "string",
  • "templateGeneratorResourceId": "string",
  • "redetectionTime": 0,
  • "templateGenerationTime": 0,
  • "trackMotionOptimization": "string",
  • "faceSaveStrategy": "string",
  • "maskImagePath": "string",
  • "saveFrameImageData": true,
  • "imageQuality": 0,
  • "mpeG1PreviewEnabled": true,
  • "mpeG1PreviewPort": 0,
  • "mpeG1VideoBitrate": 0,
  • "previewMaxDimension": 0,
  • "matchingConfig": {
    },
  • "description": "string",
  • "processingStartTime": "2019-08-24T14:15:22Z",
  • "processingDurationMs": 0
}

Deletes a video record by its id.

path Parameters
id
required
string <uuid>

Id of the video record.

Responses

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Retrieves all video records.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Upserts the specified video record with given values.

Supported values for FaceSaveStrategy are:

FirstFace, BestFace, "FirstFace, BestFace", All, MatchedOnly
Request Body schema:

New video record values.

id
required
string <uuid>
name
required
string
source
required
string
enabled
required
boolean
recordedAt
string <date-time>
required
object (VideoFaceDetectorConfig)
faceDetectorResourceId
string or null
Deprecated
templateGeneratorResourceId
string or null
Deprecated
redetectionTime
required
integer <int32>
templateGenerationTime
required
integer <int32>
trackMotionOptimization
string or null
Deprecated
faceSaveStrategy
string or null
maskImagePath
required
string or null
saveFrameImageData
required
boolean
imageQuality
required
integer <int32>
mpeG1PreviewEnabled
boolean
Deprecated
mpeG1PreviewPort
integer <int32>
Deprecated
mpeG1VideoBitrate
integer <int32>
Deprecated
previewMaxDimension
integer <int32>
Deprecated
object (VideoRecordMatchingConfigUpdateRequest)
description
string or null
Default: null

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "source": "string",
  • "enabled": true,
  • "recordedAt": "2019-08-24T14:15:22Z",
  • "faceDetectorConfig": {
    },
  • "faceDetectorResourceId": "string",
  • "templateGeneratorResourceId": "string",
  • "redetectionTime": 0,
  • "templateGenerationTime": 0,
  • "trackMotionOptimization": "string",
  • "faceSaveStrategy": "string",
  • "maskImagePath": "string",
  • "saveFrameImageData": true,
  • "imageQuality": 0,
  • "mpeG1PreviewEnabled": true,
  • "mpeG1PreviewPort": 0,
  • "mpeG1VideoBitrate": 0,
  • "previewMaxDimension": 0,
  • "matchingConfig": {
    },
  • "description": null
}

Response samples

Content type
application/json
{
  • "state": "Ready",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "source": "string",
  • "recordedAt": "2019-08-24T14:15:22Z",
  • "videoDurationMs": 0,
  • "enabled": true,
  • "faceDetectorConfig": {
    },
  • "faceDetectorResourceId": "string",
  • "templateGeneratorResourceId": "string",
  • "redetectionTime": 0,
  • "templateGenerationTime": 0,
  • "trackMotionOptimization": "string",
  • "faceSaveStrategy": "string",
  • "maskImagePath": "string",
  • "saveFrameImageData": true,
  • "imageQuality": 0,
  • "mpeG1PreviewEnabled": true,
  • "mpeG1PreviewPort": 0,
  • "mpeG1VideoBitrate": 0,
  • "previewMaxDimension": 0,
  • "matchingConfig": {
    },
  • "description": "string",
  • "processingStartTime": "2019-08-24T14:15:22Z",
  • "processingDurationMs": 0
}

Creates a video record.

Supported values for FaceSaveStrategy are:

FirstFace, BestFace, "FirstFace, BestFace", All, MatchedOnly
Request Body schema:

Request specifying video record properties.

name
required
string
source
required
string
enabled
boolean or null
recordedAt
string or null <date-time>
object (FaceDetectorConfigCreateRequest)
faceDetectorResourceId
string or null
Deprecated
templateGeneratorResourceId
string or null
Deprecated
redetectionTime
integer or null <int32>
templateGenerationTime
integer or null <int32>
trackMotionOptimization
string or null
Deprecated
faceSaveStrategy
string or null
maskImagePath
string or null
saveFrameImageData
boolean or null
imageQuality
integer or null <int32>
mpeG1PreviewEnabled
boolean or null
Deprecated
mpeG1PreviewPort
integer or null <int32>
Deprecated
mpeG1VideoBitrate
integer or null <int32>
Deprecated
previewMaxDimension
integer or null <int32>
Deprecated
object (VideoRecordMatchingConfigCreateRequest)
description
string or null
Default: null

Responses

Request samples

Content type
{
  • "name": "string",
  • "source": "string",
  • "enabled": true,
  • "recordedAt": "2019-08-24T14:15:22Z",
  • "faceDetectorConfig": {
    },
  • "faceDetectorResourceId": "string",
  • "templateGeneratorResourceId": "string",
  • "redetectionTime": 0,
  • "templateGenerationTime": 0,
  • "trackMotionOptimization": "string",
  • "faceSaveStrategy": "string",
  • "maskImagePath": "string",
  • "saveFrameImageData": true,
  • "imageQuality": 0,
  • "mpeG1PreviewEnabled": true,
  • "mpeG1PreviewPort": 0,
  • "mpeG1VideoBitrate": 0,
  • "previewMaxDimension": 0,
  • "matchingConfig": {
    },
  • "description": null
}

Response samples

Content type
application/json
{
  • "state": "Ready",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "source": "string",
  • "recordedAt": "2019-08-24T14:15:22Z",
  • "videoDurationMs": 0,
  • "enabled": true,
  • "faceDetectorConfig": {
    },
  • "faceDetectorResourceId": "string",
  • "templateGeneratorResourceId": "string",
  • "redetectionTime": 0,
  • "templateGenerationTime": 0,
  • "trackMotionOptimization": "string",
  • "faceSaveStrategy": "string",
  • "maskImagePath": "string",
  • "saveFrameImageData": true,
  • "imageQuality": 0,
  • "mpeG1PreviewEnabled": true,
  • "mpeG1PreviewPort": 0,
  • "mpeG1VideoBitrate": 0,
  • "previewMaxDimension": 0,
  • "matchingConfig": {
    },
  • "description": "string",
  • "processingStartTime": "2019-08-24T14:15:22Z",
  • "processingDurationMs": 0
}

Retrieves tracklets belonging to a video record with the given id.

Page number, page size and sorting order can be specified. You can also show total items count.

path Parameters
id
required
string <uuid>

Id of the video record.

query Parameters
Ascending
boolean
PageNumber
integer <int32> [ 1 .. 2147483647 ]
PageSize
integer <int32> [ 1 .. 2147483647 ]
ShowTotalCount
boolean

Responses

Response samples

Content type
application/json
{
  • "totalItemsCount": 0,
  • "items": [
    ],
  • "pageSize": 0,
  • "pageNumber": 0,
  • "previousPage": "string",
  • "nextPage": "string"
}

Retrieves the frames belonging to video record with the given id.

Page number, page size and sorting order can be specified. You can also show total items count.

path Parameters
id
required
string <uuid>

Id of the video record.

query Parameters
Ascending
boolean
PageNumber
integer <int32> [ 1 .. 2147483647 ]
PageSize
integer <int32> [ 1 .. 2147483647 ]
ShowTotalCount
boolean

Responses

Response samples

Content type
application/json
{
  • "totalItemsCount": 0,
  • "items": [
    ],
  • "pageSize": 0,
  • "pageNumber": 0,
  • "previousPage": "string",
  • "nextPage": "string"
}

Clears the data produced by the video record (faces, tracklet, matches...) and set the state back to `Ready`

path Parameters
id
required
string <uuid>

Id of the video record.

Responses

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Updates the tags of specified video record

path Parameters
id
required
string <uuid>

Id of the video record.

Request Body schema:

New tags for video record

tags
required
Array of strings

Responses

Request samples

Content type
{
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tags": [
    ]
}

Retrieves the tags of specified video record

path Parameters
id
required
string <uuid>

Id of the video record.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tags": [
    ]
}

Watchlist

Retrieves the watchlists as a paged collection.

Page number, page size and sorting order can be specified. You can also show total items count.

query Parameters
Ascending
boolean
PageNumber
integer <int32> [ 1 .. 2147483647 ]
PageSize
integer <int32> [ 1 .. 2147483647 ]
ShowTotalCount
boolean

Responses

Response samples

Content type
application/json
{
  • "totalItemsCount": 0,
  • "items": [
    ],
  • "pageSize": 0,
  • "pageNumber": 0,
  • "previousPage": "string",
  • "nextPage": "string"
}

Creates a new watchlist.

When setting PreviewColor, hexadecimal format is necessary to use, e.g. #012abc or #01a.

Request Body schema:

Request containing watchlist name and threshold.

displayName
required
string [ 0 .. 200 ] characters
fullName
required
string [ 0 .. 200 ] characters
threshold
integer <int32> [ 0 .. 100 ]
palmThreshold
integer or null <int32> [ 0 .. 100 ]
previewColor
string or null

Responses

Request samples

Content type
{
  • "displayName": "string",
  • "fullName": "string",
  • "threshold": 100,
  • "palmThreshold": 100,
  • "previewColor": "string"
}

Response samples

Content type
application/json
{
  • "displayName": "string",
  • "fullName": "string",
  • "threshold": 0,
  • "palmThreshold": 0,
  • "previewColor": "string",
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Upserts the watchlist.

If the watchlist with specified Id does not exist, it creates it with the requested Id. If the watchlist with specified Id exists, it updates it.
When setting PreviewColor, hexadecimal format is necessary to use, e.g. #012abc or #01a.

Request Body schema:

Request containing watchlist properties.

id
required
string
displayName
required
string [ 0 .. 200 ] characters
fullName
required
string [ 0 .. 200 ] characters
threshold
integer <int32> [ 0 .. 100 ]
palmThreshold
integer or null <int32> [ 0 .. 100 ]
previewColor
string or null

Responses

Request samples

Content type
{
  • "id": "string",
  • "displayName": "string",
  • "fullName": "string",
  • "threshold": 100,
  • "palmThreshold": 100,
  • "previewColor": "string"
}

Response samples

Content type
application/json
{
  • "displayName": "string",
  • "fullName": "string",
  • "threshold": 0,
  • "palmThreshold": 0,
  • "previewColor": "string",
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Retrieves the watchlist by its id.

path Parameters
id
required
string

Id of the watchlist.

Responses

Response samples

Content type
application/json
{
  • "displayName": "string",
  • "fullName": "string",
  • "threshold": 0,
  • "palmThreshold": 0,
  • "previewColor": "string",
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Deletes a watchlist by its id.

path Parameters
id
required
string

Id of the watchlist.

Responses

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Retrieves the watchlist members belonging to a watchlist with specified watchlist id as a paged collection.

Page number, page size and sorting order can be specified. You can also show total items count.

path Parameters
id
required
string

Id of the watchlist.

query Parameters
Ascending
boolean
PageNumber
integer <int32> [ 1 .. 2147483647 ]
PageSize
integer <int32> [ 1 .. 2147483647 ]
ShowTotalCount
boolean

Responses

Response samples

Content type
application/json
{
  • "totalItemsCount": 0,
  • "items": [
    ],
  • "pageSize": 0,
  • "pageNumber": 0,
  • "previousPage": "string",
  • "nextPage": "string"
}

Searches for matching watchlist members by provided image of face/s.

Supported values for FaceDetectorResourceId are:

cpu, gpu, any, accurate_cpu, accurate_gpu, accurate_any

Supported values for TemplateGeneratorResourceId are:

cpu, gpu, any

Supported values for SpoofDetectorResourceId are:

none,
liveness_distant_any_remote, liveness_distant_cpu_remote, liveness_distant_gpu_remote
liveness_nearby_any_remote, liveness_nearby_cpu_remote, liveness_nearby_gpu_remote
Request Body schema:

Request containing searching image and ids of watchlists to be searched.

required
object (ImageData)
watchlistIds
Array of strings or null
Default: ["sample_watchlist_id"]
threshold
integer <int32>
Default: 40
maxResultCount
integer <int32>
Default: 1
object (FaceDetectorConfig)
faceDetectorResourceId
string
Default: "cpu"
templateGeneratorResourceId
string
Default: "cpu"
object (FaceMaskConfidenceRequest)
object (WatchlistSearchFaceFeaturesRequestConfig)
spoofDetectorResourceIds
Array of strings
Default: ["none"]
object (WatchlistSpoofCheckConfig)
faceValidationMode
string or null
Default: "none"

Responses

Request samples

Content type
{
  • "image": {
    },
  • "watchlistIds": [
    ],
  • "threshold": 40,
  • "maxResultCount": 1,
  • "faceDetectorConfig": {
    },
  • "faceDetectorResourceId": "cpu",
  • "templateGeneratorResourceId": "cpu",
  • "faceMaskConfidenceRequest": {
    },
  • "faceFeaturesConfig": {
    },
  • "spoofDetectorResourceIds": [
    ],
  • "spoofCheckConfig": {
    },
  • "faceValidationMode": "none"
}

Response samples

Content type
application/json
[
  • {
    }
]

Searches for matching watchlist members by provided face template/s.

Request Body schema:

Request containing face template and ids of watchlists to be searched.

template
required
string <byte>
watchlistIds
Array of strings or null
Default: ["sample_watchlist_id"]
threshold
integer <int32>
Default: 40
maxResultCount
integer <int32>
Default: 1

Responses

Request samples

Content type
{
  • "template": "string",
  • "watchlistIds": [
    ],
  • "threshold": 40,
  • "maxResultCount": 1
}

Response samples

Content type
application/json
{
  • "matchResults": [
    ]
}

Searches for matching watchlist members by provided image of palm/s.

Supported values for PalmDetectorResourceId are:

cpu
Request Body schema:

Request containing searching image and ids of watchlists to be searched.

required
object (ImageData)
watchlistIds
Array of strings or null
Default: ["sample_watchlist_id"]
threshold
integer <int32>
Default: 75
maxResultCount
integer <int32>
Default: 1
object (PalmDetectorConfig)
palmDetectorResourceId
string
Default: "cpu"

Responses

Request samples

Content type
{
  • "image": {
    },
  • "watchlistIds": [
    ],
  • "threshold": 75,
  • "maxResultCount": 1,
  • "palmDetectorConfig": {
    },
  • "palmDetectorResourceId": "cpu"
}

Response samples

Content type
application/json
[
  • {
    }
]

Searches for matching watchlist members by provided palm template/s.

Request Body schema:

Request containing palm template and ids of watchlists to be searched.

template
required
string <byte>
watchlistIds
Array of strings or null
Default: ["sample_watchlist_id"]
threshold
integer <int32>
Default: 75
maxResultCount
integer <int32>
Default: 1

Responses

Request samples

Content type
{
  • "template": "string",
  • "watchlistIds": [
    ],
  • "threshold": 75,
  • "maxResultCount": 1
}

Response samples

Content type
application/json
{
  • "matchResults": [
    ]
}

WatchlistMember

Retrieves the watchlist members as a paged collection.

Page number, page size and sorting order can be specified. You can also show total items count.

query Parameters
Ascending
boolean
PageNumber
integer <int32> [ 1 .. 2147483647 ]
PageSize
integer <int32> [ 1 .. 2147483647 ]
ShowTotalCount
boolean

Responses

Response samples

Content type
application/json
{
  • "totalItemsCount": 0,
  • "items": [
    ],
  • "pageSize": 0,
  • "pageNumber": 0,
  • "previousPage": "string",
  • "nextPage": "string"
}

Creates a new watchlist member.

Request Body schema:

Request specifying watchlist member properties.

displayName
string or null [ 0 .. 200 ] characters
fullName
string or null [ 0 .. 200 ] characters
note
string or null
Array of objects or null (Label)

Responses

Request samples

Content type
{
  • "displayName": "string",
  • "fullName": "string",
  • "note": "string",
  • "labels": [
    ]
}

Response samples

Content type
application/json
{
  • "displayName": "string",
  • "fullName": "string",
  • "note": "string",
  • "labels": [
    ],
  • "totpEnabled": true,
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Upserts the watchlist member.

If the watchlist member with specified Id does not exist, it creates it with the requested Id. If the watchlist member with specified Id exists, it updates it.

Request Body schema:

Request specifying which watchlist member should be updated and how to update it.

id
required
string
displayName
string or null [ 0 .. 200 ] characters
fullName
string or null [ 0 .. 200 ] characters
note
string or null
Array of objects or null (Label)

Responses

Request samples

Content type
{
  • "id": "string",
  • "displayName": "string",
  • "fullName": "string",
  • "note": "string",
  • "labels": [
    ]
}

Response samples

Content type
application/json
{
  • "displayName": "string",
  • "fullName": "string",
  • "note": "string",
  • "labels": [
    ],
  • "totpEnabled": true,
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Retrieves the watchlist member by its id.

path Parameters
id
required
string

Id of the watchlist member.

Responses

Response samples

Content type
application/json
{
  • "displayName": "string",
  • "fullName": "string",
  • "note": "string",
  • "labels": [
    ],
  • "totpEnabled": true,
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Deletes a watchlist member by its id.

path Parameters
id
required
string

Id of the watchlist member.

Responses

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Retrieves faces for given watchlist member id as a paged collection.

Page number, page size and sorting order can be specified. You can also show total items count.

path Parameters
id
required
string

Id of the watchlist member.

query Parameters
Ascending
boolean
PageNumber
integer <int32> [ 1 .. 2147483647 ]
PageSize
integer <int32> [ 1 .. 2147483647 ]
ShowTotalCount
boolean

Responses

Response samples

Content type
application/json
{
  • "totalItemsCount": 0,
  • "items": [
    ],
  • "pageSize": 0,
  • "pageNumber": 0,
  • "previousPage": "string",
  • "nextPage": "string"
}

Retrieves palms for given watchlist member id as a paged collection.

Page number, page size and sorting order can be specified. You can also show total items count.

path Parameters
id
required
string

Id of the watchlist member.

query Parameters
Ascending
boolean
PageNumber
integer <int32> [ 1 .. 2147483647 ]
PageSize
integer <int32> [ 1 .. 2147483647 ]
ShowTotalCount
boolean

Responses

Response samples

Content type
application/json
{
  • "totalItemsCount": 0,
  • "items": [
    ],
  • "pageSize": 0,
  • "pageNumber": 0,
  • "previousPage": "string",
  • "nextPage": "string"
}

Links specified watchlist members to a given watchlist.

Request Body schema:

Request specifying watchlist member ids and watchlist id

watchlistId
required
string
watchlistMembersIds
required
Array of strings non-empty

Responses

Request samples

Content type
{
  • "watchlistId": "string",
  • "watchlistMembersIds": [
    ]
}

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Unlinks specified watchlist members for a given watchlist.

Request Body schema:

Request specifying watchlist member ids and watchlist id

watchlistId
required
string
watchlistMembersIds
required
Array of strings non-empty

Responses

Request samples

Content type
{
  • "watchlistId": "string",
  • "watchlistMembersIds": [
    ]
}

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Registers a watchlist member.

Supported values for FaceDetectorResourceId are:

cpu, gpu, any, accurate_cpu, accurate_gpu, accurate_any

Supported values for TemplateGeneratorResourceId are:

cpu, gpu, any

Supported values for PalmDetectorResourceId are:

cpu
Request Body schema:

Request specifying watchlist member register details.

id
required
string
Default: ""
required
Array of objects (RegistrationImageData) non-empty
watchlistIds
required
Array of strings non-empty
Default: ["sample_watchlist_id"]
object (FaceDetectorConfig)
faceDetectorResourceId
string or null
Default: "cpu"
templateGeneratorResourceId
string or null
Default: "cpu"
keepAutoLearnPhotos
boolean
Default: false
displayName
string or null
fullName
string or null
note
string or null
Array of objects or null (Label)
Default: null
faceValidationMode
string or null
Default: "predefined"
palmDetectorResourceId
string or null
Default: "cpu"
object (PalmDetectorConfig)

Responses

Request samples

Content type
{
  • "id": "",
  • "images": [
    ],
  • "watchlistIds": [
    ],
  • "faceDetectorConfig": {
    },
  • "faceDetectorResourceId": "cpu",
  • "templateGeneratorResourceId": "cpu",
  • "keepAutoLearnPhotos": false,
  • "displayName": "string",
  • "fullName": "string",
  • "note": "string",
  • "labels": null,
  • "faceValidationMode": "predefined",
  • "palmDetectorResourceId": "cpu",
  • "palmDetectorConfig": {
    }
}

Response samples

Content type
application/json
{
  • "watchlists": [
    ],
  • "faces": [
    ],
  • "palms": [
    ],
  • "displayName": "string",
  • "fullName": "string",
  • "note": "string",
  • "labels": [
    ],
  • "totpEnabled": true,
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Adds a specified face to a given watchlist member.

path Parameters
id
required
string

The watchlist member id.

Request Body schema:

Request specifying face id to add.

faceId
required
string <uuid>
faceValidationMode
required
string
Default: "predefined"

Responses

Request samples

Content type
{
  • "faceId": "b12fe1ff-6e7b-48d0-b0e3-b407b5f728e2",
  • "faceValidationMode": "predefined"
}

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Adds a specified face to a given watchlist member.

Supported values for FaceDetectorResourceId are:

cpu, gpu, any, accurate_cpu, accurate_gpu, accurate_any

Supported values for TemplateGeneratorResourceId are:

cpu, gpu, any
path Parameters
id
required
string

The watchlist member id.

Request Body schema:

The image with face to add with configuration.

required
object (FaceRegistrationImageData)
object (FaceDetectorConfig)
faceDetectorResourceId
string
templateGeneratorResourceId
string
faceValidationMode
string or null
Default: "predefined"

Responses

Request samples

Content type
{
  • "imageData": {
    },
  • "faceDetectorConfig": {
    },
  • "faceDetectorResourceId": "string",
  • "templateGeneratorResourceId": "string",
  • "faceValidationMode": "predefined"
}

Response samples

Content type
application/json
{
  • "trackletId": "18b0bea4-b937-4751-a328-bee6bf88d141",
  • "quality": 0,
  • "templateQuality": 0,
  • "state": "New",
  • "imageDataId": "b24530bd-cd48-48ab-ad8c-8f8a9678282e",
  • "processedAt": "2019-08-24T14:15:22Z",
  • "cropLeftTopX": 0.1,
  • "cropLeftTopY": 0.1,
  • "cropRightTopX": 0.1,
  • "cropRightTopY": 0.1,
  • "cropLeftBottomX": 0.1,
  • "cropLeftBottomY": 0.1,
  • "cropRightBottomX": 0.1,
  • "cropRightBottomY": 0.1,
  • "leftEyeX": 0.1,
  • "leftEyeY": 0.1,
  • "rightEyeX": 0.1,
  • "rightEyeY": 0.1,
  • "frameId": "64f96310-c601-4761-a13a-8f7335bbd0b0",
  • "type": "Regular",
  • "age": 0.1,
  • "gender": 0.1,
  • "faceMaskConfidence": 0.1,
  • "noseTipConfidence": 0.1,
  • "faceMaskStatus": "Unknown",
  • "faceArea": 0.1,
  • "size": 0.1,
  • "faceOrder": 0,
  • "facesOnFrameCount": 0,
  • "faceAreaChange": 0.1,
  • "yawAngle": 0.1,
  • "pitchAngle": 0.1,
  • "rollAngle": 0.1,
  • "autolearnClusterType": "string",
  • "sharpness": 0.1,
  • "brightness": 0.1,
  • "tintedGlasses": 0.1,
  • "heavyFrame": 0.1,
  • "glassStatus": 0.1,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Adds a specified palm to a given watchlist member.

Supported values for PalmDetectorResourceId are:

cpu
path Parameters
id
required
string

The watchlist member id.

Request Body schema:

The image with palm to add with configuration.

required
object (PalmRegistrationImageData)
object (PalmDetectorConfig)
palmDetectorResourceId
string

Responses

Request samples

Content type
{
  • "imageData": {
    },
  • "palmDetectorConfig": {
    },
  • "palmDetectorResourceId": "string"
}

Response samples

Content type
application/json
{
  • "trackletId": "18b0bea4-b937-4751-a328-bee6bf88d141",
  • "quality": 0,
  • "imageDataId": "b24530bd-cd48-48ab-ad8c-8f8a9678282e",
  • "frameId": "64f96310-c601-4761-a13a-8f7335bbd0b0",
  • "processedAt": "2019-08-24T14:15:22Z",
  • "cropLeftTopX": 0.1,
  • "cropLeftTopY": 0.1,
  • "cropRightTopX": 0.1,
  • "cropRightTopY": 0.1,
  • "cropLeftBottomX": 0.1,
  • "cropLeftBottomY": 0.1,
  • "cropRightBottomX": 0.1,
  • "cropRightBottomY": 0.1,
  • "size": 0.1,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Adds a specified palm to a given watchlist member.

path Parameters
id
required
string

The watchlist member id.

Request Body schema:

Request specifying palm id to add.

palmId
required
string <uuid>

Responses

Request samples

Content type
{
  • "palmId": "6cec923b-c6bd-4484-a14c-0abdac7abec3"
}

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Removes a face from a watchlist member.

path Parameters
id
required
string

The watchlist member id.

Request Body schema:

Request specifying face id to remove.

faceId
required
string <uuid>

Responses

Request samples

Content type
{
  • "faceId": "b12fe1ff-6e7b-48d0-b0e3-b407b5f728e2"
}

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Removes a palm from a watchlist member.

path Parameters
id
required
string

The watchlist member id.

Request Body schema:

Request specifying palm id to remove.

palmId
required
string <uuid>

Responses

Request samples

Content type
{
  • "palmId": "6cec923b-c6bd-4484-a14c-0abdac7abec3"
}

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Creates a new TOTP secret for the watchlist member.

path Parameters
id
required
string

The watchlist member id.

Responses

Response samples

Content type
application/json
{
  • "secret": "string",
  • "digits": 0,
  • "period": 0,
  • "algorithm": "string",
  • "watchlistMemberIdentifier": "string",
  • "issuer": "string"
}