Create a 2FA Verification
Creates a 2FA verification and sends a one-time password (OTP) to the destination phone number over the selected channel. Requires a 2FA service configured in the Wavix portal; the service is reused to generate and validate OTPs.
The verification proceeds through three steps:
- Create a verification to generate and send an OTP.
- Resend the OTP on the same verification if needed.
- Validate the OTP through the check endpoint.
Authorizations
Wavix API key. Pass as Authorization: Bearer <api_key>. Keys support per-resource scopes (none / read / write). See Restricted keys and scopes.
Body
Attributes for the new 2FA verification.
Unique Wavix 2FA Service ID. Available on the Wavix portal.
"7204a030201211ee9fb47d093f2f127c"
End user's phone number to which the verification code will be sent. The phone number must be in E.164 format.
"447919433768"
Channel used to deliver the verification code. One of sms (sent as a text message) or voice (read aloud over a phone call).
"sms"
Response
Returns the created 2FA verification.
Indicates whether the 2FA Verification was successfully created
true
Unique identifier of the Wavix 2FA Service
"7204a030201211ee9fb47d093f2f127c"
Automatically generated 2FA Verification URL. The URL can be used to resend or validate the OTP.
"https://api.wavix.com/v1/two-fa/verification/2953d4308f2e11ecb75fcdafd6d2d687"
Unique identifier of the Wavix 2FA Verification
"2953d4308f2e11ecb75fcdafd6d2d687"
The end user's phone number.
"447919433768"
Date and time the 2FA Verification is created
"2022-02-16T13:41:38.000Z"