Verify Domain

Check DNS and mark the domain verified when records match.

MethodPOST

/api/v2/domains/:domain/verify

Request Examples

import { Lumail } from "lumail";

const lumail = new Lumail({ apiKey: process.env.LUMAIL_API_KEY });
const { data, error } = await lumail.domains.verify("mail.example.com");
if (error) {
  throw error;
}
console.log(data.status);

Response Examples

{
  "status": "VERIFIED",
  "isVerified": true,
  "verificationStatus": "Success",
  "dkimVerificationStatus": "Success",
  "mailFromStatus": "Success",
  "dnsRecords": []
}

Re-checks DNS and updates verification status. :domain is a MailDomain id or hostname. Permission: domains.

Path Parameters

Name	Type	Description
`domain`	string	Required. MailDomain id or hostname.

Response Fields

Field	Type	Description
`status`	string	Lumail domain status after the check.
`isVerified`	boolean	`true` when SES identity is verified.
`verificationStatus`	string	SES identity verification status.
`dkimVerificationStatus`	string	DKIM status.
`mailFromStatus`	string	MAIL FROM status.
`dnsRecords`	array	Per-record DNS status.
`id`	string	MailDomain id when present.

Errors

Status	`name`	When
401	`missing_api_key`	Missing or invalid bearer token
403	`missing_permission`	Token lacks the `domains` permission
404	`not_found`	Unknown id or hostname

PreviousGet Domain NextCampaigns

Path Parameters

Response Fields

Errors

Related