Get domain verification status

Retrieve the verification status and DNS records for a custom domain configured in the Vercel trust portal project

GET /v1/trust-portal/domain/status

Get domain verification status

cURL

curl --request GET \
  --url http://localhost:3333/v1/trust-portal/domain/status \
  --header 'X-API-Key: <api-key>'

200

{
  "domain": "<string>",
  "verified": true,
  "verification": [
    {
      "type": "<string>",
      "domain": "<string>",
      "value": "<string>",
      "reason": "<string>"
    }
  ],
  "cnameTarget": "3a69a5bb27875189.vercel-dns-016.com",
  "misconfigured": {}
}

Authorizations

X-API-Key · string · header · required

API key for authentication

Query Parameters

domain · string · required

The domain name to check status for

Example:

"portal.example.com"

Response

200

application/json

Domain status retrieved successfully

domain · string · required

The domain name

verified · boolean · required

Whether the domain is verified

verification · object[]

Verification records for the domain

Show child attributes

cnameTarget · string

The recommended CNAME target for this domain from Vercel

Example:

"3a69a5bb27875189.vercel-dns-016.com"

misconfigured · object

Whether Vercel's /v6/domains/{d}/config call reports the domain as misconfigured. Null when Vercel could not be reached.