Method: accounts.requestphoneverification

Request verification code to start phone verification.

HTTP request

POST https://shoppingcontent.googleapis.com/content/v2.1/{merchantId}/accounts/{accountId}/requestphoneverification

Path parameters

Parameters
merchantId

string (int64 format)

Required. The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account.

accountId

string (int64 format)

Required. The ID of the account.

Request body

The request body contains data with the following structure:

JSON representation
{
  "phoneRegionCode": string,
  "phoneNumber": string,
  "phoneVerificationMethod": enum (PhoneVerificationMethod),
  "languageCode": string
}
Fields
phoneRegionCode

string

Required. Two letter country code for the phone number, for example CA for Canadian numbers. See the ISO 3166-1 alpha-2 officially assigned codes.

phoneNumber

string

Phone number to be verified.

phoneVerificationMethod

enum (PhoneVerificationMethod)

Verification method to receive verification code.

languageCode

string

Language code IETF BCP 47 syntax (for example, en-US). Language code is used to provide localized SMS and PHONE_CALL. Default language used is en-US if not provided.

Response body

If successful, the response body contains data with the following structure:

Response message for the accounts.requestphoneverification method.

JSON representation
{
  "verificationId": string
}
Fields
verificationId

string

The verification ID to use in subsequent calls to verifyphonenumber.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/content

For more information, see the OAuth 2.0 Overview.