Starting the rights verification process

Starts the procedure for verifying site management rights.

Note. Before using this request, you need to get a unique confirmation code and choose a method for verifying rights. For more information, see the example.
  1. Request format
  2. Response format
  3. Response codes

Request format

Send a POST request to the rights verification resource. You must specify the verification method in the GET parameter. The request body can pass any data, or none at all.

POST https://api.webmaster.yandex.net/v4/user/{user-id}/hosts/{host-id}/verification/?verification_type={verification_type}

Path parameters

Name Required Type Default value Description
user-id Yes int64 User ID. Required when calling all Yandex.Webmaster API resources. To get it, use the GET /user method.
host-id Yes host id The site ID. To get it, use the GET /user/{user-id}/hosts method.

Query parameters

Name Required Type Description
verification_type Yes ApiExplicitVerificationType Rights verification method.

Explicit methods of rights verification (ApiExplicitVerificationType)

Verification method Whether a verification check can be requested Description
DNS Yes Verifying rights with the DNS record.
HTML_FILE Yes Placing an HTML file in the site's root directory.
META_TAG Yes Adding a metatag to the header on the site's main page.
WHOIS Yes

Verifying data with information provided by the WHOIS service.

This method works only for second-level domains (such as example.com).

Response format

Example

HTTP/1.1 200 OK
{
  "verification_uin": "b01288afe67b1595",
  "verification_state": "IN_PROGRESS",
  "verification_type": "HTML_FILE",
  "applicable_verifiers": [
    "HTML_FILE"
  ]
}
Name Required Type Description
verification_uin Yes string Confirmation code.
verification_state Yes ApiVerificationState The rights verification state.
verification_type Yes ApiVerificationType The type of rights verification.
applicable_verifiers Yes ApiExplicitVerificationType The verification methods applied for the given site.

The status of verifying the right to manage the site (ApiVerificationState)

Status Description
NONE Verification wasn't completed and rights are not confirmed.
VERIFIED The rights are verified.
IN_PROGRESS The rights verification is in progress.
VERIFICATION_FAILED Verification was performed but rights are not confirmed.
INTERNAL_ERROR An unexpected error occurred when verifying the rights.

Rights verification methods (ApiVerificationType)

Verification method Whether a verification check can be requested Description
AUTO No Automatic rights verification (deprecated; only for *.narod.ru sites).
DELEGATED No Rights were delegated.
DNS Yes Verifying rights with the DNS record.
HTML_FILE Yes Placing an HTML file in the site's root directory.
META_TAG Yes Adding a metatag to the header on the site's main page.
PDD No Rights verification via Yandex.Mail for Domains.
TXT_FILE No Placing a text file in the site's root directory.
WHOIS Yes

Verifying data with information provided by the WHOIS service.

This method works only for second-level domains (such as example.com).

Explicit methods of rights verification (ApiExplicitVerificationType)

Verification method Whether a verification check can be requested Description
DNS Yes Verifying rights with the DNS record.
HTML_FILE Yes Placing an HTML file in the site's root directory.
META_TAG Yes Adding a metatag to the header on the site's main page.
WHOIS Yes

Verifying data with information provided by the WHOIS service.

This method works only for second-level domains (such as example.com).

Response codes

To view the response structure in detail, click the reason.

Code Reason Description
200 OK
403

INVALID_USER_ID

The ID of the user who issued the token differs from the one specified in the request. In the examples below, {user_id} shows the correct uid of the OAuth token owner.

{
  "error_code": "INVALID_USER_ID",
  "available_user_id": 1,
  "error_message": "Invalid user id. {user_id} should be used."
}
404 HOST_NOT_FOUND

The site is not in the list of the user's sites.

{
  "error_code": "HOST_NOT_FOUND",
  "host_id": "http:ya.ru:80",
  "error_message": "explicit error message"
}
409 VERIFICATION_ALREADY_IN_PROGRESS
The rights verification process is in progress.
{
  "error_code": "VERIFICATION_ALREADY_IN_PROGRESS",
  "verification_type": "META_TAG",
  "error_message": "some string"
}