Código de verificação bem-sucedido

POST

O evento verify_code.success é acionado quando o código de verificação foi entregue com sucesso e o destinatário foi verificado.

Notificações de webhook

Authorizations

• token

Request Body ^required

Media type application/json

object

id

Unique entity UUID

string

/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/

api_version

Versão da estrutura de dados do webhook de notificação

string

name

Nome do evento do Webhook

string

created_at

Timestamp when the entity was added to the system by the user

integer

attempt_total

Número total de tentativas de entrega de webhooks de notificação

integer

>= 1 <= 4

attempt_number

Número atual da tentativa de notificação do webhook

integer

>= 1

notification_task_id

Notification task identifier (request identifier)

string format: uuid

name

Allowed values: verify_code.success

data

Data for verify_code.success, verify_code.failed and verify_code.channel.updated events

object

id

Verify code ID (UUID)

string

user_id

User ID

integer

phone

Phone number

string

routing_strategy

Routing strategy configuration

Array<object>

object

channel

string

Allowed values: telegram sms

timeout_sec

Timeout in seconds. Only applicable for the telegram channel.

integer

sender_id

string

status

Verify code status

integer

delivered_channel

Channel that delivered the code

string | null

cost

Cost in cents

integer | null

currency

Currency code

string | null

code

Verification code

string | null

code_length

Code length

integer | null

payload

Custom payload

string | null

created_at

Creation timestamp

integer

updated_at

Last update timestamp

integer

history

Processing history

Array<object>

object

id

string

channel

string

status

integer

processed_at

integer

external_id

string

is_code_deleted

Whether the verification code has been deleted from storage after being sent.

boolean

Examples

Example success

Verify Code Success Event

Event sent when the verification code was successfully delivered and verified

{
  "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "api_version": "2022-05-25",
  "name": "verify_code.success",
  "created_at": 1735689600,
  "attempt_total": 3,
  "attempt_number": 1,
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "user_id": 12345,
    "phone": "+4915112345678",
    "routing_strategy": [
      {
        "channel": "telegram",
        "timeout_sec": 30,
        "sender_id": "LOX24"
      },
      {
        "channel": "sms",
        "timeout_sec": 60,
        "sender_id": "LOX24"
      }
    ],
    "status": 10,
    "delivered_channel": "telegram",
    "cost": 5,
    "currency": "EUR",
    "code": "1234",
    "code_length": 4,
    "payload": "session_abc123",
    "created_at": 1735689540,
    "updated_at": 1735689600,
    "history": [
      {
        "id": "a1b2c3d4-d5e6-7890-abcd-ef1234567890",
        "channel": "telegram",
        "status": 10,
        "processed_at": 1735689570,
        "external_id": "tg_msg_001"
      }
    ],
    "is_code_deleted": false
  },
  "notification_task_id": "3378de83-de66-4de8-9d29-2b10d41bb641"
}

Responses

200

Webhook recebido

400

Estrutura do corpo do pedido de webhook inválido

401

Pedido de webhook não autorizado

403

Acesso proibido ao webhook

404

Acesso proibido ao webhook

500

Erro do servidor