Skip to content

Verify authentication domain DNS records

POST
/api/domains/{domain}/verify-auth-domain

Verify DKIM, SPF, and MX DNS records for authentication domain

domain
required
string
Example
example.com

Domain name that must be owned by the authenticated user. The domain must be verified and properly configured for email sending.

Auth domain DNS verification completed

object
records

Authentication domain DNS record validation results

object
auth_dkim

Whether authentication domain DKIM record is valid and properly configured

boolean
Example
true
auth_spf

Whether authentication domain SPF record is valid and properly configured

boolean
Example
true
auth_mx

Whether authentication domain MX record is valid and properly configured

boolean
Example
true

Unauthorized

object
error

Error type indicating authentication failure

string
Example
Unauthorized
message

Human-readable error message explaining the authentication issue

string
Example
Authorization header is required

Domain not found

object
success
boolean
message
string
Example
Domain not found

Validation Error

object
success

Indicates the request failed due to validation errors

boolean
message

Human-readable error message

string
Example
Validation failed.
errors

Field-specific validation error messages organized by field name

object

Too Many Requests - Rate limit exceeded. Retry after the specified time.

object
success
boolean
message
string
Example
Too many attempts. Please try again later.
Retry-After
integer

Seconds until rate limit resets

X-RateLimit-Limit
integer

Maximum requests per minute

X-RateLimit-Remaining
integer

Remaining requests in current window

Server Error

object
success

Indicates the request failed due to a server error

boolean
message

Human-readable error message describing the server error

string
Example
An error occurred while processing the request.