Connectors Reference
Tyntec Authentication is a tool for user-friendly two-factor authentication (2FA) with SMS and voice.
|
Status: Preview |
Tier: Premium |
Version: 1.0 |
|
Name |
Summary |
|
Send One-Time Password |
|
|
Delete One-Time Password |
|
|
ResendOTP (string otpID, [Optional]string via, [Optional]string Sender, [Optional]string Caller) |
Resend One-Time Password |
|
Get One-Time Password Status |
|
|
Verify One-Time Password |
|
Name |
Summary |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Send One-Time Password
Description: Sends an OTP (One-time Password) to a destination number.
Syntax:
tyntec2FA.SendOTP (string number, [Optional]string text, [Optional]integer pinLength, [Optional]string via, [Optional]integer applicationId, [Optional]string language, [Optional]string country, [Optional]string otpCode, [Optional]string Sender, [Optional]string Caller)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
number |
string (Phone Number) |
Receiver's Phone Number |
True |
|
|
text |
string (Text) |
In case you want to overwrite the application template |
False |
|
|
pinLength |
integer (Pin Lenght) |
Length of the auto generated PIN |
False |
|
|
via |
string (Delivery Channel)Values: [AUTO, VOICE, SMS] |
The delivery channel |
False |
|
|
applicationId |
integer (Application ID) |
The applicationId of the application you would like to use. If not specified, uses default one. |
False |
|
|
language |
string (Language) |
Specifies the local language in ISO 639-1 |
False |
|
|
country |
string (Country) |
The ISO 3166-1 alpha-2 code of the destination number. |
False |
|
|
otpCode |
string (OTP Code) |
The OTP code to be delivered instead of auto generated one. |
False |
|
|
Sender |
string (Sender) |
Sender name for OTP delivery via SMS (if you want to override the application template one) |
False |
|
|
Caller |
string (Caller) |
Caller id for OTP delivery via Voice (if you want to override the application template one) |
False |
Returns:
Type:SendOTPResponse
Summary: Delete One-Time Password
Description: Deletes a given One-time Password
Syntax:
tyntec2FA.DeleteOTP (string otpID)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
otpID |
string (One-time Password ID) |
ID of your OTP |
True |
Returns:
Type:DeleteOTPResponse
Summary: Resend One-Time Password
Description: Resends the given OTP (One-time Password) to a destination number.
Syntax:
tyntec2FA.ResendOTP (string otpID, [Optional]string via, [Optional]string Sender, [Optional]string Caller)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
otpID |
string (One-time Password ID) |
ID of your OTP |
True |
|
|
via |
string (Delivery Channel)Values: [AUTO, VOICE, SMS] |
The delivery channel |
False |
|
|
Sender |
string (Sender) |
Sender name for OTP delivery via SMS (if you want to override the application template one) |
False |
|
|
Caller |
string (Caller) |
Caller id for OTP delivery via Voice (if you want to override the application template one) |
False |
Returns:
Type:ResendOTPResponse
Summary: Get One-Time Password Status
Description: Gets status report for given One-Time Password
Syntax:
tyntec2FA.StatusOTP (string otpID)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
otpID |
string (One-time Password ID) |
ID of your OTP |
True |
Returns:
Type:StatusOTPResponse
Summary: Verify One-Time Password
Description: Verifies the given OTP code.
Syntax:
tyntec2FA.VerifyOTP (string otpID, [Optional]integer otpCode)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
otpID |
string (One-time Password ID) |
ID of your OTP |
True |
|
|
otpCode |
integer (One-Time Password Code) |
Input One-time password code that you want to verify |
False |
Returns:
Type:VerifyOTPResponse
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
otpId |
string
|
otpId |
|
accountId |
string
|
accountId |
|
applicationId |
string
|
applicationId |
|
number |
string
|
number |
|
attemptCount |
integer(int32)
|
attemptCount |
|
otpStatus |
string
|
otpStatus |
|
expire |
integer(int32)
|
expire |
|
created |
integer(int32)
|
created |
|
referenceId |
string
|
referenceId |
|
timestampCreated |
string
|
timestampCreated |
|
timestampExpire |
string
|
timestampExpire |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
otpId |
string
|
otpId |
|
accountId |
string
|
accountId |
|
applicationId |
string
|
applicationId |
|
number |
string
|
number |
|
attemptCount |
integer(int32)
|
attemptCount |
|
otpStatus |
string
|
otpStatus |
|
expire |
integer(int32)
|
expire |
|
created |
integer(int32)
|
created |
|
referenceId |
string
|
referenceId |
|
timestampCreated |
string
|
timestampCreated |
|
timestampExpire |
string
|
timestampExpire |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
otpId |
string
|
otpId |
|
accountId |
string
|
accountId |
|
applicationId |
string
|
applicationId |
|
number |
string
|
number |
|
attemptCount |
integer(int32)
|
attemptCount |
|
otpStatus |
string
|
otpStatus |
|
expire |
integer(int32)
|
expire |
|
created |
integer(int32)
|
created |
|
referenceId |
string
|
referenceId |
|
timestampCreated |
string
|
timestampCreated |
|
timestampExpire |
string
|
timestampExpire |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
otpId |
string
|
otpId |
|
accountId |
string
|
accountId |
|
applicationId |
string
|
applicationId |
|
number |
string
|
number |
|
attemptCount |
integer(int32)
|
attemptCount |
|
otpStatus |
string
|
otpStatus |
|
expire |
integer(int32)
|
expire |
|
created |
integer(int32)
|
created |
|
referenceId |
string
|
referenceId |
|
timestampCreated |
string
|
timestampCreated |
|
timestampExpire |
string
|
timestampExpire |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
otpId |
string
|
otpId |
|
accountId |
string
|
accountId |
|
applicationId |
string
|
applicationId |
|
number |
string
|
number |
|
attemptCount |
integer(int32)
|
attemptCount |
|
otpStatus |
string
|
otpStatus |
|
expire |
integer(int32)
|
expire |
|
created |
integer(int32)
|
created |
|
referenceId |
string
|
referenceId |
|
timestampCreated |
string
|
timestampCreated |
|
timestampExpire |
string
|
timestampExpire |