GET VOICEBIOPRINT STATUS

Checks the voice biometric provider to see if the contact is already enrolled. If the contact is not enrolled, the script can prompt the contact to enroll.

Dependencies

• Use this action only for adding voice biometric authentication to IVR or virtual agent integrations. If you're setting up voice biometric authentication for use in interactions with live agents, you do not need these actions.

• This action cannot be used alone. It must be used with the other voice biometrics Studio actions:

  • VOICEBIO AUTHENTICATION
  • VOICEBIO ENROLLMENT
  • GET VOICEBIO RESULT

Supported Script Types

Phone

Input Properties

These properties define data that the action uses when executing. You can use variable substitution in all of the properties of this action.

Property	Description
Caption	Enter a short phrase that uniquely identifies this action in the script. The caption appears on the script canvas under the action icon. The default is the action name.
VoiceBioProfileId	The ID of the voice biometric profile associated with the contact.
PersonId	The unique identifier of the contact, such as an account number or a PIN.
scriptParams	The name of the variable that holds data to pass to the voice biometric provider. The data must be defined in a Snippet action using the Script Parameters code snippet. The variable you use in this field must hold the data in JSON format. If you don't include the snippet, you don't need to complete this field.  The default is {voiceBioResultInfo.voiceBioSessionId}.

*Required

Output Properties

These properties contain variables that hold data returned from executing the action. They're available for reference and use when the action completes.

Property	Description
Default	The path taken unless the script meets a condition that requires it to take one of the other branches. It is also taken if the other branches are not defined.
ErrorDetailsVarName (out)	When the Error branch is taken, this variable contains any details associated with the error.
VoiceBioResultInfoVarName (out)	Holds the result returned from the voice biometric provider.

Result Branch Conditions

Result branch conditions allow you to create branches in your script to handle different outcomes when an action executes.

Condition	Description
Default	Path taken unless the script meets a condition that requires it to take one of the other branches. It is also taken if the action's other branches are not defined.
OnError	Path taken when the action fails to execute properly. For example, when there is an unexpected problem such as poor connectivity, syntax errors, and so on. The _ERR variable, with a single underscore character, should be populated with a condensed explanation of the problem.
OnEnrolled	Path taken when the contact is already enrolled with the voice biometric provider.
OnNotEnrolledNeedConsent	Path taken when the contact is not enrolled with the voice biometric provider. Consent is required to proceed with the enrollment process.
OnConsentDenied	Path taken when the contact does not consent to using voice biometric authentication.

Script Example

This action must be used with the other voice biometric actions. The example script shown in the following image shows how to use all four of these actions in a script to set up voice biometric authentication in an IVR Automated phone menu that allows callers to interact through voice commands, key inputs, or both, to obtain information, route an inbound voice call, or both.. You can learn more about working with voice biometrics in a script on the help page about setting up voice biometrics for Nuance Gatekeeper.

Download this script.