Each verification process initiates only upon the definition of a scenario. Within said scenario, all the business logic pertaining to the user's verification requirements is delineated.

The Scenario Object:

Parameter Name	Description	Validations	Default Values	Required
settings	An object representing various general settings for the scenario document	-	-	yes
name	The name of the scenario	String - Max chars 60	-	yes
sticky_channel	A boolean value indicating whether this scenario will use the stickiness feature	Object	-	no
sticky_channel_ttl	The time to keep track of the last used channel (days)	boolean	FALSE	no
psd2_compliant	PSD2 is the 2nd Payment Services Directive established by the European Banking Authority (EBA). This directive is designed to drive payment innovation and data security by reducing competitive barriers, mandating new security processes and encouraging standardized technology.	boolean	FALSE	no
pin_options	An object representing various settings for the PIN Code	Object	-	no
ttl	The time frame that the PIN code is valid for verification (seconds)	int	10	yes
security	An object representing various security settings	Object	-	yes
rate_limiting	An object representing various rate-limiting settings	Object	-	yes
ip	Indicates if rate-limiting applies for an IP	boolean	TRUE	yes
destination	Indicates if rate-limiting applies for a destination address	boolean	TRUE	yes
interval	The intervals for rate-limiting to apply (minutes)	int	TRUE	yes
max_attempts	Maximum attempts allowed per IP and/or destination	int	TRUE	yes
block_scores	An array representing which fraud score results will be automatically blocked for verification	object	FALSE	yes
array_values	The values to block	string - Allowed values: high risk, moderate risk, low risk	-	True if block_scores array exists
channels	An array of objects representing the channels used for verification	Object	-	yes
channel	The name of the channel	Accepts: sms, viber, voice, flashcall	-	One of 4 values is required
from	The sender of the message (SMS channel)	numeric string (max length 16) or alphanumeric string (max length 11)	Verify	yes if SMS channel is used
message	The body of the message (SMS channel)	String - must contain @@pin argument once and only once	Your PIN is @@pin	yes
flash	Indicates if the SMS is a flash SMS (SMS channel)	Boolean	FALSE	no
transcode	Indicates if the message body will be transcoded (SMS channel)	Boolean	FALSE	no
order	Defines the priority order	Numeric	1	yes
next_event_in	Time for the next event in seconds	Numeric - min 20 max 60 for all channels except voice (min 60 max 120)	30	no
sender_info_tracking_id	The ID of the registered Viber Sender (Viber channel)	string	-	yes if Viber channel is used
message	The body of the message (Viber channel)	String - must contain @@pin argument once and only once	-	yes if Viber channel is used
order	Defines the priority order	Numeric	2	yes
next_event_in	Time for the next event in seconds	Numeric - min 20 max 60	30	no
from	The sender of the message (voice channel)	String	Verify	yes if voice channel is used
message	The body of the message (voice channel)	String - must contain @@pin argument once and only once	Your PIN is @@pin	yes if voice channel is used
language	The language for the message (voice channel)	String - Language of the voice message - VALUES: "en-US", "de-DE", "fr-FR", "it-IT", "pt-BR", "es-ES", "es-LA", "en-GB", "el-GR", "bg-BG", "pl-PL", "hu-HU", "sv-SE", "ru-RU"	en-US	yes if voice channel is used
gender	The gender of the voice (voice channel)	String - Gender of the voice - VALUES: "male", "female"	male	yes if voice channel is used
repeat	Number of repetitions of the message (voice channel)	int	1	no
dtmf_required	Indicates whether to start playing the message after a tone is pressed (voice channel)	boolean	FALSE	no

Verification process statuses

Status	Description
IN PROGRESS	Verification is still in progress
COMPLETED	Verification is completed
FAILED	Verification is failed
EXPIRED	Verification has expired
CANCELED	Verification has been canceled by the user
FRAUD	Verification has been detected as Fraud.

Verification process channel statuses

Status	Description
NOT ACTIVATED	Verification is still in progress
SENDING	Verification is completed
FAILED	Verification is failed
SENT	Verification has expired
SKIPPED	Verification has been canceled by the user

Custom validation rules

If the scenario is not PSD2 compliant, it necessitates that the "@@pin" keyword must be included in the message exactly once.

If the scenario is PSD2 compliant, it mandates that each of the "@@pin," "@@amount," and "@@payee" keywords should be included in the message exactly once.

Fraud scores

Fraud Score	Description
high risk	The verification process has been marked with a high risk score. We recommend canceling the verification.
moderate risk	The verification process has been marked with a moderate risk score. We recommend canceling the verification.
low risk	The verification process has been marked with a low risk score. We recommend canceling the verification.
looking good	The verification process has been marked with a positive score. We recommend proceeding with the verification.

Voice channel gender

male
female

Scenario Features

Sticky Channel:

Dictates whether the last successful channel will be utilized for a specific destination number and the duration of this adherence.

Pin Options:

Specifies the validity period for the verification until it expires.

Security Options:

Imposes rate limits on the number of requests a destination number or IP address can submit within a standard interval.

Fraud Detection:

Furnishes insights into the likelihood of fraud for each verification and permits automatic blocking of certain fraud scores.

Channel Configuration:

Outlines the channels to be employed, their sequence, and the interval between them during the verification process.