Domains

Verify domain DNS records

Check DNS records for the domain and update verification status. Rate limited to 1 request per minute. For automated setups, subscribe to the domain.verified webhook event instead of polling this endpoint.

post/domains/{id}/verification

Request

  • Base URL: https://shipmail.to/api/v1
  • URL: https://shipmail.to/api/v1/domains/{id}/verification
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://shipmail.to/api/auth/oauth2/authorize, token URL https://shipmail.to/api/auth/oauth2/token)

Headers

X-Shipmail-Organizationstring

OAuth access tokens only. The organization ID this request acts on. Required when the OAuth connection was approved for several organizations (400 validation_error without it); optional with one. An organization the connection was not approved for returns 403 authorization_error. Ignored for API keys, which belong to one organization.

Response

Verification result.

all_verifiedboolean required
outbound_verifiedboolean required
outbound_errorboolean required
existing_spfstring nullable required
suggested_spfstring nullable required
conflicting_mxstring[] required
dmarc_validboolean required

Whether a DMARC record exists and parses as a valid policy.

dmarc_exact_matchboolean required

Whether the published DMARC record exactly matches shipmail's recommended record.

dmarc_record_valuestring nullable required

The DMARC TXT record currently published for the domain, if any.

dmarc_managed_externallyboolean required

True if a non-shipmail DMARC record is already published for this domain.

Changes

No recorded changes to this operation across all 1 revision of this API.