9. Application Entity

A 2FA application consists of the following parameters:

Parameter

Explanation

Default value

alphanumeric

Type: “boolean”

The type of generated PIN. If set to true then a random alphanumeric PIN will be generated, in case of false a numeric PIN will be generated.

This value can be set by the user.

false

attempts

Type: “Integer”

The number of attempts that are allowed to verify a delivered OTP. After this number of attempts, the OTP will be invalid.

This value can be set by the user.

3

expire

Type: “Integer”

The value in seconds until the delivered OTP expires. After expiration, the OTP is not valid anymore.

This value can be set by the user.

300

created

Type: “Long”

The time in milliseconds that this application was created.

This value cannot be set by the user.

Now()

template

Type: “Map”

A key-value map that contains the language (in ISO 639-1 format https://en.wikipedia.org/wiki/ISO_639-1) and the template.

The template must include the {{OTP}} placeholder. {{SEC}} placeholder replaces the “expire” to the template and is not mandatory to be included.

This value can be changed by the user by a specific API operation.

{ "en": "OTP code: {{OTP}}. Valid for {{SEC}} seconds." }

sender

Type: “String”

The sender name that will be used for SMS delivery.

This value can be set by the user.

“VERIFY”

caller

Type: “String”

The caller id to be used for voice calls.

This value can be set by the user.