Google Business Profile Business Profile Mybusinessverifications Locations API
The Business Profile Mybusinessverifications Locations API from Google Business Profile — 5 operation(s) for business profile mybusinessverifications locations.
The Business Profile Mybusinessverifications Locations API from Google Business Profile — 5 operation(s) for business profile mybusinessverifications locations.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/google-business-profile:google-business-profile-mybusinessverifications-locations-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.1.0
info:
title: My Business Verifications API Locations API
version: v1
description: Generated from Google's published Discovery document for My Business Verifications API (mybusinessverifications
v1, revision 20261110). 5 operation(s).
contact:
name: Google
url: https://developers.google.com/
termsOfService: https://developers.google.com/terms
externalDocs:
url: https://developers.google.com/my-business/
servers:
- url: https://mybusinessverifications.googleapis.com
paths:
/v1/locations/{locationsId}:fetchVerificationOptions:
post:
operationId: mybusinessverifications.locations.fetchVerificationOptions
summary: Fetch verification options locations
description: Reports all eligible verification options for a location in a specific language.
parameters:
- name: locationsId
in: path
required: true
description: Resource name segment (locationsId).
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/FetchVerificationOptionsRequest'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/FetchVerificationOptionsResponse'
4XX:
content: &id001
application/json:
schema:
$ref: '#/components/schemas/GoogleRpcError'
description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
default:
content: *id001
description: Error response (google.rpc.Status)
security:
- apiKey: []
tags:
- Locations
/v1/locations/{locationsId}:verify:
post:
operationId: mybusinessverifications.locations.verify
summary: Verify locations
description: Starts the verification process for a location.
parameters:
- name: locationsId
in: path
required: true
description: Resource name segment (locationsId).
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/VerifyLocationRequest'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/VerifyLocationResponse'
4XX:
content: &id002
application/json:
schema:
$ref: '#/components/schemas/GoogleRpcError'
description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
default:
content: *id002
description: Error response (google.rpc.Status)
security:
- apiKey: []
tags:
- Locations
/v1/locations/{locationsId}/VoiceOfMerchantState:
get:
operationId: mybusinessverifications.locations.getVoiceOfMerchantState
summary: Get voice of merchant state locations
description: Gets the VoiceOfMerchant state.
parameters:
- name: locationsId
in: path
required: true
description: Resource name segment (locationsId).
schema:
type: string
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/VoiceOfMerchantState'
4XX:
content: &id003
application/json:
schema:
$ref: '#/components/schemas/GoogleRpcError'
description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
default:
content: *id003
description: Error response (google.rpc.Status)
security:
- apiKey: []
tags:
- Locations
/v1/locations/{locationsId}/verifications:
get:
operationId: mybusinessverifications.locations.verifications.list
summary: List verifications
description: List verifications of a location, ordered by create time.
parameters:
- name: locationsId
in: path
required: true
description: Resource name segment (locationsId).
schema:
type: string
- name: pageSize
in: query
required: false
description: How many verification to include per page. Minimum is 1, and the default and maximum page size is 100.
schema:
format: int32
type: integer
- name: pageToken
in: query
required: false
description: If specified, returns the next page of verifications.
schema:
type: string
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/ListVerificationsResponse'
4XX:
content: &id004
application/json:
schema:
$ref: '#/components/schemas/GoogleRpcError'
description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
default:
content: *id004
description: Error response (google.rpc.Status)
security:
- apiKey: []
tags:
- Locations
/v1/locations/{locationsId}/verifications/{verificationsId}:complete:
post:
operationId: mybusinessverifications.locations.verifications.complete
summary: Complete verifications
description: Completes a `PENDING` verification. It is only necessary for non `AUTO` verification methods. `AUTO` verification
request is instantly `VERIFIED` upon creation.
parameters:
- name: locationsId
in: path
required: true
description: Resource name segment (locationsId).
schema:
type: string
- name: verificationsId
in: path
required: true
description: Resource name segment (verificationsId).
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CompleteVerificationRequest'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/CompleteVerificationResponse'
4XX:
content: &id005
application/json:
schema:
$ref: '#/components/schemas/GoogleRpcError'
description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
default:
content: *id005
description: Error response (google.rpc.Status)
security:
- apiKey: []
tags:
- Locations
components:
securitySchemes:
apiKey:
type: apiKey
in: query
name: key
description: API key; accepted by methods that do not need user data.
schemas:
AddressVerificationData:
description: Display data for verifications through postcard.
properties:
expectedDeliveryDaysRegion:
format: int32
description: Expected number of days it takes to deliver a postcard to the address's region.
type: integer
address:
$ref: '#/components/schemas/PostalAddress'
description: Address that a postcard can be sent to.
business:
description: Merchant's business name.
type: string
type: object
CompleteVerificationRequest:
type: object
properties:
pin:
type: string
description: Required. PIN code received by the merchant to complete the verification.
description: Request message for Verifications.CompleteVerificationAction.
CompleteVerificationResponse:
description: Response message for Verifications.CompleteVerificationAction.
type: object
properties:
verification:
$ref: '#/components/schemas/Verification'
description: The completed verification.
ComplyWithGuidelines:
description: Indicates that the location fails to comply with our [guidelines](https://support.google.com/business/answer/3038177).
properties:
recommendationReason:
type: string
enum:
- RECOMMENDATION_REASON_UNSPECIFIED
- BUSINESS_LOCATION_SUSPENDED
- BUSINESS_LOCATION_DISABLED
description: The reason why the location is being recommended to comply with guidelines.
type: object
EmailVerificationData:
properties:
isUserNameEditable:
type: boolean
description: Whether client is allowed to provide a different user name.
domain:
description: Domain name in the email address. e.g. "gmail.com" in foo@gmail.com
type: string
user:
description: User name in the email address. e.g. "foo" in foo@gmail.com
type: string
type: object
description: Display data for verifications through email.
FetchVerificationOptionsRequest:
description: Request message for Verifications.FetchVerificationOptions.
type: object
properties:
languageCode:
type: string
description: Required. The BCP 47 language code representing the language that is to be used for the verification
process. Available options vary by language.
context:
$ref: '#/components/schemas/ServiceBusinessContext'
description: 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.
FetchVerificationOptionsResponse:
properties:
options:
type: array
items:
$ref: '#/components/schemas/VerificationOption'
description: The available verification options.
type: object
description: Response message for Verifications.FetchVerificationOptions.
GoogleRpcError:
type: object
description: The error envelope every Google API returns.
properties:
error:
type: object
properties:
code:
type: integer
message:
type: string
status:
type: string
details:
type: array
items:
type: object
ListVerificationsResponse:
properties:
verifications:
description: List of the verifications.
items:
$ref: '#/components/schemas/Verification'
type: array
nextPageToken:
type: string
description: If the number of verifications exceeded the requested page size, this field will be populated with
a token to fetch the next page of verification on a subsequent call. If there are no more attributes, this field
will not be present in the response.
description: Response message for Verifications.ListVerifications.
type: object
PostalAddress:
description: 'Represents a postal address, such as for postal delivery or payments addresses. With a postal address,
a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical
locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing
existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready
address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements
for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema,
see: https://support.google.com/business/answer/6397478.'
type: object
properties:
organization:
description: Optional. The name of the organization at the address.
type: string
languageCode:
description: 'Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language
of the input form or is expected to match one of the languages used in the address'' country/region, or their
transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness
of the data and will never affect any validation or other non-formatting related operations. If this value is
not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja",
"ja-Latn", "en".'
type: string
addressLines:
type: array
description: Unstructured address lines describing the lower levels of an address. Because values in `address_lines`
do not have type information and may sometimes contain multiple values in a single field (for example, "Austin,
TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for
the country or region of the address. In places where this can vary (for example, Japan), `address_language` is
used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large).
In this way, the most specific line of an address can be selected based on the language. The minimum permitted
structural representation of an address consists of a `region_code` with all remaining information placed in the
`address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic
reasoning could be made about any of the address components until it was at least partially resolved. Creating
an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle
completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative
areas).
items:
type: string
administrativeArea:
description: Optional. Highest administrative subdivision which is used for postal addresses of a country or region.
For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and
not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative
area in postal addresses. For example, in Switzerland, this should be left unpopulated.
type: string
sublocality:
description: Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
type: string
sortingCode:
description: Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is
used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or
just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office
indicator" (Côte d'Ivoire).
type: string
regionCode:
type: string
description: 'Required. CLDR region code of the country/region of the address. This is never inferred and it is
up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html
for details. Example: "CH" for Switzerland.'
postalCode:
type: string
description: Optional. Postal code of the address. Not all countries use or require postal codes to be present,
but where they are used, they may trigger additional validation with other parts of the address (for example,
state or zip code validation in the United States).
recipients:
description: Optional. The recipient at the address. This field may, under certain circumstances, contain multiline
information. For example, it might contain "care of" information.
type: array
items:
type: string
revision:
type: integer
description: The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All
new revisions **must** be backward compatible with old revisions.
format: int32
locality:
type: string
description: 'Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune,
UK post town. In regions of the world where localities are not well defined or do not fit into this structure
well, leave `locality` empty and use `address_lines`.'
ResolveOwnershipConflict:
properties: {}
description: Indicates that the location duplicates another location that is in good standing.
type: object
ServiceBusinessContext:
type: object
properties:
address:
$ref: '#/components/schemas/PostalAddress'
description: The verification address of the location. It is used to either enable more verification options or
send a postcard.
description: Additional data for service business verification.
Verification:
type: object
properties:
createTime:
type: string
format: google-datetime
description: The timestamp when the verification is requested.
method:
enum:
- VERIFICATION_METHOD_UNSPECIFIED
- ADDRESS
- EMAIL
- PHONE_CALL
- SMS
- AUTO
- TRUSTED_PARTNER
type: string
description: The method of the verification.
name:
description: Resource name of the verification.
type: string
announcement:
description: Optional. Response announcement set only if the method is VETTED_PARTNER.
type: string
state:
enum:
- STATE_UNSPECIFIED
- PENDING
- COMPLETED
- FAILED
description: The state of the verification.
type: string
description: A verification represents a verification attempt on a location.
VerificationOption:
properties:
announcement:
description: Set only if the method is VETTED_PARTNER.
type: string
phoneNumber:
description: Set only if the method is PHONE_CALL or SMS. Phone number that the PIN will be sent to.
type: string
emailData:
$ref: '#/components/schemas/EmailVerificationData'
description: Set only if the method is EMAIL.
addressData:
$ref: '#/components/schemas/AddressVerificationData'
description: Set only if the method is MAIL.
verificationMethod:
description: Method to verify the location.
type: string
enum:
- VERIFICATION_METHOD_UNSPECIFIED
- ADDRESS
- EMAIL
- PHONE_CALL
- SMS
- AUTO
- TRUSTED_PARTNER
description: 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).
type: object
VerificationToken:
description: Token generated by a vetted [partner](https://support.google.com/business/answer/7674102).
type: object
properties:
tokenString:
type: string
description: The token string.
Verify:
description: Indicates that the location requires verification. Contains information about the current verification
actions performed on the location.
type: object
properties:
hasPendingVerification:
type: boolean
description: Indicates whether a verification process has already started, and can be completed by the location.
VerifyLocationRequest:
properties:
languageCode:
type: string
description: Optional. The BCP 47 language code representing the language that is to be used for the verification
process.
token:
$ref: '#/components/schemas/VerificationToken'
description: Optional. The input for VETTED_PARTNER method available to select [partners.](https://support.google.com/business/answer/7674102)
The input is not needed for a vetted account. Token that is associated to the location. Token that is associated
to the location.
context:
$ref: '#/components/schemas/ServiceBusinessContext'
description: 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.
method:
description: Required. Verification method.
enum:
- VERIFICATION_METHOD_UNSPECIFIED
- ADDRESS
- EMAIL
- PHONE_CALL
- SMS
- AUTO
- TRUSTED_PARTNER
type: string
mailerContact:
description: Optional. The input for ADDRESS method. Contact name the mail should be sent to.
type: string
phoneNumber:
description: 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.
type: string
trustedPartnerToken:
description: The input for TRUSTED_PARTNER method The verification token that is associated to the location.
type: string
emailAddress:
description: 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 FetchVerificationOptions. If the EmailVerificationData
has is_user_name_editable set to true, the client may specify a different user name (local-part) but must match
the domain name.
type: string
type: object
description: Request message for Verifications.VerifyLocation.
VerifyLocationResponse:
description: Response message for Verifications.VerifyLocation.
type: object
properties:
verification:
$ref: '#/components/schemas/Verification'
description: The created verification request.
VoiceOfMerchantState:
type: object
description: Response message for VoiceOfMerchant.GetVoiceOfMerchantState.
properties:
hasBusinessAuthority:
description: Indicates whether the location has the authority (ownership) over the business on Google. If true,
another location cannot take over and become the dominant listing on Maps. However, edits will not become live
unless Voice of Merchant is gained (i.e. has_voice_of_merchant is true).
type: boolean
complyWithGuidelines:
$ref: '#/components/schemas/ComplyWithGuidelines'
description: The location fails to comply with our [guidelines](https://support.google.com/business/answer/3038177)
and requires additional steps for reinstatement. To fix this issue, consult the [Help Center Article](https://support.google.com/business/answer/4569145).
hasVoiceOfMerchant:
type: boolean
description: Indicates whether the location is in good standing and has control over the business on Google. Any
edits made to the location will propagate to Maps after passing the review phase.
verify:
$ref: '#/components/schemas/Verify'
description: Start or continue the verification process.
resolveOwnershipConflict:
$ref: '#/components/schemas/ResolveOwnershipConflict'
description: This location duplicates another location that is in good standing. If you have access to the location
in good standing, use that location's id to perform operations. Otherwise, request access from the current owner.
waitForVoiceOfMerchant:
$ref: '#/components/schemas/WaitForVoiceOfMerchant'
description: Wait to gain Voice of Merchant. The location is under review for quality purposes.
WaitForVoiceOfMerchant:
description: Indicates that the location will gain voice of merchant after passing review.
type: object
properties: {}
x-provenance:
method: harvested
publisher: Google
source: https://mybusinessverifications.googleapis.com/$discovery/rest?version=v1
note: converted by discovery-to-openapi.py from Google's Discovery document (revision 20261110)