Documentos da API de validação de e-mail

Estado da API

Como começar

Todos os pedidos de API requerem autenticação utilizando uma chave de API. Pode encontrar a sua chave de API no painel de controlo.

Cabeçalho: "x-api-key: your-api-key"

Verificação única

Verificar a validade, o estado descartável, os serviços de privacidade e a capacidade de entrega de um único endereço ou domínio de correio eletrónico.

Ponto final

GET /v1/verify

Parâmetros

NomeTipoNecessárioDescrição
inputstringSimEndereço de correio eletrónico ou domínio a verificar (por exemplo, [email protected] ou example.com)

apiDocs.responseFields

CampoDescrição
validIndica se o formato do correio eletrónico está correto
blockIndica se o correio eletrónico deve ser bloqueado (verdadeiro se descartável, privacidade, applePrivateEmail, entregável ou catch_all for verdadeiro)
disposableDetermina se o endereço de correio eletrónico é temporário ou descartável
privacyDetermina se o servidor de correio eletrónico está a utilizar um alias ou reencaminhador de correio eletrónico
applePrivateEmailIndica se o correio eletrónico é um endereço de correio eletrónico Apple Private
deliverableVerifica se a caixa de correio existe e se pode receber mensagens de correio eletrónico
domainA parte do domínio do endereço de correio eletrónico
email_addressO endereço de correio eletrónico
catch_allIndica se o domínio tem uma configuração de correio eletrónico abrangente que aceita todas as mensagens de correio eletrónico recebidas, independentemente do endereço do destinatário
mx_foundIndica se o domínio tem servidores de correio válidos (registos MX)
remaining_creditsO número de créditos API restantes na sua conta

Exemplo de resposta

{
  "valid": true,
  "block": false,
  "disposable": false,
  "privacy": false,
  "applePrivateEmail": false,
  "deliverable": true,
  "domain": "example.com",
  "email_address": "[email protected]",
  "catch_all": false,
  "mx_found": true,
  "error": null,
  "remaining_credits": 99
}

Exemplos de códigos

curl "https://api.verify-email.app/v1/[email protected]" \
  -H "X-API-Key: your-api-key"

Experimentar

É necessária uma chave de API para testar os pontos de extremidade.

Experimentar com:

Verificação de lotes

Verificar vários endereços de correio eletrónico ou domínios num único pedido (máximo de 100 itens).

Ponto final

POST /v1/verify/batch

Parâmetros

NomeTipoNecessárioDescrição
inputsarray of stringsSimConjunto de endereços de correio eletrónico ou domínios a verificar

Exemplos de códigos

curl -X POST "https://api.verify-email.app/v1/verify/batch" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: your-api-key" \
  -d '{
    "inputs": [
      "[email protected]",
      "[email protected]"
    ]
  }'

Experimentar

É necessária uma chave de API para testar os pontos de extremidade.

Experimente com domínios diferentes: