The Q&A 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.fetchVerificationOptions

Reports all eligible verification options for a location in a specific language.

HTTP request

POST https://mybusinessverifications.googleapis.com/v1/{location=locations/*}:fetchVerificationOptions

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
location

string

Required. The location to verify.

Request body

The request body contains data with the following structure:

JSON representation
{
  "languageCode": string,
  "context": {
    object (ServiceBusinessContext)
  }
}
Fields
languageCode

string

Required. The BCP 47 language code representing the language that is to be used for the verification process. Available options vary by language.

context

object (ServiceBusinessContext)

Optional. Extra context information for the verification of service businesses. Can only be applied to the locations whose business type is CUSTOMER_LOCATION_ONLY. Specifying an accurate address could enable more options. INVALID_ARGUMENT will be thrown if it is set for other business types of locations.

Response body

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

Response message for Verifications.FetchVerificationOptions.

JSON representation
{
  "options": [
    {
      object (VerificationOption)
    }
  ]
}
Fields
options[]

object (VerificationOption)

The available verification options.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.

VerificationOption

The verification option represents how to verify the location (indicated by verification method) and where the verification will be sent to (indicated by display data).

JSON representation
{
  "verificationMethod": enum (VerificationMethod),

  // Union field DisplayData can be only one of the following:
  "phoneNumber": string,
  "addressData": {
    object (AddressVerificationData)
  },
  "emailData": {
    object (EmailVerificationData)
  }
  // End of list of possible types for union field DisplayData.
}
Fields
verificationMethod

enum (VerificationMethod)

Method to verify the location.

Union field DisplayData. One of the display data. The data must match the method. Empty if the corresponding method doesn't have any display data. DisplayData can be only one of the following:
phoneNumber

string

Set only if the method is PHONE_CALL or SMS. Phone number that the PIN will be sent to.

addressData

object (AddressVerificationData)

Set only if the method is MAIL.

emailData

object (EmailVerificationData)

Set only if the method is EMAIL.

AddressVerificationData

Display data for verifications through postcard.

JSON representation
{
  "business": string,
  "address": {
    object (PostalAddress)
  },
  "expectedDeliveryDaysRegion": integer
}
Fields
business

string

Merchant's business name.

address

object (PostalAddress)

Address that a postcard can be sent to.

expectedDeliveryDaysRegion

integer

Expected number of days it takes to deliver a postcard to the address's region.

EmailVerificationData

Display data for verifications through email.

JSON representation
{
  "domain": string,
  "user": string,
  "isUserNameEditable": boolean
}
Fields
domain

string

Domain name in the email address. e.g. "gmail.com" in foo@gmail.com

user

string

User name in the email address. e.g. "foo" in foo@gmail.com

isUserNameEditable

boolean

Whether client is allowed to provide a different user name.