VTToken API
This integration allows to securely generate a One Time Password (OTP). It obtains a digest of the password created and saves it in a repository. The digest then can be used to validate the password.
The VTToken also uses information to create the software token that must be protected. This is achieved by encrypting the sensitive data and saving it in a repository.
VTToken is always integrated on every application.
Note
The integration described in this article may not be implemented in your environment or enabled for all your clients. Contact your admin for assistance.
Technical Details
API ID | 105 |
API Code | VTTOKEN |
Call API version | 1 |
Objective | Token password that secures OTPs |
Classification | Security |
Available for | Android, iOS, HarmonyOS |
Use the VTToken API Integration in Studio
The following functions are available for use in your legacy processes, and you can also use them as blocks in Lambda processes. Click each function to see more details.
Set a password. | |
Activate a VT Token. | |
Generate a one-time password (OTP). | |
Validate a password. | |
Update a seed. | |
Run a cyclic redundancy check (CRC). | |
Change the VT Token password. | |
Validate the one-time password (OTP). | |
Initialize the offline synchronization. |
Set Password
This function sets a password.
Parameter Configuration
This function requires you to set input parameters for the password that is going to be created. Read Input Registers to learn more.
Function ID
Register | Value |
|---|---|
110 | 1 |
Input Registers
Register | Description | Mandatory | Value |
|---|---|---|---|
114 | New Password | Yes | <<NEWPASSWORD>> |
115 | New Password Confirmation | Yes | <<NEWPASSCONFIRM>> |
145 | Password Strength | No | <<PASSSTRENGHT>> |
146 | Password Weight | No | <<PASSWEIGHT>> |
125 | Flag Clear Password | No | <<CLEAR_PASSWORD>> |
Output Registers
Register | Description | Value | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
112 | Call Result |
| ||||||||||
113 | Password | After the function is executed, the token 125 (CLEAR PASSWORD) is verified. In case of having set "1" as a value, this token (113) is cleared. | ||||||||||
205 | Password Set Flag | After the function is executed, the token 125 (CLEAR PASSWORD) is verified. In case of having set "1" as a value, this token (205) is set with the value "1". |
Activate VT Token
This function activates the VT Token.
Parameter Configuration
This function requires some mandatory input parameters, such as the token seed and serial number. Read Input Registers to learn more.
Function ID
Register | Value |
|---|---|
110 | 2 |
Input Registers
Register | Description | Mandatory | Value |
|---|---|---|---|
116 | Token Serial Number | Yes | <<SERIALNUMBER>> |
117 | Token Seed | Yes | <<TOKENSEED>> |
125 | Flag Clear Password | No | <<CLEAR_PASSWORD>> |
Output Registers
Register | Description | Value | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
112 | Call Result |
| ||||||||||
113 | Password | After the function is executed, the token 125 (CLEAR PASSWORD) is verified. In case of having set "1" as a value, this token (113) is cleared. | ||||||||||
205 | Password Set Flag | After the function is executed, the token 125 (CLEAR PASSWORD) is verified. In case of having set "1" as a value, this token (205) is set with the value "1". | ||||||||||
206 | Activated Tokens | It is set with "1" as a value if the process is successful. |
Generate OTP
This function generates the OTP (One-time password).
Parameter Configuration
This function doesn't require you to complete any mandatory input parameters, but there is a list of optional ones. Read Input Registers to learn more.
Function ID
Register | Value |
|---|---|
110 | 3 |
Input Registers
Register | Description | Mandatory | Value |
|---|---|---|---|
118 | Challenge | No | <<CHALLENGE>> |
121 | Pin | No | <<PIN>> |
122 | Session Data | No | <<SESSIONDATA>> |
125 | Flag Clear Password | No | <<CLEAR_PASSWORD>> |
141 | CRC Validation | No | <<CRCVALIDATION>> |
142 | Transform Session Data | No | <<TRANSFORMSESSIONDATA>> |
Output Registers
Register | Description | Value | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
112 | Call Result |
| ||||||||||
113 | Password | After the function is executed, the token 125 (CLEAR PASSWORD) is verified. In case of having set "1" as a value, this token (113) is cleared. | ||||||||||
205 | Password Set Flag | After the function is executed, the token 125 (CLEAR PASSWORD) is verified. In case of having set "1" as a value, this token (205) is set with the value "1". | ||||||||||
119 | OCRA Suite | <<OCRASUITE>> | ||||||||||
123 | OTP | <<OTP>> | ||||||||||
211 | Data Offline Synchro | <<TOKEN DATA OFFLINE SYNCHRO>> if successful. |
Validate Password
This function allows you to validate a password.
Parameter Configuration
This function requires you to complete the password input parameter. Read Input Registers to learn more.
Function ID
Register | Value |
|---|---|
110 | 4 |
Input Registers
Register | Description | Mandatory | Value |
|---|---|---|---|
113 | Password | Yes | <<PASSWORD>> |
126 | Maximum Retries | No | <<TOKEN_MAX_PASSWORD_RETRIES>> |
Output Registers
Register | Description | Value | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
112 | Call Result |
| ||||||||||
205 | Password Set Flag | After the function is executed, the token 125 (CLEAR PASSWORD) is verified. In case of having set "1" as a value, this token (205) is set with the value "1". | ||||||||||
208 | Remaining attempts to open Repository | <<REMAINING TRIES TO OPEN REPOSITORY>> if successful. | ||||||||||
209 | Attemps to open Repository rejected | <<TRIES DENIED TO OPEN REPOSITORY>> if successful. |
Update Seed
This function updates the token seed.
Parameter Configuration
This function require you to complete the token seed and serial number in order to function properly. Read Input Registers to learn more.
Function ID
Register | Value |
|---|---|
110 | 5 |
Input Registers
Register | Description | Mandatory | Value |
|---|---|---|---|
116 | Token Serial Number | Yes | <<SERIALNUMBER>> |
117 | Token Seed | Yes | <<TOKENSEED>> |
125 | Flag Clear Password | No | <<CLEAR_PASSWORD>> |
Output Registers
Register | Description | Value | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
112 | Call Result |
| ||||||||||
113 | Password | After the function is executed, the token 125 (CLEAR PASSWORD) is verified. In case of having set "1" as a value, this token (113) is cleared. | ||||||||||
205 | Password Set Flag | After the function is executed, the token 125 (CLEAR PASSWORD) is verified. In case of having set "1" as a value, this token (205) is set with the value "1". | ||||||||||
206 | Activated Tokens | Value set to "1" if successful. |
Verify CRC
This function enables you to verify the Cyclic Redundancy Check (CRC).
Parameter Configuration
This function requires you to complete the challenge parameter. Read Input Registers to learn more.
Function ID
Register | Value |
|---|---|
110 | 6 |
Input Registers
Register | Description | Mandatory | Value |
|---|---|---|---|
118 | Challenge | Yes | <<CHALLENGE>> |
Output Registers
Register | Description | Value | ||||
|---|---|---|---|---|---|---|
112 | Call Result |
|
Change Password
This function enables you to change the VT Token password.
Parameter Configuration
This function requires you to complete the password, new password and confirm password parameters. Read Input Registers to read more.
Function ID
Register | Value |
|---|---|
110 | 7 |
Input Registers
Register | Description | Mandatory | Value |
|---|---|---|---|
113 | Password | Yes | After the function is executed, the token 125 (CLEAR PASSWORD) is verified. In case of having set "1" as a value, this token (113) is cleared. |
114 | New Password | Yes | <<NEWPASSWORD>> |
115 | New Password Confirmatio | Yes | <<NEWPASSCONFIRM>> |
145 | Password Strength | No | <<PASSSTRENGHT>> |
146 | Password Weight | No | <<PASSWEIGHT>> |
125 | Flag Clear Password | No | <<CLEAR_PASSWORD>> |
Output Registers
Register | Description | Value | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
112 | Call Result |
| ||||||||||||||||||
205 | Password Set Flag | After the function is executed, the token 125 (CLEAR PASSWORD) is verified. In case of having set "1" as a value, this token (205) is set with the value "1". |
Validate OTP
This function enables you to validate the OTP (one-time password).
Parameter Configuration
This function requires you to complete the OTP that is going to be validated. Read Input Registers to read more.
Function ID
Register | Value |
|---|---|
110 | 8 |
Input Registers
Register | Description | Mandatory | Value |
|---|---|---|---|
123 | OTP | Yes | <<OTP TO VALIDATE>> |
118 | Challenge | No | <<CHALLENGE>> |
121 | Pin | No | <<PIN>> |
122 | Session Data | No | <<SESSIONDATA>> |
128 | Forward Throttle | No | <<TOKEN_VALIDATION_FORWARD_THROTTLE>> |
141 | CRC Validation | No | <<CRCVALIDATION>> |
142 | Transform Session Data | No | <<TRANSFORM SESSION DATA>> |
143 | TOPT Left Interval | No | <<TOKEN_TOTP_LEFT_INTERVAL>> |
144 | TOPT Right Interval | No | <<TOKEN_TOTP_RIGHT_INTERVAL>> |
125 | Flag Clear Password | No | <<CLEAR_PASSWORD>> |
Output Registers
Register | Description | Value | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
112 | Call Result |
| ||||||||||||||||
113 | Password | After the function is executed, the token 125 (CLEAR PASSWORD) is verified. In case of having set "1" as a value, this token (113) is cleared. | ||||||||||||||||
119 | OCRA Suite | <<OCRASUITE>> | ||||||||||||||||
205 | Password Set Flag | After the function is executed, the token 125 (CLEAR PASSWORD) is verified. In case of having set "1" as a value, this token (205) is set with the value "1". | ||||||||||||||||
210 | Negative Validation Counter | <<TOKEN_NEGATIVE_VALIDATION_COUNTER>> |
Offline Synchronization
This function initializes the offline synchronization
Parameter Configuration
This function doesn't require the configuration of any parameters.
Function ID
Register | Value |
|---|---|
110 | 9 |
Output Registers
Register | Description | Value | ||
|---|---|---|---|---|
112 | Call Result |
| ||
211 | Offline Synchronization Data | <<TOKEN DATA OFFLINE SYNCHRO>> |