Skip to content

Verify mandatory DNS records

POST
/api/domains/{domain}/verify-mandatory
curl --request POST \
--url https://smtp-app.kirim.email/api/domains/example.com/verify-mandatory \
--header 'Authorization: Basic <credentials>'

Verify DKIM and SPF DNS records for a domain. MX record validation is optional.

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.

DNS verification completed

Media typeapplication/json
object
records

DNS record validation results

object
dkim

Whether DKIM record is valid and properly configured

boolean
spf

Whether SPF record is valid and properly configured

boolean
mx

Whether MX record is valid and properly configured

boolean
Example
{
"records": {
"dkim": true,
"spf": true,
"mx": true
}
}

Unauthorized

Media typeapplication/json
object
error

Error type indicating authentication failure

string
message

Human-readable error message explaining the authentication issue

string
Example
{
"error": "Unauthorized",
"message": "Authorization header is required"
}

Domain not found

Media typeapplication/json
object
success
boolean
message
string
Example
{
"success": false,
"message": "Domain not found"
}

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

Media typeapplication/json
object
success
boolean
message
string
Example
{
"success": false,
"message": "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

Media typeapplication/json
object
success

Indicates the request failed due to a server error

boolean
message

Human-readable error message describing the server error

string
Example
{
"success": false,
"message": "An error occurred while processing the request."
}