SubjectsApi

All URIs are relative to http://localhost

Method	HTTP request	Description
clearDb	DELETE /admin/subjects/clear-db	Clear all DB or by prefix depending on the use case.
createSubject	POST /admin/subjects/create	Create new subject and insert it to the database
createSubjectFromScannerImages	POST /admin/subjects/create-from-fingers-scanner-images	Create new subject and insert it to the database
deleteSubject	DELETE /admin/subjects/id/	Delete subject, operation and biometric data by subject id
deleteSubjects	DELETE /admin/subjects	Delete subjects from the database by subject ids
deleteSubjectsByUUID	DELETE /admin/subjects/delete	Deletes subjects with operation UUID
downloadSubjectsInfoBulk	GET /admin/subjects/download	Download specified subject's data from the specified subjects' id list
getMultimodalSubjectById	GET /admin/subjects/multimodal/id/{id}	Get subject's information by id
getMultimodalSubjectByOperationId	GET /admin/subjects/multimodal/operation/{uuid}	Get subject information by UUID
getMultimodalSubjectBySubjectId	GET /admin/subjects/multimodal/{subjectId}	Get subject's information by subject id
getMultimodalSubjects	GET /admin/subjects/multimodal	Get subjects by custom filter
getSubjectById	GET /admin/subjects/id/{id}	Get subject's information by id
getSubjectByOperationId	GET /admin/subjects/operation/{uuid}	Get subject information by UUID
getSubjectBySubjectId	GET /admin/subjects/{subjectId}	Get subject's information by subject id
getSubjects	GET /admin/subjects	Get subjects by custom filter
getSubjectsCount	GET /admin/subjects/count	Count subjects by filter
getSubjectsEnrolledModalities	GET /admin/subjects/modality/types	Modalities to which the subject has already been enrolled
getSubjectsIdList	GET /admin/subjects/id-list	Get subjects' id list
getSubjectsQRCodeBySubjectId	GET /admin/subjects/qrcode/{subjectid}	QR code of the MegaMatcherId template
getTemplateModalities	POST /admin/subjects/qrcode/modalities	Returns modality types in the the template
reextractSubject	POST /admin/subjects/reextract-subject	Allows to reextract the template to the current version for the best accuracy

clearDb

clearDb(prefix)

Clear all DB or by prefix depending on the use case.

Parameters

Name	Type	Description	Notes
prefix	String	Subject prefix	[optional] [default to null]

Return type

null (empty response body)

Authorization

admin-basic, admin-oauth

HTTP request headers

• Content-Type: Not defined
• Accept: /

createSubject

MultimodalSubject createSubject(CreateSubjectRequest)

Create new subject and insert it to the database

Parameters

Name	Type	Description	Notes
CreateSubjectRequest	CreateSubjectRequest

Return type

MultimodalSubject

Authorization

admin-basic, admin-oauth

HTTP request headers

• Content-Type: application/json
• Accept: application/json, /

createSubjectFromScannerImages

MultimodalSubject createSubjectFromScannerImages(CreateSubjectFromScannerImagesRequest)

Create new subject and insert it to the database

Parameters

Name	Type	Description	Notes
CreateSubjectFromScannerImagesRequest	CreateSubjectFromScannerImagesRequest

Return type

MultimodalSubject

Authorization

admin-basic, admin-oauth

HTTP request headers

• Content-Type: application/json
• Accept: application/json, /

deleteSubject

deleteSubject(id)

Delete subject, operation and biometric data by subject id

Parameters

Name	Type	Description	Notes
id	Integer	ID of subject (from the DB) to be deleted	[default to null]

Return type

null (empty response body)

Authorization

admin-basic, admin-oauth

HTTP request headers

• Content-Type: Not defined
• Accept: /

deleteSubjects

deleteSubjects(subjectIds)

Delete subjects from the database by subject ids

Parameters

