Sign up for email announcements to stay updated on the latest information about the GMB API.

Method: accounts.locations.verify

Starts the verification process for a location.

HTTP request

POST https://mybusiness.googleapis.com/v4/{name=accounts/*/locations/*}:verify

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Resource name of the location to verify.

Request body

The request body contains data with the following structure:

JSON representation
{
  "method": enum(VerificationMethod),
  "languageCode": string,
  "context": {
    object(ServiceBusinessContext)
  },

  // Union field RequestData can be only one of the following:
  "emailInput": {
    object(EmailInput)
  },
  "addressInput": {
    object(AddressInput)
  },
  "phoneInput": {
    object(PhoneInput)
  }
  // End of list of possible types for union field RequestData.
}
Fields
method

enum(VerificationMethod)

Verification method.

languageCode

string

The BCP 47 language code representing the language that is to be used for the verification process.

context

object(ServiceBusinessContext)

Extra context information for the verification of service businesses. Required for the locations whose business type is CUSTOMER_LOCATION_ONLY. For ADDRESS verification, the address will be used to send out postcard. For other methods, it should be the same as the one that is passed to locations.fetchVerificationOptions. INVALID_ARGUMENT will be thrown if it is set for other types of business locations.

Union field RequestData. User input data for specific method in addition to the display data. The data must match the requested method. Leave it empty if no data is needed. RequestData can be only one of the following:
emailInput

object(EmailInput)

The input for EMAIL method.

addressInput

object(AddressInput)

The input for ADDRESS method.

phoneInput

object(PhoneInput)

The input for PHONE_CALL/SMS method

Response body

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

Response message for Verifications.VerifyLocation.

JSON representation
{
  "verification": {
    object(Verification)
  }
}
Fields
verification

object(Verification)

The created verification request.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/plus.business.manage

For more information, see the OAuth 2.0 Overview.

EmailInput

Input for EMAIL verification.

JSON representation
{
  "emailAddress": string
}
Fields
emailAddress

string

email address where the PIN should be sent to.

An email address is accepted only if it is one of the addresses provided by locations.fetchVerificationOptions. If the EmailVerificationData has isUserNameEditable set to true, the client may specify a different user name (local-part) but must match the domain name.

AddressInput

Input for ADDRESS verification.

JSON representation
{
  "mailerContactName": string
}
Fields
mailerContactName

string

Contact name the mail should be sent to.

PhoneInput

Input for PHONE_CALL/SMS verification.

JSON representation
{
  "phoneNumber": string
}
Fields
phoneNumber

string

The phone number that should be called or be sent SMS to. It must be one of the phone numbers in the eligible options.