Request domain verification

Sends a one-time passcode to an address at the domain to begin verifying ownership. The domain must not be a public email provider and must not already be verified by another organization.

POST /api/v1/org/domains/verify

Error

A valid request URL is required to generate request examples

200

{
  "results": {
    "isVerified": true,
    "domain": "<string>",
    "otp": {
      "numberOfAttempts": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "isMaxAttempts": true,
      "isExpired": true,
      "expiresAt": "2023-11-07T05:31:56Z"
    }
  }
}

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

200

application/json

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.

Show child attributes

status · enum<string> · required

Available options: ok