Name	Type	Description	Notes
subjectIds	List	List of subjects id's (from the DB) to be deleted	[default to null]

Return type

null (empty response body)

Authorization

admin-basic, admin-oauth

HTTP request headers

• Content-Type: Not defined
• Accept: /

deleteSubjectsByUUID

Integer deleteSubjectsByUUID(uuids)

Deletes subjects with operation UUID

Parameters

Name	Type	Description	Notes
uuids	List	List of subject UUIDs to be deleted	[default to null]

Return type

Integer

Authorization

admin-basic, admin-oauth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, /

downloadSubjectsInfoBulk

Object downloadSubjectsInfoBulk(subjectsIds, downloadOptions)

Download specified subject's data from the specified subjects' id list

Parameters

Name	Type	Description	Notes
subjectsIds	List	List of subjects id's to be downloaded	[default to null]
downloadOptions	List	Set of subject's data to be downloaded	[default to null] [enum: IMAGE, TOKEN_IMAGE, TEMPLATE]

Return type

Object

Authorization

admin-basic, admin-oauth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/octet-stream, /

getMultimodalSubjectById

MultimodalSubject getMultimodalSubjectById(id)

Get subject'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

MultimodalSubject

Authorization

admin-basic, admin-oauth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, /

getMultimodalSubjectByOperationId

MultimodalSubject getMultimodalSubjectByOperationId(uuid)

Get subject information by UUID

Parameters

Name	Type	Description	Notes
uuid	String	UUID of subject's operation	[default to null]

Return type

MultimodalSubject

Authorization

admin-basic, admin-oauth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, /

getMultimodalSubjectBySubjectId

MultimodalSubject getMultimodalSubjectBySubjectId(subjectId)

Get subject's information by subject id

Parameters

Name	Type	Description	Notes
subjectId	String	Subject id to search with	[default to null]

Return type

MultimodalSubject

Authorization

admin-basic, admin-oauth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, /

getMultimodalSubjects

List getMultimodalSubjects(page, size, subjectId, subjectsFieldToOrderBy, fieldsOrder, operationTypes, statuses, livenessModes, icaoWarnings, uuid, dateLowerBound, dateUpperBound, yawLowerBound, yawUpperBound, rollLowerBound, rollUpperBound, pitchLowerBound, pitchUpperBound, livenessScoreLowerBound, livenessScoreUpperBound, qualityLowerBound, qualityUpperBound, ageLowerBound, ageUpperBound, matchingScoreLower, matchingScoreUpper, modalities)

Get subjects by custom filter

Parameters

Name	Type	Description	Notes
page	Integer	Page number	[optional] [default to 1]
size	Integer	Page size	[optional] [default to 20]
subjectId	String	Subject id specified in the enrollment operation	[optional] [default to null]
subjectsFieldToOrderBy	String	Subject's field ordered by	[optional] [default to SUBJECT_ID] [enum: SUBJECT_ID, SUBJECT_OPERATION_TYPE, SUBJECT_STATUS, SUBJECT_LIVENESS_MODE, SUBJECT_DATE, SUBJECT_UUID, SUBJECT_ICAO_WARNING, SUBJECT_YAW, SUBJECT_ROLL, SUBJECT_PITCH, SUBJECT_LIVENESS_SCORE, SUBJECT_QUALITY, SUBJECT_AGE, SUBJECT_MODALITY, SUBJECT_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, FINGERS_NOT_FOUND, STATUS_TOO_NORTH, STATUS_TOO_EAST, STATUS_TOO_SOUTH, STATUS_TOO_WEST, MICROPHONE_NOT_FOUND, INITIALIZED, JANUS_UNKNOWN_ERROR, JANUS_PLUGIN_ERROR, JANUS_NOT_FOUND, JANUS_BAD_REQUEST, JANUS_ICE_FAILED, ADJUDICATION_PENDING, AGE_CHECK_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	Subject's verification's matching score (lowerBound)	[optional] [default to null]
matchingScoreUpper	Integer	Subject's verification's matching score (upperBound)	[optional] [default to null]
modalities	List	subject's modality	[optional] [default to null] [enum: FACE_MODALITY, VOICE_MODALITY, FINGERS_MODALITY, UNRECOGNIZED]

