Documentation for Mega Matcher ID management
Documentation for API Endpoints
All URIs are relative to http://localhost
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AccountApi | changeAccount | POST /admin/accounts/change | Changes account |
| AccountApi | createAccount | POST /admin/accounts/create | Creates an account |
| AccountApi | deleteAccount | DELETE /admin/accounts/delete | Deletes an account |
| AccountApi | getAccounts | GET /admin/accounts | Get all accounts according to the filter |
| AccountApi | getAccountsCount | GET /admin/accounts/count | Get account count |
| BiometricDataApi | downloadBiometricDataBulkByOperation | GET /admin/biometric-data/operation/download | Download specified image's data from the specified operation's ids |
| BiometricDataApi | downloadBiometricDataBulkBySubjectIds | GET /admin/biometric-data/subjectids/download | Download specified biometric face data from the specified subjects ids |
| BiometricDataApi | downloadBiometricDataBulkByUUID | GET /admin/biometric-data/uuid/download | Download specified biometric face data from the specified operation's ids |
| BiometricDataApi | downloadBiometricDataBySubjectId | GET /admin/biometric-data/subjectid/{subjectId}/download | Download specified biometric face data from the specified subject's id |
| BiometricDataApi | downloadBiometricDataByUUID | GET /admin/biometric-data/uuid/{uuid}/download | Download specified biometric face data from the specified operation's id |
| BiometricDataApi | downloadSubjectsBiometricDataById | GET /admin/biometric-data/subject/{id}/download | Download specified biometric data from the specified subject's id |
| BiometricDataApi | downloadSubjectsBiometricFaceDataBulkById | GET /admin/biometric-data/subjects/download | Download specified biometric data from the specified subjects ids |
| BiometricDataApi | getBiometricFaceDataById | GET /admin/biometric-data/face/id/ | Get biometric face data's information by image id |
| BiometricDataApi | getBiometricFaceDataByUUID | GET /admin/biometric-data/face/uuid/ | Get image's information by UUID |
| BiometricDataApi | getBiometricVoiceDataById | GET /admin/biometric-data/voice/id/ | Get voice's information by id |
| BiometricDataApi | getBiometricVoiceDataByUUID | GET /admin/biometric-data/voice/uuid/ | Get voice's information by UUID |
| ExceptionsApi | clearExceptionDb | DELETE /admin/exceptions/clear-db | Clear all exception error from Db |
| ExceptionsApi | getAllExceptions | GET /admin/exceptions/export | Get all exceptions |
| ExceptionsApi | getExceptionById | GET /admin/exceptions/id | Get exception by id |
| ExceptionsApi | getExceptionLog | GET /admin/exceptions | Get log of exceptions by custom filter |
| ExceptionsApi | getExceptionLogCount | GET /admin/exceptions/count | Get count of exceptions by custom filter |
| ExceptionsApi | getExceptionsCallstackById | GET /admin/exceptions/callstack | Get exceptions callstack by id |
| ExceptionsApi | importExceptionList | POST /admin/exceptions/import | Import exception list |
| ImagesApi | downloadImageInfoBulkByOperation | GET /admin/images/operation/download | Download specified image's data from the specified operation's ids |
| ImagesApi | downloadImageInfoBulkBySubject | GET /admin/images/subjects/download | Download specified image's data from the specified subjects ids |
| ImagesApi | downloadImageInfoByOperationId | GET /admin/images/operation/{id}/download | Download specified image's data from the specified operation's id |
| ImagesApi | downloadImageInfoBySubjectId | GET /admin/images/subject/{id}/download | Download specified image's data from the specified subject's id |
| ImagesApi | getImageById | GET /admin/images/id/ | Get image's information by image and operation id |
| ImagesApi | getImageByUUID | GET /admin/images/uuid/ | Get image's information by UUID |
| JanusApi | attachToJanusConnection | POST /admin/janus/attach | Attaches to Janus connection |
| JanusApi | connectToJanus | POST /admin/janus/connect | Connects to Janus session |
| JanusApi | createAndAttach | POST /admin/janus/create-and-attach | Creates and attaches to Janus session |
| JanusApi | createJanusConnection | POST /admin/janus/create | Creates Janus connection |
| JanusApi | getInfo | GET /admin/janus/info | Returns info about Janus server |
| JanusApi | getListSession | GET /admin/janus/list-sessions | Returns list of current Janus sessions |
| JanusApi | getSession | GET /admin/janus/session | Returns info about Janus session |
| JanusApi | getSessionRaw | GET /admin/janus/session-raw | Returns raw info about Janus session |
| JanusApi | getStatus | GET /admin/janus/get-status | Returns raw info about Janus session |
| JanusApi | setSettings | POST /admin/janus/settings | Sets janus settings |
| JanusApi | stopJanusConnection | POST /admin/janus/stop | Stops an active Janus session |
| JanusApi | trickleJanus | POST /admin/janus/trickle | Trickles data to Janus server |
| LicensingApi | generateDongleDump | GET /admin/licensing/generate-dongle-dump | Generates dongle dump |
| LicensingApi | getCloudLicensingInfo | GET /admin/licensing/cloud | Get currently used cloud license information |
| LicensingApi | getDongles | GET /admin/licensing/dongles | Get currently attached dongles to the licensing service |
| LicensingApi | getInternetLicensingInfo | GET /admin/licensing/internet | Get currently used internet license information |
| LicensingApi | getLicensingToken | GET /admin/licensing/token | Get the current licensing token |
| LicensingApi | getLicensingUsage | GET /admin/licensing/usage | Get the usage details of the licensing operations |
| LicensingApi | getUpdateStatus | GET /admin/licensing/update-status | Get the current status of the update in licensing service |
| LicensingApi | updateDongle | POST /admin/licensing/update | Apply update to the licensing service |
| ManagementApi | deleteSetting | DELETE /admin/management/setting | Deletes one setting that match the key |
| ManagementApi | getClusterStatus | GET /admin/management/cluster/status | Gets cluster status |
| ManagementApi | getDefaultProperties | GET /admin/management/default-properties | Gets default properties of biometric operations |
| ManagementApi | getManagementInfo | GET /admin/management/info | Gets information and vital parameters of management |
| ManagementApi | getSetting | GET /admin/management/setting | Gets one setting that match the key |
| ManagementApi | getSettings | GET /admin/management/settings | Gets all settings saved in management |
| ManagementApi | getSettingsByKey | GET /admin/management/settings/key | Gets all settings that starts with the prefix |
| ManagementApi | login | POST /login | Authenticates a user using username and password. Returns auth type and granted authorities. |
| ManagementApi | oauth2Token | POST /oauth2/token | Token endpoint |
| ManagementApi | resetSettings | POST /admin/management/settings/reset | Resets all default settings. |
| ManagementApi | setSetting | POST /admin/management/settings | Saves or deletes the setting with specified key |
| OperationsApi | checkImage | POST /admin/operations/checkimage | Performs checks on a image |
| OperationsApi | createOperation | POST /admin/operations/create | Create new operation and insert it to the database |
| OperationsApi | deleteOperation | DELETE /admin/operations/uuid/ | Delete operation from the database by uuid |
| OperationsApi | deleteOperations | DELETE /admin/operations | Delete operations from the database by UUIDs' |
| OperationsApi | getLog | GET /admin/operations | Get log of operations by custom filter |
| OperationsApi | getLogCount | GET /admin/operations/count | Count operations by filter |
| OperationsApi | getOperationById | GET /admin/operations/id/ | Get operation's information by id |
| OperationsApi | getOperationByUUID | GET /admin/operations/uuid/ | Get operation by UUID |
| OperationsApi | remoteVerify | POST /admin/operations/remote-verify | RemoteVerify is used to remotely verify a FVTemplate and an encrypted template created locally using MegaMatcherId SDK |
| SubjectsApi | clearDb | DELETE /admin/subjects/clear-db | Clear all DB or by prefix depending on the use case. |
| SubjectsApi | createSubject | POST /admin/subjects/create | Create new subject and insert it to the database |
| SubjectsApi | deleteSubject | DELETE /admin/subjects/id/ | Delete subject, operation and biometric data by subject id |
| SubjectsApi | deleteSubjects | DELETE /admin/subjects | Delete subjects from the database by subject ids |
| SubjectsApi | downloadSubjectsInfoBulk | GET /admin/subjects/download | Download specified subject's data from the specified subjects' id list |
| SubjectsApi | getMultimodalSubjectById | GET /admin/subjects/multimodal/id/{id} | Get subject's information by id |
| SubjectsApi | getMultimodalSubjectByOperationId | GET /admin/subjects/multimodal/operation/{uuid} | Get subject information by UUID |
| SubjectsApi | getMultimodalSubjectBySubjectId | GET /admin/subjects/multimodal/{subjectId} | Get subject's information by subject id |
| SubjectsApi | getMultimodalSubjects | GET /admin/subjects/multimodal | Get subjects by custom filter |
| SubjectsApi | getSubjectById | GET /admin/subjects/id/{id} | Get subject's information by id |
| SubjectsApi | getSubjectByOperationId | GET /admin/subjects/operation/{uuid} | Get subject information by UUID |
| SubjectsApi | getSubjectBySubjectId | GET /admin/subjects/{subjectId} | Get subject's information by subject id |
| SubjectsApi | getSubjects | GET /admin/subjects | Get subjects by custom filter |
| SubjectsApi | getSubjectsCount | GET /admin/subjects/count | Count subjects by filter |
| SubjectsApi | getSubjectsEnrolledModalities | GET /admin/subjects/modality/types | Modalities to which the subject has already been enrolled |
| SubjectsApi | getSubjectsIdList | GET /admin/subjects/id-list | Get subjects' id list |
| SubjectsApi | getSubjectsQRCodeBySubjectId | GET /admin/subjects/qrcode/{subjectid} | QR code of the MegaMatcherId template |
| SubjectsApi | getTemplateModalities | POST /admin/subjects/qrcode/modalities | Returns modality types in the the template |
| SubjectsApi | reextractSubject | POST /admin/subjects/reextract-subject | Allows to reextract the template to the current version for the best accuracy |
Documentation for Models
- AccessTokenResponse
- AccountModel
- BiometricFaceData
- BiometricVoiceData
- CandidateData
- ChangeAccountRequest
- ChecksFromImage
- Cloud
- ConnectData
- CreateAccountRequest
- CreateOperationRequest
- CreateSubjectRequest
- DbClusterStatus
- DeleteAccount
- DeleteAccountsRequest
- Dongle
- EnrolledModalities
- ExceptionModel
- FVAdvancedInitParams
- FVInitParams
- GetTemplateModalitiesRequest
- Image
- InternetLicense
- JanusAdminGetStatusResponse
- JanusAdminSessionResponse
- JanusResponse
- JanusResponseData
- JanusResponseError
- JanusStatus
- Jsep
- LoginResponse
- MMIDAdvancedInitParams
- MMIDInitParams
- MultimodalSubject
- Operation
- PacketBytes
- Rectangle
- ReextractSubjectRequest
- SessionData
- SessionDownload
- Subject
- SubjectId
- SubjectQRCode
- TemplateModalities
- TrickleData
- Usage
Documentation for Authorization
admin-basic
- Type: HTTP basic authentication
admin-oauth
- Type: OAuth
- Flow: accessCode
- Authorization URL: http://localhost:40002/oauth2/authorize
- Scopes:
- ADMIN: Access admin and user endpoints
user-basic
- Type: HTTP basic authentication
user-oauth
- Type: OAuth
- Flow: accessCode
- Authorization URL: http://localhost:40002/oauth2/authorize
- Scopes:
- USER: Access user endpoints