Getting the site verification information

Returns information about the current state of site verification in Yandex.Webmaster.

Request format

GET https://api.webmaster.yandex.net/v4/user/{user-id}/hosts/{host-id}/verification

user-id

Type: int64. User ID. Required when calling all Yandex.Webmaster API resources. To get it, use the GET /v4/user method.

host-id

Type: host id (string). The site ID. To get it, use the GET /v4/user/{user-id}/hosts method.

Response format

Examples

{
  "verification_uin": "b01288afe67b1595",
  "verification_state": "NONE",
  "verification_type": "META_TAG",
  "latest_verification_time": "2016-01-01T00:00:00,000+0300",
  "fail_info": {
    "reason": "META_TAG_NOT_FOUND",
    "message": "explicit error message"
  },
  "applicable_verifiers": [
    "META_TAG", ...
  ]
}
<Data>
    <verification_uin>b01288afe67b1595</verification_uin>
    <verification_state>NONE</verification_state>
    <verification_type>META_TAG</verification_type>
    <latest_verification_time>2016-01-01T00:00:00,000+0300</latest_verification_time>
    <fail_info>
        <reason>META_TAG_NOT_FOUND</reason>
        <message>explicit error message</message>
    </fail_info>
    <applicable_verifier>META_TAG</applicable_verifier>
    ...
</Data>

Name

Required

Type

Description

verification_uin

Yes

string

Unique authorization code.

verification_state

Yes

string (ApiVerificationState)

The rights verification state.

verification_type

Yes

string (ApiVerificationType)

The type of rights verification.

latest_verification_time

Yes

datetime

The time of the last check in the yyyy-MM-ddTHH:mm:ss,sssZ format (if verification_state isn't NONE).

fail_info

Yes

Error description if the VERIFICATION_FAILED status is received.

reason

Yes

string (ApiVerificationFailReason)

The reason why verification failed.

message

Yes

string

Error description for users.

applicable_verifiers

Yes

string (ApiExplicitVerificationType )

The verification methods applied for the given site.

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 meta tag to the site's home page header.

PDD

No

Rights verification via Yandex.Mail for Domains.

TXT_FILE

No

Placing a text file in the site's root directory.

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 meta tag to the site's home page header.

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.

Reasons for refusal to verify site management rights (ApiVerificationFailReason)

Reason for refusal

Description

DELEGATION CANCELLED

Delegation of site management rights was canceled.

DNS_RECORD_NOT_FOUND

The specified DNS record doesn't exist.

META_TAG_NOT_FOUND

The meta tag is missing in the site's home page header.

PDD_VERIFICATION_CANCELLED

Verification of site management rights via Yandex.Mail for Domain isn't allowed for this site.

WRONG_HTML_PAGE_CONTENT

The HTML file content is set incorrectly.

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."
}
<Data>     
    <error_code>INVALID_USER_ID</error_code>     
    <available_user_id>1</available_user_id>     
    <error_message>Invalid user id. {user_id} should be used.</error_message> 
</Data>

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"
}
<Data>     
    <error_code>HOST_NOT_FOUND</error_code>     
    <host_id>http:ya.ru:80</host_id>     
    <error_message>explicit error message</error_message> 
</Data>