ReferenceOrganizations
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
Authentication: personal access token. The spec defines an api_key security
scheme — send an Authorization: ApiKey <your-personal-access-token> header
(value format: ApiKey <your key>). A session_cookie scheme (connect.sid)
exists for browser sessions. Operations in this spec declare security: [], an
artifact of the upstream spec generator — authentication is still enforced by the
server.
Request body
{
"challengeEmail": "string",
"domain": "string"
}Responses
200 — Ok
{
"results": {
"otp": {
"numberOfAttempts": 0,
"createdAt": "2024-01-01T00:00:00.000Z",
"isMaxAttempts": true,
"isExpired": true,
"expiresAt": "2024-01-01T00:00:00.000Z"
},
"isVerified": true,
"domain": "string"
},
"status": "ok"
}default — Error
{
"error": {
"data": "string",
"message": "string",
"name": "string",
"statusCode": 0
},
"status": "error"
}