API v1

Enviar código

POST/v1/send

Cria um envio para processamento assíncrono. A resposta 202 Accepted confirma o aceite do pedido; consulte o status para acompanhar a entrega.

Nesta página

Requisição

Use Authorization: Bearer SUA_CHAVE e Content-Type: application/json. O cabeçalho opcional Idempotency-Key evita duplicações em retentativas.

CampoTipoRegra
tostring, obrigatórioTelefone válido em formato internacional E.164, iniciado por +. Exemplo: +5531999999999.
codestring, opcionalDe 4 a 10 dígitos. Quando omitido, a aut2fa gera 6 dígitos em live ou usa 000000 em test.
localestring, opcionalUse pt-BR ou en. Quando omitido, usa o idioma da conta.

Preserve zeros iniciais: envie "0042", não um número. O telefone é normalizado; números sem o sinal + e código do país são rejeitados.

curl https://api.aut2fa.com/v1/send \
  -H "Authorization: Bearer $AUT2FA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"to":"+5531999999999","locale":"pt-BR"}'

Os clientes nativos geram uma chave única por novo pedido. Antes da chamada, guarde essa chave e o corpo serializado para reutilizá-los em uma retentativa. O cURL mínimo omite idempotência; consulte idempotência para repetir chamadas com segurança.

Resposta 202

JSON
{
  "id": "snd_01m4prwckhd0kyjgv5vw8a5wjr",
  "status": "queued",
  "verification": "pending",
  "mode": "test",
  "channel": null,
  "from": null,
  "expires_at": "2026-10-11T15:10:00Z",
  "created_at": "2026-10-11T15:00:00Z",
  "sent_at": null,
  "delivered_at": null,
  "read_at": null,
  "verified_at": null,
  "failed_at": null,
  "failure_reason": null
}

Este exemplo usa uma chave test. Em uma aplicação live, mode será live. Uma retentativa idempotente pode retornar o estado atual de um envio já existente.

A resposta nunca contém o código OTP. Guarde o id no servidor para consultar e verificar o envio.

CampoTipoSignificado
idstringIdentificador do envio; use em status e verificação.
statusstringEstado da entrega. Veja os estados de entrega.
verificationstringpending, verified, expired ou locked; separado do estado da entrega.
modestringtest ou live, conforme a aplicação da chave.
channelstring ou nullCanal escolhido pela plataforma. null antes do roteamento; sandbox em teste.
fromstring ou nullRemetente usado, quando definido.
expires_atdata e horaPrazo de validade do código. Compare com o horário atual.
created_atdata e horaQuando o envio foi criado.
sent_atdata e hora ou nullQuando o provedor aceitou a mensagem.
delivered_atdata e hora ou nullQuando a entrega foi confirmada, se houver recibo.
read_atdata e hora ou nullQuando a leitura foi confirmada, se houver recibo.
verified_atdata e hora ou nullQuando o código foi verificado com sucesso.
failed_atdata e hora ou nullQuando a entrega encerrou com falha.
failure_reasonstring ou nullMotivo da falha de entrega. Veja falhas de entrega.

Datas usam o formato RFC 3339. null indica que a informação ainda não existe ou não está disponível; trate isso antes de formatar uma data.

Validação e erros

Veja o envelope de erro para tratar a resposta pelo campo code. Após uma falha de rede, repita os mesmos bytes do corpo e a mesma chave de idempotência.

Abrir painel da aut2fa

Buscar na documentação

Digite uma palavra para procurar nos guias e na API.

Use as setas para percorrer os resultados. Enter abre a página. Esc fecha a busca.