OperationsApi
All URIs are relative to http://localhost
| Method | HTTP request | Description |
|---|---|---|
| checkImage | POST /operations/checkimage | Performs checks on a image |
| createOperation | POST /operations/create | Create new operation and insert it to the database |
| deleteOperation | DELETE /operations/uuid/ | Delete operation from the database by uuid |
| deleteOperations | DELETE /operations | Delete operations from the database by UUIDs' |
| getLog | GET /operations | Get log of operations by custom filter |
| getLogCount | GET /operations/count | Count operations by filter |
| getOperationById | GET /operations/id/ | Get operation's information by id |
| getOperationByUUID | GET /operations/uuid/ | Get operation by UUID |
| remoteVerify | POST /operations/remote-verify | RemoteVerify is used to remotely verify a FVTemplate and an encrypted template created locally using MegaMatcherId SDK |
checkImage
Operation checkImage(ChecksFromImage)
Performs checks on a image
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ChecksFromImage | ChecksFromImage |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json, /
createOperation
Integer createOperation(CreateOperationRequest)
Create new operation and insert it to the database
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| CreateOperationRequest | CreateOperationRequest |
Return type
Integer
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json, /
deleteOperation
deleteOperation(uuid)
Delete operation from the database by uuid
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| uuid | String | Operation's UUID (from the DB) to be deleted | [default to null] |
Return type
null (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
deleteOperations
Integer deleteOperations(uuids)
Delete operations from the database by UUIDs'
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| uuids | List | List of operation uuids' (from the DB) to be deleted | [default to null] |
Return type
Integer
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json, /
getLog
List getLog(page, size, operationsFieldToOrderBy, fieldsOrder, operationTypes, statuses, livenessModes, icaoWarnings, uuid, dateLowerBound, dateUpperBound, yawLowerBound, yawUpperBound, rollLowerBound, rollUpperBound, pitchLowerBound, pitchUpperBound, livenessScoreLowerBound, livenessScoreUpperBound, qualityLowerBound, qualityUpperBound, ageLowerBound, ageUpperBound, matchingScoreLower, matchingScoreUpper, modalities)
Get log of operations by custom filter
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| page | Integer | Page number | [optional] [default to 1] |
| size | Integer | Page size | [optional] [default to 20] |
| operationsFieldToOrderBy | String | Operation's field ordered by | [optional] [default to OPERATION_DATE] [enum: OPERATION_OPERATION_TYPE, OPERATION_STATUS, OPERATION_LIVENESS_MODE, OPERATION_DATE, OPERATION_UUID, OPERATION_ICAO_WARNING, OPERATION_YAW, OPERATION_ROLL, OPERATION_PITCH, OPERATION_LIVENESS_SCORE, OPERATION_QUALITY, OPERATION_AGE, OPERATION_MODALITY, OPERATION_MATCHING_SCORE, UNRECOGNIZED] |
| fieldsOrder | String | Order in which is ordered | [optional] [default to ASC] [enum: ASC, DESC, UNRECOGNIZED] |
| operationTypes | List | Types of operation | [optional] [default to null] [enum: UNSPECIFIED, VERIFY, CHECKS, CREATE_TEMPLATE, REEXTRACT_TEMPLATE, UNRECOGNIZED] |
| statuses | List | Operations' statuses | [optional] [default to null] [enum: NONE, SUCCESS, TIMEOUT, CANCELED, BAD_QUALITY, MATCH_NOT_FOUND, CAMERA_NOT_FOUND, FACE_NOT_FOUND, LIVENESS_CHECK_FAILED, BAD_SHARPNESS, TOO_NOISY, BAD_LIGHTNING, OCCLUSION, BAD_POSE, TOO_MANY_OBJECTS, MASK_DETECTED, DUPLICATE_FOUND, DUPLICATE_ID, MOTION_BLUR, COMPRESSION_ARTIFACTS, TOO_DISTANT, TOO_CLOSE, FAILED, INITIALIZED, JANUS_UNKNOWN_ERROR, JANUS_PLUGIN_ERROR, JANUS_NOT_FOUND, JANUS_BAD_REQUEST, JANUS_ICE_FAILED, RESOLUTION_INSUFFICIENT, CHUNK_RECEIVE_TIMEOUT, STREAM_DECODE_FAILED, ADJUSTING_QUALITY, INTERNAL_ERROR, UNRECOGNIZED] |
| livenessModes | List | Liveness modes used in operation | [optional] [default to null] [enum: DO_NOT_DETECT, PASSIVE, ACTIVE, PASSIVE_AND_ACTIVE, SIMPLE, CUSTOM, PASSIVE_WITH_BLINK, UNRECOGNIZED] |
| icaoWarnings | List | ICAO warnings | [optional] [default to null] [enum: NO_WARNINGS, FACE_NOT_DETECTED, ROLL_LEFT, ROLL_RIGHT, YAW_LEFT, YAW_RIGHT, PITCH_UP, PITCH_DOWN, TOO_NEAR, TOO_FAR, TOO_NORTH, TOO_SOUTH, TOO_EAST, TOO_WEST, SHARPNESS, BACKGROUND_UNIFORMITY, GRAYSCALE_DENSITY, SATURATION, EXPRESSION, DARK_GLASSES, EYES_CLOSED, MOUTH_OPEN, LOOKING_AWAY, RED_EYE, FACE_DARKNESS, UNNATURAL_SKINTONE, WASHED_OUT, PIXELATION, SKIN_REFLECTION, GLASSES_REFLECTION, HEAVY_FRAME, OCCLUSION_WARNING, RESOLUTION_WARNING, MOTION_BLUR_WARNING, COMPRESSION_ARTIFACTS_WARNING, OVEREXPOSURE, UNDEREXPOSURE, GLASSES, HAT, HEAD_MOVEMENT, IMAGE_RESOLUTION, UNRECOGNIZED] |
| uuid | String | Operation's UUID | [optional] [default to ] |
| dateLowerBound | Long | Date range that operation was done in unix time (lowerbound) | [optional] [default to null] |
| dateUpperBound | Long | Date range that operation was done in unix time (upperbound) | [optional] [default to null] |
| yawLowerBound | Double | Image's yaw values (lowerbound) | [optional] [default to -1.0] |
| yawUpperBound | Double | Image's yaw values (upperbound) | [optional] [default to -1.0] |
| rollLowerBound | Double | Image's roll values (lowerbound) | [optional] [default to -1.0] |
| rollUpperBound | Double | Image's roll values (upperbound) | [optional] [default to -1.0] |
| pitchLowerBound | Double | Image's pitch values (lowerbound) | [optional] [default to -1.0] |
| pitchUpperBound | Double | Image's pitch values (upperbound) | [optional] [default to -1.0] |
| livenessScoreLowerBound | Integer | Image's liveness score (lowerBound) | [optional] [default to null] |
| livenessScoreUpperBound | Integer | Image's liveness score (upperBound) | [optional] [default to null] |
| qualityLowerBound | Integer | Image's quality (lowerBound) | [optional] [default to null] |
| qualityUpperBound | Integer | Image's quality (upperBound) | [optional] [default to null] |
| ageLowerBound | Integer | Subject's determined age (lowerBound) | [optional] [default to null] |
| ageUpperBound | Integer | Subject's determined age (upperBound) | [optional] [default to null] |
| matchingScoreLower | Integer | Operation's verification's matching score (lowerBound) | [optional] [default to null] |
| matchingScoreUpper | Integer | Operation's verification's matching score (upperBound) | [optional] [default to null] |
| modalities | List | Operation's modality | [optional] [default to null] [enum: FACE_MODALITY, VOICE_MODALITY, FINGERS_LEFT_HAND_MODALITY, FINGERS_RIGHT_HAND_MODALITY, UNRECOGNIZED] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json, /
getLogCount
Integer getLogCount(operationsFieldToOrderBy, fieldsOrder, operationTypes, statuses, livenessModes, icaoWarnings, uuid, dateLowerBound, dateUpperBound, yawLowerBound, yawUpperBound, rollLowerBound, rollUpperBound, pitchLowerBound, pitchUpperBound, livenessScoreLowerBound, livenessScoreUpperBound, qualityLowerBound, qualityUpperBound, ageLowerBound, ageUpperBound, matchingScoreLower, matchingScoreUpper, modalities)
Count operations by filter
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| operationsFieldToOrderBy | String | Operation's field ordered by | [optional] [default to OPERATION_DATE] [enum: OPERATION_OPERATION_TYPE, OPERATION_STATUS, OPERATION_LIVENESS_MODE, OPERATION_DATE, OPERATION_UUID, OPERATION_ICAO_WARNING, OPERATION_YAW, OPERATION_ROLL, OPERATION_PITCH, OPERATION_LIVENESS_SCORE, OPERATION_QUALITY, OPERATION_AGE, OPERATION_MODALITY, OPERATION_MATCHING_SCORE, UNRECOGNIZED] |
| fieldsOrder | String | Order in which is ordered | [optional] [default to ASC] [enum: ASC, DESC, UNRECOGNIZED] |
| operationTypes | List | Types of operation | [optional] [default to null] [enum: UNSPECIFIED, VERIFY, CHECKS, CREATE_TEMPLATE, REEXTRACT_TEMPLATE, UNRECOGNIZED] |
| statuses | List | Operations' statuses | [optional] [default to null] [enum: NONE, SUCCESS, TIMEOUT, CANCELED, BAD_QUALITY, MATCH_NOT_FOUND, CAMERA_NOT_FOUND, FACE_NOT_FOUND, LIVENESS_CHECK_FAILED, BAD_SHARPNESS, TOO_NOISY, BAD_LIGHTNING, OCCLUSION, BAD_POSE, TOO_MANY_OBJECTS, MASK_DETECTED, DUPLICATE_FOUND, DUPLICATE_ID, MOTION_BLUR, COMPRESSION_ARTIFACTS, TOO_DISTANT, TOO_CLOSE, FAILED, INITIALIZED, JANUS_UNKNOWN_ERROR, JANUS_PLUGIN_ERROR, JANUS_NOT_FOUND, JANUS_BAD_REQUEST, JANUS_ICE_FAILED, RESOLUTION_INSUFFICIENT, CHUNK_RECEIVE_TIMEOUT, STREAM_DECODE_FAILED, ADJUSTING_QUALITY, INTERNAL_ERROR, UNRECOGNIZED] |
| livenessModes | List | Liveness modes used in operation | [optional] [default to null] [enum: DO_NOT_DETECT, PASSIVE, ACTIVE, PASSIVE_AND_ACTIVE, SIMPLE, CUSTOM, PASSIVE_WITH_BLINK, UNRECOGNIZED] |
| icaoWarnings | List | ICAO warnings | [optional] [default to null] [enum: NO_WARNINGS, FACE_NOT_DETECTED, ROLL_LEFT, ROLL_RIGHT, YAW_LEFT, YAW_RIGHT, PITCH_UP, PITCH_DOWN, TOO_NEAR, TOO_FAR, TOO_NORTH, TOO_SOUTH, TOO_EAST, TOO_WEST, SHARPNESS, BACKGROUND_UNIFORMITY, GRAYSCALE_DENSITY, SATURATION, EXPRESSION, DARK_GLASSES, EYES_CLOSED, MOUTH_OPEN, LOOKING_AWAY, RED_EYE, FACE_DARKNESS, UNNATURAL_SKINTONE, WASHED_OUT, PIXELATION, SKIN_REFLECTION, GLASSES_REFLECTION, HEAVY_FRAME, OCCLUSION_WARNING, RESOLUTION_WARNING, MOTION_BLUR_WARNING, COMPRESSION_ARTIFACTS_WARNING, OVEREXPOSURE, UNDEREXPOSURE, GLASSES, HAT, HEAD_MOVEMENT, IMAGE_RESOLUTION, UNRECOGNIZED] |
| uuid | String | Operation's UUID | [optional] [default to ] |
| dateLowerBound | Long | Date range that operation was done in unix time (lowerbound) | [optional] [default to null] |
| dateUpperBound | Long | Date range that operation was done in unix time (upperbound) | [optional] [default to null] |
| yawLowerBound | Double | Image's yaw values (lowerbound) | [optional] [default to -1.0] |
| yawUpperBound | Double | Image's yaw values (upperbound) | [optional] [default to -1.0] |
| rollLowerBound | Double | Image's roll values (lowerbound) | [optional] [default to -1.0] |
| rollUpperBound | Double | Image's roll values (upperbound) | [optional] [default to -1.0] |
| pitchLowerBound | Double | Image's pitch values (lowerbound) | [optional] [default to -1.0] |
| pitchUpperBound | Double | Image's pitch values (upperbound) | [optional] [default to -1.0] |
| livenessScoreLowerBound | Integer | Image's liveness score (lowerBound) | [optional] [default to null] |
| livenessScoreUpperBound | Integer | Image's liveness score (upperBound) | [optional] [default to null] |
| qualityLowerBound | Integer | Image's quality (lowerBound) | [optional] [default to null] |
| qualityUpperBound | Integer | Image's quality (upperBound) | [optional] [default to null] |
| ageLowerBound | Integer | Subject's determined age (lowerBound) | [optional] [default to null] |
| ageUpperBound | Integer | Subject's determined age (upperBound) | [optional] [default to null] |
| matchingScoreLower | Integer | Operation's verification's matching score (lowerBound) | [optional] [default to null] |
| matchingScoreUpper | Integer | Operation's verification's matching score (upperBound) | [optional] [default to null] |
| modalities | List | Operation's modality | [optional] [default to null] [enum: FACE_MODALITY, VOICE_MODALITY, FINGERS_LEFT_HAND_MODALITY, FINGERS_RIGHT_HAND_MODALITY, UNRECOGNIZED] |
Return type
Integer
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json, /
getOperationById
Operation getOperationById(id)
Get operation's information by id
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | Integer | ID to search with. (ID is unique number generated by the DB) | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json, /
getOperationByUUID
Operation getOperationByUUID(uuid)
Get operation by UUID
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| uuid | String | Operation's UUID | [optional] [default to ] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json, /
remoteVerify
byte[] remoteVerify(body, subjectId, uuid, modality)
RemoteVerify is used to remotely verify a FVTemplate and an encrypted template created locally using MegaMatcherId SDK
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | byte[] | ||
| subjectId | String | Subject id to verify with | [optional] [default to null] |
| uuid | String | UUID to verify with | [optional] [default to null] |
| modality | String | Modality of template | [optional] [default to null] [enum: FACE_MODALITY, VOICE_MODALITY, FINGERS_LEFT_HAND_MODALITY, FINGERS_RIGHT_HAND_MODALITY, UNRECOGNIZED] |
Return type
byte[]
Authorization
HTTP request headers
- Content-Type: application/octet-stream
- Accept: application/octet-stream, /