Skip to main content
GET
/
knowledge
/
verify
Verify custom domain DNS configuration
curl --request GET \
  --url https://api.getfernand.com/knowledge/verify \
  --header 'X-API-Key: <api-key>'
{
  "status": "verified",
  "verification": {
    "type": "CNAME",
    "name": "help.piedpiper.com",
    "value": "help.getfernand.com."
  }
}
Checks if the custom domain’s DNS records are properly configured to point to the knowledge base hosting infrastructure. Returns the current verification status and the required DNS configuration records. If verification succeeds, the custom domain is marked as valid and can be used to access the knowledge base. This endpoint is rate-limited to 5 requests per minute to prevent abuse.

Authorizations

​
X-API-Key
string
header
required

Authenticate your account by including your secret key in API requests. You can manage your API keys in the Dashboard.

Authentication to the API is performed by using the HTTP Header X-API-Key.

Response

Domain verification status retrieved successfully.

​
status
enum<string>

Current verification status of the custom domain.

Available options:
verified,
pending
Example:

"verified"

​
verification
object

DNS configuration records required for domain verification.