lumail.verify

SDK 2.2.0 · API v2 · POST /api/v2/verify

MethodPOST

/api/v2/verify

Request Examples

import { Lumail } from "lumail";

const lumail = new Lumail({ apiKey: process.env.LUMAIL_API_KEY });
const { data, error } = await lumail.verify("[email protected]");
if (error) {
  throw error;
}
if (!data.accept) {
  throw data.issues[0];
}
console.log(data.result, data.suggestion);

Response Examples

{
  "object": "email_verification",
  "id": "vr_abc123",
  "email": "[email protected]",
  "result": "risky",
  "accept": true,
  "status": "completed",
  "score": 80,
  "suggestion": null,
  "traits": {
    "domain_category": "custom_domain",
    "disposable": false,
    "free_provider": false,
    "privacy_alias": false,
    "role_based": false,
    "suspicious_domain": false
  },
  "issues": [],
  "retry_at": null,
  "cache_hit": false
}

lumail.verify(email | { email: string }): Promise<LumailResult<EmailVerification>>

const { data, error } = await lumail.verify("[email protected]");

if (error) throw error;
if (!data.accept) {
  console.log(data.issues[0]?.code);
}
const next = data.suggestion ?? data.email;

Body Parameters

Name	Type	Description
`email`	string	Required. Address to check. Also accepted as a bare string.

Response Fields

Field	Type	Description
`object`	`"email_verification"`	Resource type.
`id`	string	Tenant-owned `verify_result` id.
`email`	string	Normalized address that was checked.
`result`	string	`deliverable`, `risky`, `undeliverable`, or `unknown`.
`accept`	boolean	Policy decision. Can be `true` when quota is exhausted.
`status`	string	`completed`, `skipped`, or `failed`.
`score`	integer \| null	0–100 deliverability confidence.
`suggestion`	string \| null	Better address when the domain looks like a typo.
`traits`	object	Domain category plus disposable, free-provider, privacy-alias, role-based, and suspicious-domain booleans.
`issues`	object[]	Errors and warnings only. Empty when the address is clean.
`quota`	object	`{ limit, used, remaining, resets_at }` for the UTC month.
`retry_at`	string \| null	ISO timestamp when a retryable check should be tried again.
`cache_hit`	boolean	`true` when the result was served from cache.

Field details: API reference.

Legacy lumail.emails.verify() still talks to /api/v2/emails/verify.

Previouslumail.emails Nextlumail.emails.send