AI Agent Skill for WhatsApp APIMore
1msg official logo

KYC action required alert via WhatsApp API

The scenario sends the client a personalized WhatsApp template when KYC or compliance review flags a required action with a deadline.

Use case overview

The scenario sends the client a personalized WhatsApp template when KYC or compliance review flags a required action with a deadline. The message includes the client name, the action to complete, and the due date. A static URL button opens the verification portal or document upload flow.

Template example

Hello, {{1}}! Your KYC verification requires action: {{2}}. Please complete it by {{3}} using the button below. If you have questions — we are here to help.

Complete KYC
  • {{1}}
    customer name
  • {{2}}
    required KYC action (e.g. upload proof of address, update business details, complete identity check)
  • {{3}}
    action deadline (e.g. March 15, 2026)
  • “Complete KYC”
    button — fixed in the Meta template
WhatsApp Business API for kyc action required notification

When to use it

Reach for this scenario when KYC or compliance review flags that a client must take a specific action — upload a document, update business details, or finish an identity check — before a deadline, and they have no open WhatsApp chat so only an approved template can reach them. It fits fintech teams activating accounts after KYC, marketplaces keeping seller compliance current, and agencies wiring action-required events from CRM or onboarding platforms into WhatsApp.

Fewer missed KYC deadlines
Three body variables carry the client name, the required action, and the due date into WhatsApp, so the notice names what to do and when instead of a generic compliance email that is easy to ignore.
One tap to the verification portal
A static URL button labeled Complete KYC opens the portal or upload flow fixed in the Meta template — only the body text is sent via the API while the link stays in the approved template.
Reach clients without an open chat
Because there is no active conversation, the send uses an approved WhatsApp template via the 1MSG API — the only channel that can notify the client outside the 24-hour session window.
No manual chase at scale
When the KYC or compliance system flags action required, it resolves the phone and builds the template from review fields — nobody retypes action notices across accounts by hand.
Delivery logged for compliance follow-up
Delivery result is logged after send, so CRM or compliance teams can track who received the action-required notice before access is restricted.

Workflow

  1. Customer acts

    KYC or compliance review flags that the client must complete a specific action by a deadline.

    user action

  2. Capture event

    The system resolves the recipient phone number and action-required fields.

    phone: "+…"

  3. Build & send

    A personalized template message is built with three body variables and a static URL button.

    POST /sendTemplate

  4. Delivered

    The client receives the WhatsApp notification with the required action and due date.

    delivered

  5. Status tracked

    Delivery result is logged; the client may complete the step via portal and continue in session after reply.

    status: "read"

WhatsApp Business API for kyc action required notification

Technical implementation

Prerequisites

  1. 1MSG API Key · How to get API Key
  2. WhatsApp Business account · How to Connect WABA
  3. WhatsApp Template · How to Approve WABA Template
  4. Customer opt-in · How to Manage Customers Consent

Code examples

#!/usr/bin/env bash
set -euo pipefail

# === Configuration (replace "___" placeholders) ===

API_BASE_URL="https://api.1msg.io"        # production 1MSG API base URL
CHANNEL_ID="___"                           # channel ID from 1MSG dashboard
API_TOKEN="___"                            # channel JWT token (Bearer)

TEMPLATE_NAME="___"                        # approved template name
TEMPLATE_NAMESPACE="___"                   # template namespace (required — send fails without it)
TEMPLATE_LANGUAGE="___"                    # template language code, e.g. "en"



# === Test data ===
TEST_PHONE="___"                 # client phone in international format
TEST_CUSTOMERNAME="___"         # {{1}} customer name
TEST_ACTION="___"         # {{2}} action name
TEST_DUEDATE="___"         # {{3}} due date

PHONE_NORM="$(printf '%s' "$TEST_PHONE" | tr -cd '0-9')"

for pair in "CHANNEL_ID=$CHANNEL_ID" "API_TOKEN=$API_TOKEN" \
            "TEMPLATE_NAME=$TEMPLATE_NAME" "TEMPLATE_NAMESPACE=$TEMPLATE_NAMESPACE" \
            "TEMPLATE_LANGUAGE=$TEMPLATE_LANGUAGE" "TEST_PHONE=$TEST_PHONE" \
            "TEST_CUSTOMERNAME=$TEST_CUSTOMERNAME" \
            "TEST_ACTION=$TEST_ACTION" \
            "TEST_DUEDATE=$TEST_DUEDATE"; do
    val="${pair#*=}"
    if [ -z "$val" ] || [ "$val" = "___" ]; then
        echo "Missing configuration value: ${pair%%=*}" >&2
        exit 1
    fi
