Advance domain verification

Checks the required DNS records now and, once they all match, moves the domain toward verified. Safe to call repeatedly.

POST
/v1/email/domains/{id}/verify

Checks the required DNS records now and, once they all match, moves the domain toward verified. Safe to call repeatedly.

x-api-key<token>

In: header

Path Parameters

id*string
Match^dom_[0-9a-hjkmnp-tv-z]{16,24}$

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/email/domains/string/verify"
{  "domainId": "string",  "domain": "string",  "phase": "dns-setup",  "dns": {    "observed": true,    "total": 0,    "satisfied": 0,    "missing": 0,    "mismatch": 0,    "unknown": 0  },  "requirements": [    {      "key": "string",      "record": {        "type": "A",        "name": "string",        "value": "string",        "ttl": "string",        "description": "string",        "priority": 0      },      "status": "satisfied",      "evidence": [        {          "_tag": "PublicDns",          "resolver": "string",          "status": "satisfied",          "values": [            "string"          ],          "detail": "string",          "observedAt": "string"        }      ]    }  ],  "provider": {    "identity": "pending",    "dkim": "pending",    "mailFrom": "pending"  },  "operationId": "string",  "checkedAt": "string",  "nextCheckAt": "string",  "failure": {    "code": "string",    "message": "string",    "failedAt": "string"  },  "provisioning": {    "status": "none",    "generation": 0,    "revision": 0  },  "health": {    "actionOwner": "customer",    "action": "string",    "freshness": "current",    "observedAt": "string",    "staleAt": "string",    "nextRetryAt": "string",    "reason": "ready"  },  "sending": {    "actionOwner": "customer",    "action": "string",    "freshness": "current",    "observedAt": "string",    "staleAt": "string",    "nextRetryAt": "string",    "status": "ready",    "reason": "domain-not-ready"  },  "dmarc": {    "status": "valid",    "source": "direct",    "policyDomain": "string",    "policy": "none",    "subdomainPolicy": "none",    "effectivePolicy": "none",    "observedAt": "string",    "staleAt": "string",    "guidance": "string"  },  "rotation": {    "id": "string",    "domainId": "string",    "phase": "staged",    "selector": "string",    "record": {      "name": "string",      "type": "TXT",      "value": "string",      "ttl": "string"    },    "formerRecord": {      "name": "string",      "type": "TXT",      "value": "string"    },    "minimumRetainUntil": "string"  }}

Related documentation