Documentação da API — VerifyEmail

Início rápido

Crie uma chave API no painel, guarde-a no servidor e envie-a como credencial Bearer. Cada pedido de verificação aceite consome um crédito.

Pedido

curl -sS -X POST 'https://api.verifyemail.net/api/v1/verifications' \
  -H 'Authorization: Bearer ve_live_your_api_key' \
  -H 'Content-Type: application/json' \
  -d '{"address":"[email protected]"}'

Resposta · HTTP 200

{
  "errcode": 0,
  "address": "[email protected]",
  "is_deliverable": true,
  "status": 250,
  "catch_all": false,
  "disposable": false
}

Autenticação

Crie uma chave API no painel: Painel → Chaves API

O valor completo ve_live_… é apresentado apenas uma vez.

Guarde as chaves API como segredos do servidor. Nunca as coloque em código do navegador, parâmetros de URL, repositórios públicos ou registos visíveis pelo cliente.

Authorization: Bearer ve_live_your_api_key

Verificar um email

POST/verifications

Corpo do pedido

Campo	Tipo	Obrigatório	Descrição
address	string	Sim	Um endereço de email completo.

Campos da resposta

Campo	Tipo	Descrição
errcode	number	0 indica sucesso; trate os restantes valores através da tabela de erros.
address	string	O endereço de email normalizado.
is_deliverable	boolean	Indica se o servidor recetor aceita o destinatário.
status	number \| null	O código numérico de resposta SMTP, ou null quando não foi recebida uma resposta SMTP.
catch_all	boolean \| null	Indica se o domínio aceita qualquer destinatário. Null significa que não existe uma conclusão fiável.
disposable	boolean	Indica se o endereço pertence a um domínio de email temporário.

250 · HTTP 200 · errcode 0

O servidor recetor aceitou o destinatário.

550 · HTTP 200 · errcode 0

O domínio ou servidor recetor rejeitou o destinatário.

null · HTTP 422

O endereço é inválido ou não pode ser verificado.

null · HTTP 503

Não existe uma conclusão fiável; tente novamente mais tarde.

Também está disponível o endpoint GET abaixo. Recomenda-se POST para evitar que os endereços apareçam nos registos do proxy ou no histórico do navegador: /verifications?address=…

Consultar créditos restantes

GET/usage

Este pedido não consome créditos de verificação. As sessões do painel e todas as chaves API do mesmo utilizador partilham um único saldo.

Pedido

curl -sS 'https://api.verifyemail.net/api/v1/usage' \
  -H 'Authorization: Bearer ve_live_your_api_key'

Resposta · HTTP 200

{
  "errcode": 0,
  "verification_limit": 100,
  "verification_used": 1,
  "remaining_verifications": 99,
  "unlimited": false
}

Campo	Tipo	Descrição
verification_limit	number	O limite total atual. Zero significa ilimitado.
verification_used	number	O número de créditos de verificação já utilizados.
remaining_verifications	number \| null	Créditos ainda disponíveis; null numa conta ilimitada.
unlimited	boolean	Indica se o saldo atual é ilimitado.

Os planos ilimitados devolvem remaining_verifications: null, unlimited: true.

Códigos de erro

Utilize o número errcode na lógica do programa. O texto message pode mudar.

Resposta de erro

{
  "errcode": 10006,
  "message": "request rate limit exceeded"
}

errcode	HTTP	Significado
0	2xx	Pedido concluído com sucesso.
10000	400	Pedido malformado; verifique JSON, cabeçalhos e método HTTP.
10001	400 / 422	Um parâmetro ou regra de negócio falhou a validação.
10002	401	A credencial está ausente, é inválida ou expirou.
10003	403	A conta não pode aceder a este recurso.
10004	404	O recurso pedido não existe.
10005	409	O recurso está em conflito com o estado atual.
10006	429	O limite de pedidos por segundo foi excedido.
10007	429	Os créditos de verificação esgotaram-se.
10008	429	A capacidade concorrente do serviço esgotou-se.
10009	500	Ocorreu um erro interno do serviço.
10010	503	O serviço está temporariamente indisponível ou não configurado.
10011	502	Um serviço externo devolveu um erro.

Cabeçalhos de limite

Retry-After, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset — descrevem a janela de pedidos atual.

Pronto para o primeiro pedido?Crie uma conta e receba 100 créditos de verificação.