Return type

List

Authorization

admin-basic, admin-oauth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, /

getSubjectById

Subject getSubjectById(id)

Get subject'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

Subject

Authorization

admin-basic, admin-oauth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, /

getSubjectByOperationId

Subject getSubjectByOperationId(uuid)

Get subject information by UUID

Parameters

Name	Type	Description	Notes
uuid	String	UUID with which subject was created	[default to null]

Return type

Subject

Authorization

admin-basic, admin-oauth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, /

getSubjectBySubjectId

Subject getSubjectBySubjectId(subjectId)

Get subject's information by subject id

Parameters

Name	Type	Description	Notes
subjectId	String	Subject id to search with	[default to null]

Return type

Subject

Authorization

admin-basic, admin-oauth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, /

getSubjects

List getSubjects(page, size, subjectId, subjectsFieldToOrderBy, fieldsOrder, operationTypes, statuses, livenessModes, icaoWarnings, uuid, dateLowerBound, dateUpperBound, yawLowerBound, yawUpperBound, rollLowerBound, rollUpperBound, pitchLowerBound, pitchUpperBound, livenessScoreLowerBound, livenessScoreUpperBound, qualityLowerBound, qualityUpperBound, ageLowerBound, ageUpperBound, matchingScoreLower, matchingScoreUpper, modalities)

Get subjects by custom filter

Parameters

Name	Type	Description	Notes
page	Integer	Page number	[optional] [default to 1]
size	Integer	Page size	[optional] [default to 20]
subjectId	String	Subject id specified in the enrollment operation	[optional] [default to null]
subjectsFieldToOrderBy	String	Subject's field ordered by	[optional] [default to SUBJECT_ID] [enum: SUBJECT_ID, SUBJECT_OPERATION_TYPE, SUBJECT_STATUS, SUBJECT_LIVENESS_MODE, SUBJECT_DATE, SUBJECT_UUID, SUBJECT_ICAO_WARNING, SUBJECT_YAW, SUBJECT_ROLL, SUBJECT_PITCH, SUBJECT_LIVENESS_SCORE, SUBJECT_QUALITY, SUBJECT_AGE, SUBJECT_MODALITY, SUBJECT_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, FINGERS_NOT_FOUND, STATUS_TOO_NORTH, STATUS_TOO_EAST, STATUS_TOO_SOUTH, STATUS_TOO_WEST, MICROPHONE_NOT_FOUND, INITIALIZED, JANUS_UNKNOWN_ERROR, JANUS_PLUGIN_ERROR, JANUS_NOT_FOUND, JANUS_BAD_REQUEST, JANUS_ICE_FAILED, ADJUDICATION_PENDING, AGE_CHECK_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	Subject's verification's matching score (lowerBound)	[optional] [default to null]
matchingScoreUpper	Integer	Subject's verification's matching score (upperBound)	[optional] [default to null]
modalities	List	subject's modality	[optional] [default to null] [enum: FACE_MODALITY, VOICE_MODALITY, FINGERS_MODALITY, UNRECOGNIZED]

Return type

List

Authorization

admin-basic, admin-oauth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, /

getSubjectsCount

Integer getSubjectsCount(subjectId, subjectsFieldToOrderBy, fieldsOrder, operationTypes, statuses, livenessModes, icaoWarnings, uuid, dateLowerBound, dateUpperBound, yawLowerBound, yawUpperBound, rollLowerBound, rollUpperBound, pitchLowerBound, pitchUpperBound, livenessScoreLowerBound, livenessScoreUpperBound, qualityLowerBound, qualityUpperBound, ageLowerBound, ageUpperBound, matchingScoreLower, matchingScoreUpper, modalities)

