The Verifications API and Business Information API is now launched! Migration work is required. Please see our deprecation schedule for more information related to deprecated endpoints. You may also sign up for our mailing list to receive updates.

Method: locations.verify

Starts the verification process for a location.

HTTP request

POST https://mybusinessverifications.googleapis.com/v1/{name=locations/*}:verify

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. 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:
  "emailAddress": string,
  "mailerContact": string,
  "phoneNumber": string,
  "token": {
    object (VerificationToken)
  }
  // End of list of possible types for union field RequestData.
}
Fields
method

enum (VerificationMethod)

Required. Verification method.

languageCode

string

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

context

object (ServiceBusinessContext)

Optional. Extra context information for the verification of service businesses. It is only 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 GetVerificationOptions. 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:
emailAddress

string

Optional. The input for EMAIL method. 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] [google.mybusiness-verifications.v1.VerificationOption.EmailVerificationData] has isUserNameEditable set to true, the client may specify a different user name (local-part) but must match the domain name.

mailerContact

string

Optional. The input for ADDRESS method. Contact name the mail should be sent to.

phoneNumber

string

Optional. The input for PHONE_CALL/SMS method The phone number that should be called or be sent SMS to. It must be one of the phone numbers in the eligible options.

token

object (VerificationToken)

Optional. The input for VETTED_PARTNER method available to select partners. The input is not needed for a vetted account. Token that is associated to the location. Token that is associated to the location.

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/business.manage

For more information, see the OAuth 2.0 Overview.