done

if [ -z "$PHONE_NORM" ]; then
    echo "Error: phone number has no digits after normalization" >&2
    exit 1
fi

URL="${API_BASE_URL%/}/${CHANNEL_ID}/sendTemplate"

# params carries body ONLY. Button text is fixed in the Meta template — no button param.

# {{1}} customer name → ${TEST_CUSTOMERNAME}
# {{2}} action name → ${TEST_ACTION}
# {{3}} due date → ${TEST_DUEDATE}
read -r -d '' PAYLOAD <<JSON || true
{
  "phone": "${PHONE_NORM}",
  "template": "${TEMPLATE_NAME}",
  "namespace": "${TEMPLATE_NAMESPACE}",
  "language": { "policy": "deterministic", "code": "${TEMPLATE_LANGUAGE}" },
  "params": [
    {
      "type": "body",
      "parameters": [
        { "type": "text", "text": "${TEST_CUSTOMERNAME}" },
        { "type": "text", "text": "${TEST_ACTION}" },
        { "type": "text", "text": "${TEST_DUEDATE}" }
      ]
    }

  ]
}
JSON

RESPONSE="$(curl -s -w '\n%{http_code}' -X POST "$URL" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer ${API_TOKEN}" \
    -d "$PAYLOAD")"

HTTP_CODE="$(printf '%s' "$RESPONSE" | tail -n1)"
BODY="$(printf '%s' "$RESPONSE" | sed '$d')"

case "$BODY" in
    *'"sent":true'*) ok=1 ;;
    *) ok=0 ;;
esac

if [ "$HTTP_CODE" -ge 200 ] && [ "$HTTP_CODE" -lt 300 ] && [ "$ok" -eq 1 ]; then
    echo "Message sent to client."
    echo "API response: $BODY"
else
    echo "Send failed. HTTP status: $HTTP_CODE" >&2
    echo "$BODY" >&2
    exit 1
fi

Response and delivery status

HTTP 2xx and JSON "sent": true mean 1MSG accepted the message for sending — not that it already reached the customer's phone. Save the id field (looks like wamid.…) to correlate delivery callbacks.

200 OKResponse
{
  "sent": true,
  "message": "Sent to [email protected]",
  "description": "Message has been sent to the provider",
  "id": "wamid.HBgLMzgwNjM5..."
}
  • sent

    Accepted for sending — not yet on the customer's phone

  • id

    Store it; delivery callbacks and hookInfo are keyed on this

Delivery statuses and webhooks →

Common errors

StatusAPI responseCauseFix
200Message was not sent: template is not definednamespace, template or language is missing from the request body.Send all three. Take namespace and the exact template name from GET /templates; language is an object: {"policy": "deterministic", "code": "en"}.
200template name (…) does not exist in <language>The template is approved in a different language than the one requested.Use the exact language code the template was approved in (for example es_MX is not the same as es). Check it in GET /templates.
200Message was not sent: provide chatId, phone, bsuid, or usernameNo recipient the channel could resolve.Pass exactly one recipient: phone (country code plus number, digits only), chatId (for example [email protected]) or bsuid.

All error codes →

Common questions

Related

OTP Verification
eKYC pending review notice via WhatsApp API
The scenario sends the client a personalised WhatsApp template when their eKYC or identity verification is pending review.
OTP Verification
Identity verification request via WhatsApp API
The scenario sends the client a personalized WhatsApp template when identity or KYC verification is required but not yet started.
OTP Verification
Secure portal login OTP via WhatsApp API
The scenario sends a WhatsApp authentication template with a one-time verification code when the user must confirm sign-in to a protected or secure service.
OTP Verification
App signup verification code via WhatsApp API
Sends a WhatsApp authentication template with a one-time registration confirmation code in the message body and a copy-code button.
OTP Verification
Migrate OTP from SMS to WhatsApp API
Delivers a one-time verification code through a WhatsApp authentication template when your product switches OTP delivery from SMS to WhatsApp.
OTP Verification
OTP to confirm secure actions via WhatsApp API
The scenario sends a WhatsApp authentication template with a one-time verification code when the user must confirm a secure action before it executes.
OTP Verification
Access verification code via WhatsApp API
Sends a one-time access confirmation code through a WhatsApp authentication template when the user must verify identity before using a protected service.
OTP Verification
Login authorization OTP via WhatsApp API
Sends a one-time authorization code through a WhatsApp authentication template when the user must confirm sign-in or access.

Build for WhatsApp in hours
without infrastructure hassle