Documentação

Eventos de verificação

A CartaFlow faz um POST para a URL do seu webhook a cada mudança de status de uma verificação, criada pela API ou pelo painel.

Cabeçalhos

webhook-id*string

Id do evento. Igual em todas as tentativas de entrega do mesmo evento: use para ignorar repetições.

webhook-timestamp*string

Momento do envio em segundos Unix. Recuse entregas com mais de 5 minutos de diferença do seu relógio.

webhook-signature*string

Assinatura HMAC-SHA256 no padrão Standard Webhooks. Confira antes de confiar no conteúdo; veja o guia Webhooks.

Corpo da requisição

application/json
  1. body

Um acontecimento na sua conta, como uma correspondência postada. A CartaFlow envia cada evento para os seus webhooks e guarda por 30 dias.

id*string

Identificador único do evento. É o mesmo valor do cabeçalho webhook-id: use para ignorar entregas repetidas. Sempre começa com evt_.

Formato^evt_[A-Za-z0-9]+$
object*string

Tipo do objeto. Sempre event.

type*string

O tipo do evento.

Valores possíveis

  • verification.received: Uma verificação foi criada, pela API ou pelo painel (veja source), e a correspondência com o código está na fila de produção.
  • verification.in_production: A correspondência com o código está sendo impressa. A partir daqui, cancelar revoga a verificação, sem devolução.
  • verification.awaiting_code: A correspondência com o código foi postada. A pessoa já pode confirmar quando receber.
  • verification.verified: A pessoa confirmou o código certo. O endereço está verificado.
  • verification.failed: Foram digitados 5 códigos errados e a verificação foi bloqueada.
  • verification.expired: A pessoa não confirmou o código em 60 dias desde a postagem.
  • verification.canceled: A verificação foi cancelada antes da postagem, por você ou pela CartaFlow, e o valor voltou para o saldo.
  • verification.revoked: Você cancelou a verificação depois que a produção começou. O código deixou de funcionar e o valor não volta para o saldo. Se ela estava verified, trate o endereço como não verificado.
Valores"verification.received""verification.in_production""verification.awaiting_code""verification.verified""verification.failed""verification.expired""verification.canceled""verification.revoked"
data*|

O objeto inteiro, como estava logo depois do acontecimento: uma correspondência nos eventos letter.* e uma verificação nos eventos verification.*.

created_at*string

Quando o evento aconteceu.

Formatodate-time

Corpo da resposta

Responda com qualquer status 2xx em até 15 segundos para confirmar o recebimento. Faça o processamento demorado depois de responder.

Exemplos de requisição

POST/verification-events