Two-Factor Verification

/v1/settings/account/two-step

Use two-factor verification to add an extra layer of security to the WhatsApp Business API Client. When you have two-factor verification enabled, any attempt to register your phone number on WhatsApp must be accompanied by the six-digit PIN that you create using this feature. Two-Factor verification can be enabled and disabled using the /v1/settings/account/two-step endpoint.

This document covers:

You must use the admin account to access the two-factor verification settings.

Enabling Two-Factor Verification

Request

To enable two-factor verification, use the /v1/settings/account/two-step endpoint with the pin parameter.

POST /v1/settings/account/two-step
{
    "pin": "your-6-digit-pin"
}

Response

A successful request returns the HTTP Status Code 200 OK and either null or {}.

If you encounter any errors, see Error and Status Messages.

Disabling Two-Factor Verification

Request

DELETE /v1/settings/account/two-step

Response

A successful request returns the HTTP Status Code 200 OK and either null or {}.

If you encounter any errors, see Error and Status Messages.

Using the Two-Factor Verification PIN in Registration

If you are trying to re-register while the account has two-factor verification enabled, include the pin parameter in the registration request. Form more details on registration with two-factor verification enabled, see the Registration documentation.

Resetting your PIN

If you forget or misplace your PIN, you can disable two-factor verification, and then enable it again with a new PIN.