Voice Biometrics API | OCP® Learning Center

This document describes how the Voice Biometrics API be used independently as a stand alone offering.

Prerequisites

The prerequisites to use the endpoints below are the following:

Create a VB profile.
Create a Personal Access Token that belongs to the same group as the VB profile.

Endpoints

`biokeys` object

A biokey is a supplementary identifier used when you enroll a user. Enrollment requires at least one mapped biokey.

Allowed characters: numbers (1-9), letters (a-z, A-Z), underscore (_), plus (+), and dash (-). Special characters are not allowed, except for underscore, dash, and plus.

Table 1: biokeys object fields

Field Name	Description	Type	Required
`id`	Internal identifier for the biokey.	Integer	No
`key`	The name of the biokey field (for example, `UserID` or `ANI`).	String	Yes
`value`	The value for this biokkey.	String	Yes
`display_name`	Human-readable name for the biokey (for example, `User` or `Phone Number`).	String	No
`priority`	Integer indicating the priority of this biokey for matching/verification. The biokey with the highest priority is used for matching.	Integer	No
`sensitive`	Boolean indicating if the biokey contains sensitive information.	Boolean	No
`is_user_id`	Boolean indicating if this biokey is the primary user identifier.	Boolean	Yes

Table 2: CreateTokenRequest fields

Field Name	Description	Type	Required
`agentId`	The agent ID.	String	Yes
`agentSkill`	The agent skill.	String	Yes
`ccaasProvider`	The CCAAS provider.	String	Yes
`masterId`	The master ID (callId).	String	Yes
`tenantId`	The tenant ID.	String	Yes
`vbProfile`	The VB profile.	String	Yes
`customProperties`	The custom properties object.	String	No

Table 3: OnDemandVerificationResponse fields

Field Name	Description	Type	Example
`bio_result`	The result of the biometric verification.	String	`TRUE_HIGH`, `TRUE_LOW`, `FALSE_HIGH`, `FALSE_LOW`,`ERROR`
`bio_score`	The score of the biometric verification.	Float	`0.99350625`
`bio_user_id`	The hashed bio-user ID of the user.	String	`92feb9...`
`bio_plain_user_id`	The plain text bio-user ID of the user.	String	`petros1`
`error_type`	The error type of the verification, if any.	String	`null`
`user_changed`	Boolean indicating if the user has changed.	Boolean	`false`
`speech_millis`	The time in milliseconds for speech verification.	Integer	`15440`

Table 4: UserInfoResponse fields

Field Name	Description	Type	Example
`user_id`	The unique identifier for the user (bio-user ID).	String	`Master`
`status`	The enrollment status of the user.	String	`ENROLLED`, `NOT_ENROLLED`, `RE_ENROLL`, `OPTED_OUT`
`last_update`	The timestamp (in milliseconds) of the last user update.	Integer	`1699021370022`
`opt_out_ts`	The timestamp (in milliseconds) of the last user opt-out.	Integer	`0`
`opt_in_ts`	The timestamp (in milliseconds) of the last user opt-in.	Integer	`0`
`is_greylisted`	Boolean indicating if the user is greylisted.	Boolean	`true`