Skip to main content
POST
Verify a domain
Looks up the TXT record and marks the domain verified on a match. DNS changes can take time to propagate, so retry if it fails at first. Related guide: User provisioning: SSO and identity. Looks up the DNS TXT record and marks the domain verified when it matches.
Availability: Cloud · Enterprise (self-hosted). Not available on the Community edition: a self-hosted deployment needs ENTERPRISE_ENABLED=true, otherwise the endpoint answers 403 with error.type: "enterprise_license_required".

Authorizations

Authorization
string
header
required

A workspace API key (oc_…) or organization API key (oc_org_…). Workspace-scoped endpoints called with an organization key also need X-Workspace-Id.

Path Parameters

domainId
string
required

Response

The verified domain

id
string
domain
string
verificationToken
string

Publish this as a DNS TXT record on the domain, then call verify.

verifiedAt
string<date-time> | null
createdAt
string<date-time>