Skill de IA para API do WhatsAppMais
1msg official logo

WhatsApp Business API para notificação de ekyc pendente

O cenário envia ao cliente um modelo de WhatsApp personalizado quando sua eKYC ou verificação de identidade está pendente de revisão.

Visão geral do caso de uso

O cenário envia ao cliente um modelo de WhatsApp personalizado quando sua verificação eKYC ou de identidade está pendente de revisão. A mensagem inclui o nome do cliente, o processo de verificação e o rótulo do status atual. Um botão de URL estático abre a página de status da verificação ou o portal do cliente.

Modelo exemplo

Olá, {{1}}! Seu {{2}} está atualmente: {{3}}. Nós o informaremos quando a revisão estiver concluída. Se você tiver dúvidas — estamos aqui para ajudar.

Verificar status
  • {{1}}
    nome do cliente
  • {{2}}
    processo de verificação (por exemplo, verificação eKYC, verificação de identidade, revisão de documentos)
  • {{3}}
    rótulo de status atual (por exemplo, Em revisão, Aguardando revisão, Aguardando verificação)
  • “Verificar status”
    botão — fixo no modelo Meta
WhatsApp Business API for ekyc pending notification

Quando usá-lo

Alcance este cenário quando um cliente tiver enviado documentos de eKYC ou concluído um fluxo de verificação de identidade e o caso estiver pendente ou em revisão — e você precisar tranquilizá-lo proativamente antes da aprovação ou rejeição. Isso se aplica a equipes de fintech processando filas de KYC, marketplaces aguardando verificações de identidade dos vendedores e agências enviando webhooks de status de provedor de eKYC ou conformidade para o WhatsApp.

Menos ligações perguntando "você recebeu meus documentos?"
Três variáveis do corpo contêm o nome do cliente, o rótulo do processo de verificação e o status pendente atual, para que o cliente saiba que a revisão está em andamento sem precisar abrir o e-mail ou ligar para o suporte.
Verificações de status a um toque
Um botão de URL estático rotulado como Verificar status abre o portal de verificação ou página de status — o link é fixo no modelo aprovado da Meta, enquanto apenas o texto do corpo é enviado via API.
Atualizações sem uma janela de bate-papo aberta
Como não há uma conversa ativa, o envio utiliza um modelo de WhatsApp aprovado via API 1MSG — o único canal que pode alcançar o cliente fora da janela de sessão de 24 horas.
Sem garantia manual para cada caso pendente
Quando o provedor de eKYC ou o escritório de apoio marca um caso como pendente de revisão, a integração resolve o número de telefone e dispara o modelo nesse evento em vez de alguém copiar o texto de status manualmente.
Entrega registrada para acompanhamento de conformidade
O resultado da entrega é registrado após o envio, para que as equipes de CRM ou de conformidade possam ver quem foi notificado e lidar com erros de acordo com as regras da plataforma.

Como funciona

  1. Ações do cliente

    O cliente envia os documentos de eKYC ou completa o fluxo de verificação.

    user action

  2. Escritório

    O back office, o provedor de eKYC ou a integração marcam o caso como pendente de revisão.

    POST /sendTemplate

  3. Status rastreado

    O sistema resolve os campos de número de telefone do destinatário e de status pendente.

    status: "read"

  4. Construir & enviar

    Uma mensagem de modelo personalizada é construída com três variáveis de corpo e um botão de URL estático.

    POST /sendTemplate

  5. Entregue

    O cliente recebe a notificação do WhatsApp de que a verificação está em análise.

    delivered

  6. Resultado da entrega foi registrado

    O resultado da entrega é registrado; os erros são tratados de acordo com as regras da plataforma.

    status: "read"

WhatsApp Business API for ekyc pending notification

Implementação técnica

Pré-requisitos

  1. 1MSG API Key · Como obter a chave da API
  2. Conta do WhatsApp Business · Como Conectar WABA
  3. Modelo do WhatsApp · Como Aprovar o Modelo WABA
  4. Opt-in do cliente · Como Gerenciar o Consentimento dos Clientes

Exemplos de código

