Verificar código OTP

Name: FonteData
Author: FonteData

POST https://app.fontedata.com/api/v1/consulta/otp-verify

Grátis não debita saldo

Autenticação pelo header X-API-Key. Veja como obter a chave.

Confere o código digitado pelo usuário. Esta consulta é gratuita — você paga o envio, não a verificação.

O código é de uso único: uma verificação bem-sucedida encerra o request_id, e uma segunda chamada com o mesmo código é recusada. Cada erro consome uma tentativa; depois de 5 erros o request_id trava e é preciso emitir outro.

Código errado, expirado ou travado não é erro de HTTP. A resposta vem com 200 e verificado: false, e o campo motivo diz o que aconteceu. Trate a decisão pelo corpo, não pelo status.

Requisição

curl -X POST -H "X-API-Key: SUA_CHAVE" \
  "https://app.fontedata.com/api/v1/consulta/otp-verify?request_id=otp_5c1d0e00000000000000000000000000&codigo=123456"

Parâmetros

Nome	Tipo	Descrição	Exemplo
request_id obrigatório	texto	Identificador devolvido no envio do código.	otp_5c1d0e00000000000000000000000000
codigo obrigatório	texto	Código que o usuário digitou.	123456

Resposta

verificado — true quando o código confere. Só este campo vem no caso de sucesso.
motivo — Por que não conferiu. Presente apenas quando verificado é false:
- incorrect — Código errado. Ainda dá para tentar de novo, se restar tentativa.
- expired — Passou da validade definida no envio. Emita um novo código.
- locked — As 5 tentativas se esgotaram. Emita um novo código.
- failed_delivery — O SMS não chegou a ser aceito para envio; não há código válido a conferir.
tentativas_restantes — Quantas tentativas ainda restam neste request_id. Vem junto com motivo: incorrect.

Exemplo — 200 OK

{
  "verificado": true
}

Schema da resposta (JSON Schema)

JSON Schema

{
  "type": "object",
  "properties": {
    "motivo": {
      "type": [
        "string",
        "null"
      ]
    },
    "verificado": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "tentativas_restantes": {
      "type": [
        "integer",
        "null"
      ]
    }
  },
  "additionalProperties": true
}

Códigos de erro

Código	Mensagem	Quando acontece
404	Verificação não encontrada.	O `request_id` não existe ou pertence a outra conta.
409	Este código já foi utilizado.	O `request_id` já foi verificado com sucesso — o código é de uso único.

Quando usar

Chame no envio do formulário de código. Use tentativas_restantes para avisar o usuário antes de ele travar a verificação — e ofereça o Reenviar código OTP quando ela chegar perto de zero ou quando o motivo for expired.

Integrar

OpenAPI (JSON) ↗ — importe a URL no Postman ou no Insomnia para gerar a coleção com todos os endpoints. Também dá para consultar pelo chat: conecte via MCP. Esta página em Markdown.