Run DNS verification for a custom domain owned by the authenticated DID and update its verified status.
Input
application/jsondomain
string
Required
Custom domain FQDN to verify (for example, example.com).
maxLength: 253 bytesminLength: 3 bytesOutput
application/jsoncnameFound
string
Optional
The CNAME target observed during verification, if any.
domain
string
Required
No description available.
error
string
Optional
Human-readable reason verification did not pass (when not verified).
kind
string
Required
No description available.
status
string
Required
No description available.
txtFound
string
Optional
The TXT value observed during verification, if any.
verified
boolean
Required
No description available.
warning
string
Optional
Non-fatal advisory (for example, CNAME could not be confirmed due to flattening).
Errors
AuthenticationRequired
InvalidDomain
NotFound
Try It
Requests are sent directly from your browser. Some servers may block requests due to CORS.
View raw schema
{
"type": "procedure",
"input": {
"schema": {
"type": "object",
"required": [
"domain"
],
"properties": {
"domain": {
"type": "string",
"maxLength": 253,
"minLength": 3,
"description": "Custom domain FQDN to verify (for example, example.com)."
}
}
},
"encoding": "application/json"
},
"errors": [
{
"name": "AuthenticationRequired"
},
{
"name": "InvalidDomain"
},
{
"name": "NotFound"
}
],
"output": {
"schema": {
"type": "object",
"required": [
"domain",
"kind",
"status",
"verified"
],
"properties": {
"kind": {
"enum": [
"custom"
],
"type": "string"
},
"error": {
"type": "string",
"description": "Human-readable reason verification did not pass (when not verified)."
},
"domain": {
"type": "string"
},
"status": {
"enum": [
"pendingVerification",
"verified"
],
"type": "string"
},
"warning": {
"type": "string",
"description": "Non-fatal advisory (for example, CNAME could not be confirmed due to flattening)."
},
"txtFound": {
"type": "string",
"description": "The TXT value observed during verification, if any."
},
"verified": {
"type": "boolean"
},
"cnameFound": {
"type": "string",
"description": "The CNAME target observed during verification, if any."
}
}
},
"encoding": "application/json"
},
"description": "Run DNS verification for a custom domain owned by the authenticated DID and update its verified status."
}