Skip to main content
POST
/
api
/
v1
/
org
/
domains
/
verify
Error
A valid request URL is required to generate request examples
{
  "results": {
    "isVerified": true,
    "domain": "<string>",
    "otp": {
      "numberOfAttempts": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "isMaxAttempts": true,
      "isExpired": true,
      "expiresAt": "2023-11-07T05:31:56Z"
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.lightdash.com/llms.txt

Use this file to discover all available pages before exploring further.

Body

application/json

Request to verify a domain. challengeEmail must be an address at domain; a one-time passcode is sent there and confirmed via {@link ConfirmDomainVerification}.

ā€‹
challengeEmail
string
required
ā€‹
domain
string
required

Response

Ok

ā€‹
results
object
required

Verification status of a single domain. Mirrors {@link EmailStatusExpiring}: otp is present only while a pending one-time passcode challenge exists.

ā€‹
status
enum<string>
required
Available options:
ok