Context message
The following table lists endpoints and the status of each field in the Context message. Statuses include Mandatory, Optional, and Not used.
| RPC Method | Engagement ID | Session ID | Scope ID | configset ID |
|---|---|---|---|---|
| Person | ||||
| CreatePerson | Mandatory | Mandatory | Mandatory | Not used |
| DeletePerson | Mandatory | Mandatory | Mandatory | Not used |
| DeletePersonalData | Mandatory | Mandatory | Mandatory | Not used |
| GetGkPersonId | Not used | Not used | Mandatory | Not used |
| GetPersonDetails | Not used | Not used | Mandatory | Not used |
| OptPersonIn | Mandatory | Mandatory | Mandatory | Not used |
| OptPersonOut | Mandatory | Mandatory | Mandatory | Not used |
| UpdatePerson | Mandatory | Mandatory | Mandatory | Not used |
| Fraudster | ||||
| CreateFraudster | Mandatory | Mandatory | Mandatory | Not used |
| DeleteFraudster | Mandatory | Mandatory | Mandatory | Not used |
| GetFraudsterDetails | Not used | Not used | Mandatory | Not used |
| GetGkFraudsterId | Not used | Not used | Mandatory | Not used |
| UpdateFraudster | Mandatory | Mandatory | Mandatory | Not used |
| Group | ||||
| CreateGroup | Mandatory | Mandatory | Mandatory | Not used |
| DeleteGroup | Mandatory | Mandatory | Mandatory | Not used |
| GetGkGroupId | Not used | Not used | Mandatory | Not used |
| GetGroupDetails | Not used | Not used | Mandatory | Not used |
| UpdateGroup | Mandatory | Mandatory | Mandatory | Not used |
| Person & Group | ||||
| AddPersonToGroup | Mandatory | Mandatory | Mandatory | Not used |
| IsPersonInGroup | Not used | Not used | Mandatory | Not used |
| ListGroupPersons | Not used | Not used | Mandatory | Not used |
| RemovePersonsFromGroup | Mandatory | Mandatory | Mandatory | Not used |
| Watchlist | ||||
| CreateWatchlist | Mandatory | Mandatory | Mandatory | Not used |
| DeleteWatchlist | Mandatory | Mandatory | Mandatory | Not used |
| GetGkWatchlistId | Not used | Not used | Mandatory | Not used |
| GetWatchlistDetails | Not used | Not used | Mandatory | Not used |
| UpdateWatchlist | Mandatory | Mandatory | Mandatory | Not used |
| Fraudster & Watchlist | ||||
| AddFraudsterToWatchlist | Mandatory | Mandatory | Mandatory | Not used |
| IsFraudsterInWatchlist | Not used | Not used | Mandatory | Not used |
| ListWatchlistFraudsters | Not used | Not used | Mandatory | Not used |
| RemoveFraudstersFromWatchlist | Mandatory | Mandatory | Mandatory | Not used |
| Sessions | ||||
| GetSessionDecision | Not used | Optional | Mandatory | Not used |
| GetSessionDetails | Not used | Optional | Mandatory | Not used |
| StartSession | Optional | Not used | Mandatory | Optional |
| StopSession | Mandatory | Mandatory | Mandatory | Not used |
| UpdateSession | Mandatory | Optional | Mandatory | Not used |
| Engagements | ||||
| GetEngagementDetails | Optional | Not used | Mandatory | Not used |
| GetGkEngagementId | Optional | Not used | Mandatory | Not used |
| SetEngagementVerdict | Optional | Not used | Mandatory | Not used |
| StartEngagement | Not used | Not used | Mandatory | Optional |
| StopEngagement | Mandatory | Not used | Mandatory | Not used |
| UpdateEngagement | Optional | Not used | Mandatory | Not used |
| Audio Management | ||||
| GetDownloadUrl | Not used | Not used | Mandatory | Not used |
| GetMediaSegmentDetails | Not used | Not used | Mandatory | Not used |
| GetProcessedAudioDetails | Not used | Not used | Mandatory | Not used |
| GetUploadUrl | Mandatory | Mandatory | Mandatory | Not used |
| UpdateMediaSegmentDetails | Mandatory | Mandatory | Mandatory | Not used |
| UpdateProcessedAudioDetails | Mandatory | Mandatory | Mandatory | Not used |
| Audio Processing | ||||
| DetectAudioSpoofing | Mandatory | Mandatory | Mandatory | Mandatory |
| DetectLiveness | Mandatory | Mandatory | Mandatory | Mandatory |
| GetLivenessPrompt | Mandatory | Mandatory | Mandatory | Mandatory |
| ValidateText | Mandatory | Mandatory | Mandatory | Mandatory |
| Voiceprints Manager | ||||
| CreateVoiceprintProfile | Mandatory | Mandatory | Mandatory | Not used |
| DeleteVoiceprintProfile | Mandatory | Mandatory | Mandatory | Not used |
| DeleteVoiceprintTemplate | Mandatory | Mandatory | Mandatory | Not used |
| GetGkVoiceprintProfileId | Not used | Not used | Mandatory | Not used |
| GetVoiceprintProfileDetails | Not used | Not used | Mandatory | Not used |
| ListEnrollmentSegments | Not used | Not used | Mandatory | Not used |
| LockVoiceprintProfile | Mandatory | Mandatory | Mandatory | Not used |
| RemoveEnrollmentSegment | Mandatory | Mandatory | Mandatory | Not used |
| UnlockVoiceprintProfile | Mandatory | Mandatory | Mandatory | Not used |
| UpdateVoiceprintProfileDetails | Mandatory | Mandatory | Mandatory | Not used |
| Voiceprints processing | ||||
| DetectKnownFraudsters | Mandatory | Mandatory | Mandatory | Mandatory |
| Enroll | Mandatory | Mandatory | Mandatory | Mandatory |
| GetEnrollStatus | Mandatory | Mandatory | Mandatory | Mandatory |
| Identify | Mandatory | Mandatory | Mandatory | Mandatory |
| ProcessAudio | Mandatory | Mandatory | Mandatory | Mandatory |
| Train | Mandatory | Mandatory | Mandatory | Mandatory |
| Verify | Mandatory | Mandatory | Mandatory | Mandatory |
| Roles | ||||
| CreateRole | Not used | Not used | Mandatory | Not used |
| DeleteRole | Not used | Not used | Mandatory | Not used |
| GetRoleId | Not used | Not used | Mandatory | Not used |
| ListRoles | Not used | Not used | Mandatory | Not used |
| Operations | ||||
| AddOperationsToRole | Not used | Not used | Mandatory | Not used |
| ListRoleOperations | Not used | Not used | Mandatory | Not used |
| RemoveOperationsFromRole | Not used | Not used | Mandatory | Not used |
| Members | ||||
| AddMemberToRole | Not used | Not used | Mandatory | Not used |
| ListAssignedRoles | Not used | Not used | Mandatory | Not used |
| RemoveMemberFromRole | Not used | Not used | Mandatory | Not used |
| Authorizations | ||||
| GetUserInfo | Not used | Not used | Not used | Not used |
| IsAuthorized | Not used | Not used | Mandatory | Not used |
| IsAuthorizedMany | Not used | Not used | Mandatory | Not used |
| ListAuthorizedOperations | Not used | Not used | Mandatory | Not used |
| ListAuthorizedScopes | Not used | Not used | Not used | Not used |
| ListRoleMembers | Not used | Not used | Mandatory | Not used |
| Scopes | ||||
| GetGkScopeId | Not used | Not used | Mandatory if gk_scope_id exists. Otherwise optional. | Not used |
| GetScopeDetails | Not used | Not used | Mandatory if gk_scope_id exists. Otherwise optional. | Not used |
| GetScopeResource | Not used | Not used | Mandatory if gk_scope_id exists. Otherwise optional. | Not used |
| ListScopes | Not used | Not used | Not used | Not used |
| MarkScopeForDeletion | Not used | Not used | Mandatory if gk_scope_id exists. Otherwise optional. | Not used |
| ResetScope | Not used | Not used | Mandatory if gk_scope_id exists. Otherwise optional. | Not used |
| SetScopeResource | Not used | Not used | Mandatory if gk_scope_id exists. Otherwise optional. | Not used |
| SetScopeState | Not used | Not used | Mandatory if gk_scope_id exists. Otherwise optional. | Not used |
| UnMarkScopeForDeletion | Not used | Not used | Mandatory if gk_scope_id exists. Otherwise optional. | Not used |
| UpdateScopeDetails | Not used | Not used | Mandatory if gk_scope_id exists. Otherwise optional. | Not used |
| Configset | ||||
| ActivateConfigsetRevision | Not used | Not used | Mandatory | Not used |
| CreateConfigset | Not used | Not used | Mandatory | Not used |
| DeleteConfigset | Not used | Not used | Mandatory | Not used |
| DeleteConfigsetRevision | Not used | Not used | Mandatory | Not used |
| GetConfigset | Not used | Not used | Mandatory | Not used |
| GetConfigsetRevision | Not used | Not used | Mandatory | Not used |
| ListConfigsetRevisions | Not used | Not used | Mandatory | Not used |
| UpdateConfigsetDetails | Not used | Not used | Mandatory | Not used |
| ValidateConfigsetRevision | Not used | Not used | Mandatory | Not used |
| Templates | ||||
| CreateTemplate | Not used | Not used | Mandatory | Not used |
| DeleteTemplate | Not used | Not used | Mandatory | Not used |
| GenerateTemplate | Not used | Not used | Mandatory | Not used |
| GetTemplate | Not used | Not used | Mandatory | Not used |
| ListTemplates | Not used | Not used | Mandatory | Not used |
| Tuning | ||||
| ActivateCalibrationModelRevision | Mandatory | Mandatory | Mandatory | Not used |
| CreateCalibrationModel | Mandatory | Mandatory | Mandatory | Not used |
| DeactivateCalibrationModelRevision | Mandatory | Mandatory | Mandatory | Not used |
| DownloadCalibrationModelRevision | Not used | Not used | Mandatory | Not used |
| ListCalibrationModelRevisions | Not used | Not used | Mandatory | Not used |
| UpdateCalibrationModel | Mandatory | Mandatory | Mandatory | Not used |
| ValidateCalibrationModelRevision | Mandatory | Mandatory | Mandatory | Mandatory |
| Reports | ||||
| ExportRecords | Optional | Optional | Mandatory | Optional |
| ExportRecordsWithPersonalData | Optional | Optional | Mandatory | Optional |
| CSM | ||||
| MonitorCallSession | Not used | Not used | Mandatory | Not used |
| SubmitAgentAction | Not used | Not used | Mandatory | Not used |
| ASM | ||||
| StartAgentSession | Not used | Not used | Mandatory | Not used |
| StopAgentSession | Not used | Not used | Mandatory | Not used |