Copy Code Authentication Templates

Copy code authentication templates allow you to send a one-time password or code along with a copy code button to your users.

When a WhatsApp user taps the copy code button, it copies the password or code to the device's clipboard. The user can then switch to your app and paste the password or code into your app.

This process does not require the HandShake and App Signing Hash.

Copy code button authentication templates consist of:

• Preset text: <VERIFICATION_CODE> is your verification code.

• An optional security disclaimer: For your security, do not share this code.

• An optional expiration warning (optional): This code expires in <NUM_MINUTES> minutes.

• A copy code button.

URLs, media, and emojis are not supported.

Template Creation

You can use the WABA API to create copy code authentication templates. Alternatively, users can also create it using the WhatsApp Business Manager.

Use the create template endpoint and assemble the components in the request:

The base-url should be https://waba-v2.360dialog.io for Cloud API and https://waba.360dialog.io for On-Premise.

If you are using On-Premise API, remember that it is being discontinued by Meta. No new signups will be allowed with this type of integration from May 15, 2024.

Numbers registered before this date will still be supported, but should start planning a change of hosting type as soon as possible.

POST [base-url]/v1/configs/templates

The message template name field is limited to 512 characters. The message template content field is limited to 1024 characters.

Headers

Name	Type	Description
D360-API-KEY	string

Request Body

Name	Type	Description
name*	string
components*	array[objects]	Array of objects that describe the components that make up the template.
category*	string	Allowed values: AUTHENTICATION
language*	string	View list of supported languages here.

200: OK

Post Body

{
  "name": "<TEMPLATE_NAME>",
  "language": "<TEMPLATE_LANGUAGE>",
  "category": "authentication",
  "message_send_ttl_seconds": <TIME_T0_LIVE>, // Optional
  "components": [
    {
      "type": "body", 
      "add_security_recommendation": <SECURITY_RECOMMENDATION> // Optional
    },
    {
      "type": "footer", 
      "code_expiration_minutes": <CODE_EXPIRATION> // Optional
    },
    { 
      "type": "buttons",
      "buttons": [
        {
          "type": "otp",
          "otp_type": "copy_code",
          "text": "<COPY_CODE_BUTTON_TEXT>"  // Optional
        }
      ]
    }
  ]
}

Note that in your template creation request the button type is designated as OTP, but upon creation the button type will be set to URL. You can confirm this by performing a GET request on a newly created authentication template and analyzing its components.

Properties

Placeholder	Description	Example Value
<CODE_EXPIRATION> Integer	Optional. Indicates the number of minutes the password or code is valid. If included, the code expiration warning and this value will be displayed in the delivered message. The button will be disabled in the delivered message the indicated number of minutes from when the message was sent. If omitted, the code expiration warning will not be displayed in the delivered message. In addition, the button will be disabled 10 minutes from when the message was sent. Minimum 1, maximum 90.	5
<COPY_CODE_BUTTON_TEXT> String	Optional. Copy code button label text. If omitted, the text will default to a pre-set value localized to the template's language. For example, Copy Code for English (US). Maximum 25 characters.	Copy Code
<SECURITY_RECOMMENDATION> Boolean	Optional. Set to true if you want the template to include the string, For your security, do not share this code. Set to false to exclude the string.	true
<TEMPLATE_LANGUAGE> String	Required. Template language and locale code.	en_US
<TEMPLATE_NAME> String	Required. Template name. Maximum 512 characters.	verification_code
<TIME_TO_LIVE> Integer	Optional. Authentication message time-to-live value, in seconds. See Time-To-Live below.	60

Example Request

{
  "name": "authentication_code_copy_code_button",
  "language": "en_US",
  "category": "authentication",
  "message_send_ttl_seconds": 60,
  "components": [
    {
      "type": "body",
      "add_security_recommendation": true
    },
    {
      "type": "footer",
      "code_expiration_minutes": 5
    },
    {
      "type": "buttons",
      "buttons": [
        {
          "type": "otp",
          "otp_type": "copy_code",
          "text": "Copy Code"
        }
      ]
    }
  ]
}

Sending Copy Code Authentication Template Messages

See our Authentication Templates documentation to learn how to send it to customers.