Count subjects by filter

Parameters

Name	Type	Description	Notes
subjectId	String	Subject id specified in the enrollment operation	[optional] [default to null]
subjectsFieldToOrderBy	String	Subject's field ordered by	[optional] [default to SUBJECT_ID] [enum: SUBJECT_ID, SUBJECT_OPERATION_TYPE, SUBJECT_STATUS, SUBJECT_LIVENESS_MODE, SUBJECT_DATE, SUBJECT_UUID, SUBJECT_ICAO_WARNING, SUBJECT_YAW, SUBJECT_ROLL, SUBJECT_PITCH, SUBJECT_LIVENESS_SCORE, SUBJECT_QUALITY, SUBJECT_AGE, SUBJECT_MODALITY, SUBJECT_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, FINGERS_NOT_FOUND, STATUS_TOO_NORTH, STATUS_TOO_EAST, STATUS_TOO_SOUTH, STATUS_TOO_WEST, MICROPHONE_NOT_FOUND, INITIALIZED, JANUS_UNKNOWN_ERROR, JANUS_PLUGIN_ERROR, JANUS_NOT_FOUND, JANUS_BAD_REQUEST, JANUS_ICE_FAILED, ADJUDICATION_PENDING, AGE_CHECK_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	Subject's verification's matching score (lowerBound)	[optional] [default to null]
matchingScoreUpper	Integer	Subject's verification's matching score (upperBound)	[optional] [default to null]
modalities	List	subject's modality	[optional] [default to null] [enum: FACE_MODALITY, VOICE_MODALITY, FINGERS_MODALITY, UNRECOGNIZED]

Return type

Integer

Authorization

admin-basic, admin-oauth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, /

getSubjectsEnrolledModalities

EnrolledModalities getSubjectsEnrolledModalities(subjectId)

Modalities to which the subject has already been enrolled

Parameters

Name	Type	Description	Notes
subjectId	String	Subject's id	[default to null]

Return type

EnrolledModalities

Authorization

admin-basic, admin-oauth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, /

getSubjectsIdList

List getSubjectsIdList(prefix, subjectId, size)

Get subjects' id list

Parameters

Name	Type	Description	Notes
prefix	String	Prefix to filter subject ids with	[optional] [default to null]
subjectId	String	Subject id to filter subject ids with	[optional] [default to null]
size	Integer	Size of subject list	[optional] [default to 10]

Return type

List

Authorization

admin-basic, admin-oauth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, /

getSubjectsQRCodeBySubjectId

SubjectQRCode getSubjectsQRCodeBySubjectId(subjectid, modalities)

QR code of the MegaMatcherId template

Parameters

Name	Type	Description	Notes
subjectid	String	QR code which to use to verify	[default to null]
modalities	List	Subject's modality	[optional] [default to null] [enum: FACE_MODALITY, VOICE_MODALITY, FINGERS_MODALITY, UNRECOGNIZED]

Return type

SubjectQRCode

Authorization

admin-basic, admin-oauth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, /

getTemplateModalities

TemplateModalities getTemplateModalities(GetTemplateModalitiesRequest)

Returns modality types in the the template

Parameters

Name	Type	Description	Notes
GetTemplateModalitiesRequest	GetTemplateModalitiesRequest

Return type

TemplateModalities

Authorization

admin-basic, admin-oauth

HTTP request headers

• Content-Type: application/json
• Accept: application/json, /

reextractSubject

MultimodalSubject reextractSubject(ReextractSubjectRequest)

Allows to reextract the template to the current version for the best accuracy

Parameters

Name	Type	Description	Notes
ReextractSubjectRequest	ReextractSubjectRequest

Return type

MultimodalSubject

Authorization

admin-basic, admin-oauth

HTTP request headers

• Content-Type: application/json
• Accept: application/json, /