Check Account Domain

This document contains details for the /api/v1/account/{accountUuid}/domain/{domainUuid}/check endpoint, including check limits and a response example.

Use this endpoint to check account domain ownership. The domain is verified with the verifyInfo and verifyMethod data. You can run this check once per minute. Only unverified domains can be checked.

Endpoint
Method	PATCH
Request URL	/api/v1/account/{accountUuid}/domain/{domainUuid}/check
Headers
Authorization *	Bearer TOKEN
Content-Type	application/json
Request
accountUuid *	Target account UUID
domainUuid *	Account domain UUID

This endpoint does not require a request body.

Request example

PATCH https://api.platform_address_here/api/v1/account/3fa85f64-5717-4562-b3fc-2c963f66afa6/domain/3fa85f64-5717-4562-b3fc-2c963f66afa6/check
Authorization: Bearer {token}
Content-Type: application/json

Response example

The response is returned only if the domain is unverified and the verification period has not expired yet. Domains that become verified will have the INACTIVE status.

{
    "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "accountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "domain": "google.com",
    "status": "INACTIVE",
    "verifyInfo" : {
        "domain": "_whitedoc-verify",
        "value": "abc123"
    },
    "verifyMethod": "DNS_TXT_RECORD"
}

Response status codes

Code	Description
200	Success
400	Bad request
401	Not authorized
403	Forbidden
404	Domain not found
429	Too many requests

Related topics

• Verify Account Domain

• Confirm Account Domain Verification

• Activate/Deactivate Account Domain