#!/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_PROCESS="___"         # {{2}} process name
TEST_STATUS="___"         # {{3}} status label

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_PROCESS=$TEST_PROCESS" \
            "TEST_STATUS=$TEST_STATUS"; 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}} process name → ${TEST_PROCESS}
# {{3}} status label → ${TEST_STATUS}
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_PROCESS}" },
        { "type": "text", "text": "${TEST_STATUS}" }
      ]
    }

  ]
}
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

Status de resposta e entrega

HTTP 2xx e JSON "sent": true significam 1MSG aceitou a mensagem para envio — não que ela já tenha chegado ao telefone do cliente. Salve o id campo (parece wamid.…) para correlacionar os callbacks de entrega.

200 OKResposta
{
  "sent": true,
  "id": "wamid.HBgLMzgwNjM5...",
  "message": "Message accepted for delivery"
}
  • sent

    Aceito para envio — não ainda no telefone do cliente

  • id

    Armazene isso; os callbacks de entrega e hookInfo são baseados nisso

Delivery itself arrives later, as a separate callback. Register a webhook (POST …/webhook) and 1MSG POSTs status updates to your HTTPS endpoint in a top-level hooks[] payload.

200 OKWebhook de status de entrega — dados que você recebe
{
  "hooks": [
    {
      "id": "gBGGeSaGViBfAgnlzOSHEwK9O6F",
      "type": "message",
      "status": "sent",
      "timestamp": "1654864094",
      "recipient_id": "556123122026"
    }
  ]
}
  • status

    sent, delivered, read — ou um status de falha quando aplicável

  • id

    Correlaciona o callback com o id retornado pela chamada send

  • timestamp

    Unix segundos, como uma string

Se você preferir não receber callbacks, faça polling em GET {base}/{channel}/hookInfo?messageId=<id> em vez disso. Na prática, a entrega muitas vezes é concluída em segundos — mas o contrato da API não garante isso, então nunca bloqueie um fluxo esperando por ela.

Erros comuns

StatusRespostaCausa
200Message was not sent: template is not definednamespace, template or language missing from the request body.
200template name (…) does not exist in <language>The template is approved in a different language than the one requested.
200Message was not sent: provide chatId, phone, bsuid, or usernameNo recipient the channel could resolve.
403access deniedThe token is wrong, or belongs to a different channel than the URL.
429too many requests. please try laterThe channel is over its send rate.

FAQ

Sim — mensagens de WhatsApp de início a frio requerem um modelo aprovado pela Meta.

Relacionado

Verificação OTP
WhatsApp Business API para notificação de ação kyc necessária
O cenário envia ao cliente um modelo de WhatsApp personalizado quando a revisão de KYC ou conformidade sinaliza uma ação necessária com prazo.
Verificação OTP
WhatsApp Business API para solicitação de verificação
O cenário envia ao cliente um modelo de WhatsApp personalizado quando a verificação de identidade ou KYC é necessária, mas ainda não iniciada.
Verificação OTP
WhatsApp Business API para login seguro com otp
O cenário envia um modelo de autenticação do WhatsApp com um código de verificação único quando o usuário confirma o login em um serviço seguro.
Verificação OTP
WhatsApp Business API para confirmação de registro do aplicativo
Envia um modelo de autenticação do WhatsApp com um código de confirmação de registro de uso único no corpo da mensagem e um botão para copiar o código.
Verificação OTP
WhatsApp Business API para migração de SMS para WhatsApp OTP
Entrega um código de verificação único através de um modelo de autenticação WhatsApp quando seu produto troca a entrega de OTP de SMS para WhatsApp.
Verificação OTP
WhatsApp Business API para confirmação segura de ação otp
O cenário envia um modelo de autenticação do WhatsApp com um código de verificação quando o usuário deve confirmar uma ação segura.
Verificação OTP
WhatsApp Business API para confirmação de acesso ao serviço
Envia um código de confirmação único pelo modelo de autenticação do WhatsApp quando o usuário deve verificar a identidade antes de usar um serviço.
Verificação OTP
WhatsApp Business API para confirmação de autorização otp
Envia um código de autorização único através de um modelo de autenticação do WhatsApp quando o usuário deve confirmar o login ou acesso.

Crie para o WhatsApp em horas
sem complicações de infraestrutura