Create a new 2FA Verification

curl --request POST \
  --url 'https://api.wavix.com/v1/two-fa/verification?appid=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "service_id": "7204a030201211ee9fb47d093f2f127c",
  "to": "447919433768",
  "channel": "sms"
}
'

{
  "success": true,
  "service_id": "7204a030201211ee9fb47d093f2f127c",
  "session_url": "https://api.wavix.com/v1/two-fa/verification/2953d4308f2e11ecb75fcdafd6d2d687",
  "session_id": "2953d4308f2e11ecb75fcdafd6d2d687",
  "destination": "447919433768",
  "created_at": "2022-02-16T13:41:38.000Z",
  "number_lookup": {
    "number_type": "mobile",
    "country": "GB",
    "current_carrier": "Vodafone"
  }
}

2FA

Create a new 2FA Verification

Before sending and validating a one-time password (OTP), you must create a 2FA Service using the Wavix portal. The service must be created only once, you can use it to generate and validate as many OTPs as needed.

In order to send and verify an OTP, you must:

Create a new 2FA Verification using this API. The Wavix platform will automatically generate a random code and send it to the phone number specified in the request.
In cases when an end user requests a new OTP, you can reuse the same 2FA Verification to resend the code.
Validate the OTP using the Wavix 2FA API.

Use this method to create a new Wavix 2FA Verification. Once the Verification is created, Wavix will automatically generate a new random verification code and send it to the end user’s phone number via the communication channel specified in the request.

POST

two-fa

verification

Create a new 2FA Verification

curl --request POST \
  --url 'https://api.wavix.com/v1/two-fa/verification?appid=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "service_id": "7204a030201211ee9fb47d093f2f127c",
  "to": "447919433768",
  "channel": "sms"
}
'

{
  "success": true,
  "service_id": "7204a030201211ee9fb47d093f2f127c",
  "session_url": "https://api.wavix.com/v1/two-fa/verification/2953d4308f2e11ecb75fcdafd6d2d687",
  "session_id": "2953d4308f2e11ecb75fcdafd6d2d687",
  "destination": "447919433768",
  "created_at": "2022-02-16T13:41:38.000Z",
  "number_lookup": {
    "number_type": "mobile",
    "country": "GB",
    "current_carrier": "Vodafone"
  }
}

Authorizations

appid

string

query

required

An API key to authorize your request

Body

application/json

service_id

string

required

Unique Wavix 2FA Service ID. Find your 2FA Service ID on the Wavix portal.

Example:

"7204a030201211ee9fb47d093f2f127c"

string

required

End user's phone number to which the verification code will be sent. The phone number must be in E.164 format.

Example:

"447919433768"

channel

string

required

The communication channel you want to use. Can be either sms or voice.

Example:

"sms"

Response

success

boolean

required

Indicates whether the 2FA Verification was successfully created

Example:

true

service_id

string

required

Unique identifier of the Wavix 2FA Service

Example:

"7204a030201211ee9fb47d093f2f127c"

session_url

string

required

Automatically generated 2FA Verification URL. The URL can be used to resend or validate the OTP.

Example:

"https://api.wavix.com/v1/two-fa/verification/2953d4308f2e11ecb75fcdafd6d2d687"

session_id

string

required

Unique identifier of the Wavix 2FA Verification

Example:

"2953d4308f2e11ecb75fcdafd6d2d687"

destination

string

required

The end user’s phone number

Example:

"447919433768"

created_at

string<date-time>

required

Date and time the 2FA Verification is created

Example:

"2022-02-16T13:41:38.000Z"

number_lookup

LookupDetails · object

required

Show child attributes

number_lookup.number_type

string

required

The destination phone number type

Example:

"mobile"

number_lookup.country

string

required

The destination phone number's 2-letter ISO country code

Example:

"GB"

number_lookup.current_carrier

string

required

The carrier name the phone number currently belongs to

Example:

"Vodafone"

Get metrics for short links

List Wavix 2FA Verifications

Using the APIs

API reference

Create a new 2FA Verification

Authorizations

Body

Response