Referencia API

Documentación de la API

La API de NeuraMail te permite verificar direcciones de email y consultar tu cuenta de forma programática. Todos los endpoints devuelven JSON. La autenticación es mediante una API key por usuario.

URL base:
https://neuramail.cl

Autenticación

Incluye tu API key en cada solicitud usando la cabecera Authorization. Genera o rota tu clave desde la página API Keys del panel.

Cabecera de solicitud
Authorization: Bearer nm_live_xxxxxxxxxxxxxxxxxxxx

Mantén tu API key en secreto. Nunca la expongas en código del lado del cliente o repositorios públicos. Rótala inmediatamente si sospechas que ha sido comprometida.

GET/api/v1/verify

Verifica una sola dirección de email. Devuelve estado, sub-estado, información MX y si el resultado fue cacheado.

Parámetros

email
stringrequeridoLa dirección de email a verificar.

Respuesta

200 OK · application/json
{
  "data": {
    "email": "user@example.com",
    "status": "valid",
    "sub_status": null,
    "is_catchall": false,
    "mx_found": true,
    "credits_used": 1,
    "cached": false
  }
}
POST/api/v1/verify/batch

Verifica hasta 1.000 direcciones de email en una sola solicitud.

Parámetros

emails
string[]requeridoArray de direcciones de email (máx. 1.000).

Respuesta

200 OK · application/json
{
  "data": {
    "results": [
      { "email": "a@example.com", "status": "valid",   "cached": true  },
      { "email": "b@fake.io",     "status": "invalid", "sub_status": "disposable" }
    ],
    "total": 2,
    "credits_used": 1,
    "credits_cached": 1
  }
}
GET/api/v1/credits

Devuelve el saldo de créditos actual y el historial de transacciones recientes del usuario autenticado.

Respuesta

200 OK · application/json
{
  "data": {
    "balance": 4820,
    "transactions": [
      { "amount": -1, "type": "verification", "created_at": "2025-03-14T10:00:00Z" }
    ]
  }
}

Estados de respuesta

validEl buzón existe y es probable que reciba correo.
invalidEl buzón no existe o el dominio no funciona.
riskyCuenta de rol, recientemente desactivada o resultado de baja confianza.
catch_allEl servidor acepta todo el correo; no se puede confirmar el buzón individual.
unknownEl servidor agotó el tiempo de espera o bloqueó el handshake de verificación.

Sub-estados

disposablerole_basedspam_trapmx_not_foundsmtp_errorbouncesyntax_error

Códigos de error

400Bad RequestParámetros faltantes o inválidos.
401No autorizadoAPI key faltante o inválida.
402Créditos insuficientesEl saldo de tu cuenta es muy bajo.
422Entidad no procesableLa dirección de email falló la validación de sintaxis.
429Demasiadas solicitudesLímite de velocidad excedido. Reintenta después del valor del encabezado Retry-After.
500Error del servidorError inesperado. Contacta soporte si persiste.

¿Listo para integrar?

Crea una cuenta gratuita y obtén tu API key en 60 segundos.