Skip to main content

BiometricDataApi

All URIs are relative to http://localhost

MethodHTTP requestDescription
downloadBiometricDataBulkByOperationGET /admin/biometric-data/operation/downloadDownload specified image's data from the specified operation's ids
downloadBiometricDataBulkBySubjectIdsGET /admin/biometric-data/subjectids/downloadDownload specified biometric face data from the specified subjects ids
downloadBiometricDataBulkByUUIDGET /admin/biometric-data/uuid/downloadDownload specified biometric face data from the specified operation's ids
downloadBiometricDataBySubjectIdGET /admin/biometric-data/subjectid/{subjectId}/downloadDownload specified biometric face data from the specified subject's id
downloadBiometricDataByUUIDGET /admin/biometric-data/uuid/{uuid}/downloadDownload specified biometric face data from the specified operation's id
downloadSubjectsBiometricDataByIdGET /admin/biometric-data/subject/{id}/downloadDownload specified biometric data from the specified subject's id
downloadSubjectsBiometricFaceDataBulkByIdGET /admin/biometric-data/subjects/downloadDownload specified biometric data from the specified subjects ids
getBiometricFaceDataByIdGET /admin/biometric-data/face/id/Get biometric face data's information by image id
getBiometricFaceDataByUUIDGET /admin/biometric-data/face/uuid/Get image's information by UUID
getBiometricFingerDataByUUIDGET /admin/biometric-data/finger/uuid/Get finger's information by UUID
getBiometricVoiceDataByIdGET /admin/biometric-data/voice/id/Get voice's information by id
getBiometricVoiceDataByUUIDGET /admin/biometric-data/voice/uuid/Get voice's information by UUID

downloadBiometricDataBulkByOperation​

Object downloadBiometricDataBulkByOperation(ids, downloadOptions)

Download specified image's data from the specified operation's ids

Parameters​

NameTypeDescriptionNotes
idsListList of operations id's to be downloaded[default to null]
downloadOptionsListSet of data to be downloaded[default to null] [enum: FACE_IMAGE, FACE_TOKEN_IMAGE, FACE_TEMPLATE, VOICE_AUDIO, VOICE_TEMPLATE]

Return type​

Object

Authorization​

admin-basic, admin-oauth

HTTP request headers​

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

downloadBiometricDataBulkBySubjectIds​

Object downloadBiometricDataBulkBySubjectIds(subjectIds, downloadOptions)

Download specified biometric face data from the specified subjects ids

Parameters​

NameTypeDescriptionNotes
subjectIdsListList of subjects id's to be downloaded[default to null]
downloadOptionsListSet of data to be downloaded[default to null] [enum: FACE_IMAGE, FACE_TOKEN_IMAGE, FACE_TEMPLATE, VOICE_AUDIO, VOICE_TEMPLATE]

Return type​

Object

Authorization​

admin-basic, admin-oauth

HTTP request headers​

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

downloadBiometricDataBulkByUUID​

Object downloadBiometricDataBulkByUUID(ids, downloadOptions)

Download specified biometric face data from the specified operation's ids

Parameters​

NameTypeDescriptionNotes
idsListList of operations id's to be downloaded[default to null]
downloadOptionsListSet of data to be downloaded[default to null] [enum: FACE_IMAGE, FACE_TOKEN_IMAGE, FACE_TEMPLATE, VOICE_AUDIO, VOICE_TEMPLATE]

Return type​

Object

Authorization​

admin-basic, admin-oauth

HTTP request headers​

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

downloadBiometricDataBySubjectId​

Object downloadBiometricDataBySubjectId(subjectId, downloadOptions)

Download specified biometric face data from the specified subject's id

Parameters​

NameTypeDescriptionNotes
subjectIdStringSubject's id[default to null]
downloadOptionsListSet of data to be downloaded[default to null] [enum: FACE_IMAGE, FACE_TOKEN_IMAGE, FACE_TEMPLATE, VOICE_AUDIO, VOICE_TEMPLATE]

Return type​

Object

Authorization​

admin-basic, admin-oauth

HTTP request headers​

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

downloadBiometricDataByUUID​

Object downloadBiometricDataByUUID(uuid, downloadOptions)

Download specified biometric face data from the specified operation's id

Parameters​

NameTypeDescriptionNotes
uuidStringOperation's id[default to null]
downloadOptionsListSet of data to be downloaded[default to null] [enum: FACE_IMAGE, FACE_TOKEN_IMAGE, FACE_TEMPLATE, VOICE_AUDIO, VOICE_TEMPLATE]

Return type​

Object

Authorization​

admin-basic, admin-oauth

HTTP request headers​

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

downloadSubjectsBiometricDataById​

Object downloadSubjectsBiometricDataById(id, downloadOptions)

Download specified biometric data from the specified subject's id

Parameters​

NameTypeDescriptionNotes
idIntegerSubject's id[default to null]
downloadOptionsListSet of data to be downloaded[default to null] [enum: FACE_IMAGE, FACE_TOKEN_IMAGE, FACE_TEMPLATE, VOICE_AUDIO, VOICE_TEMPLATE]

Return type​

Object

Authorization​

admin-basic, admin-oauth

HTTP request headers​

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

downloadSubjectsBiometricFaceDataBulkById​

Object downloadSubjectsBiometricFaceDataBulkById(ids, downloadOptions)

Download specified biometric data from the specified subjects ids

Parameters​

NameTypeDescriptionNotes
idsListList of subjects id's to be downloaded[default to null]
downloadOptionsListSet of data to be downloaded[default to null] [enum: FACE_IMAGE, FACE_TOKEN_IMAGE, FACE_TEMPLATE, VOICE_AUDIO, VOICE_TEMPLATE]

Return type​

Object

Authorization​

admin-basic, admin-oauth

HTTP request headers​

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

getBiometricFaceDataById​

BiometricFaceData getBiometricFaceDataById(id, width, height, max-bytes)

Get biometric face data's information by image id

Parameters​

NameTypeDescriptionNotes
idIntegerBiometric face data ID to search with. (ID is unique number generated by the DB)[default to null]
widthIntegerAdjust image width[optional] [default to 0]
heightIntegerAdjust image height[optional] [default to 0]
max-bytesIntegerAdjust jpeg quality to fit into the maximum bytes[optional] [default to 0]

Return type​

BiometricFaceData

Authorization​

admin-basic, admin-oauth

HTTP request headers​

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

getBiometricFaceDataByUUID​

BiometricFaceData getBiometricFaceDataByUUID(uuid, width, height, max-bytes)

Get image's information by UUID

Parameters​

NameTypeDescriptionNotes
uuidStringUUID to search image by. (UUID is unique generated by the DB)[default to null]
widthIntegerAdjust image width[optional] [default to 0]
heightIntegerAdjust image height[optional] [default to 0]
max-bytesIntegerAdjust jpeg quality to fit into the maximum bytes[optional] [default to 0]

Return type​

BiometricFaceData

Authorization​

admin-basic, admin-oauth

HTTP request headers​

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

getBiometricFingerDataByUUID​

BiometricFingerData getBiometricFingerDataByUUID(uuid)

Get finger's information by UUID

Parameters​

NameTypeDescriptionNotes
uuidStringUUID to search biometric finger by. (UUID is unique generated by the DB)[default to null]

Return type​

BiometricFingerData

Authorization​

admin-basic, admin-oauth

HTTP request headers​

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

getBiometricVoiceDataById​

BiometricVoiceData getBiometricVoiceDataById(id)

Get voice's information by id

Parameters​

NameTypeDescriptionNotes
idIntegerBiometric voice data ID to search with. (ID is unique number generated by the DB)[default to null]

Return type​

BiometricVoiceData

Authorization​

admin-basic, admin-oauth

HTTP request headers​

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

getBiometricVoiceDataByUUID​

BiometricVoiceData getBiometricVoiceDataByUUID(uuid)

Get voice's information by UUID

Parameters​

NameTypeDescriptionNotes
uuidStringUUID to search biometric voice by. (UUID is unique generated by the DB)[default to null]

Return type​

BiometricVoiceData

Authorization​

admin-basic, admin-oauth

HTTP request headers​

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