Syntext DOCS
Get Started
API Verify Domain
POST/v1/projects/{projectId}/domains/{domainId}/verify

Verify Domain

Check if DNS records are correctly configured for a pending domain.

Path Parameters

The project ID (e.g., prj_abc123).

The domain ID (e.g., dom_xyz789).

Response

Returns the updated domain status.

Domain identifier.

The custom domain.

Domain status: pending, active, failed.

Verification check results.

Whether CNAME record is correct.

Whether TXT verification record is correct.

Error message if verification failed.

SSL certificate status.

Example

curl -X POST https://api.syntext.dev/v1/projects/prj_abc123/domains/dom_xyz789/verify \
-H "Authorization: Bearer stx_abc12345_..."
import { Syntext } from '@syntext/sdk'

const client = new Syntext('stx_abc12345_...')
const domain = await client.domains.verify('prj_abc123', 'dom_xyz789')
from syntext import Syntext

client = Syntext("stx_abc12345_...")
domain = client.domains.verify("prj_abc123", "dom_xyz789")

Success Response

{
  "data": {
    "id": "dom_xyz789",
    "domain": "docs.example.com",
    "status": "active",
    "verification": {
      "cname": true,
      "txt": true
    },
    "sslStatus": "active"
  }
}

Pending Response

{
  "data": {
    "id": "dom_xyz789",
    "domain": "docs.example.com",
    "status": "pending",
    "verification": {
      "cname": false,
      "txt": true,
      "error": "CNAME record not found. Expected: prj-abc123.syntext.dev"
    },
    "sslStatus": "pending"
  }
}

SSL certificates are automatically provisioned once DNS verification passes. This typically takes 1-2 minutes after DNS propagation.

Assistant
Responses are generated using AI and may contain mistakes.

Ask me anything about the documentation.

ESC