REST Resource: accounts.businessIdentity
Stay organized with collections
Save and categorize content based on your preferences.
Resource: BusinessIdentity
| Fields |
name |
string
Identifier. The resource name of the business identity. Format: accounts/{account}/businessIdentity
|
promotionsConsent |
enum (PromotionsConsent)
Required. Whether the identity attributes may be used for promotions.
|
blackOwned |
object (IdentityAttribute)
Optional. Specifies whether the business identifies itself as being black-owned. This optional field will only be available for businesses with the business country set to US. It is also not applicable for marketplaces or marketplace sellers.
|
womenOwned |
object (IdentityAttribute)
Optional. Specifies whether the business identifies itself as being women-owned. This optional field will only be available for businesses with a business country set to US. It is also not applicable for marketplaces or marketplace sellers.
|
veteranOwned |
object (IdentityAttribute)
Optional. Specifies whether the business identifies itself as being veteran-owned. This optional field will only be available for businesses with a business country set to US. It is also not applicable for marketplaces or marketplace sellers.
|
latinoOwned |
object (IdentityAttribute)
Optional. Specifies whether the business identifies itself as being latino-owned. This optional field will only be available for businesses with the business country set to US. It is also not applicable for marketplaces or marketplace sellers.
|
smallBusiness |
object (IdentityAttribute)
Optional. Specifies whether the business identifies itself as a small business. This optional field will only be available for businesses with a business country set to US. It is also not applicable for marketplaces.
|
IdentityAttribute
All information related to an identity attribute.
| Fields |
identityDeclaration |
enum (IdentityDeclaration)
Required. The declaration of identity for this attribute.
|
IdentityDeclaration
All possible settings regarding the declaration of an identity.
| Enums |
IDENTITY_DECLARATION_UNSPECIFIED |
Default value indicating that no selection was made. |
SELF_IDENTIFIES_AS |
Indicates that the account identifies with the attribute. |
DOES_NOT_SELF_IDENTIFY_AS |
Indicates that the account does not identify with the attribute. |
Methods |
|
|
Retrieves the business identity of an account. |
|
|
Updates the business identity of an account. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-06-06 UTC.
[null,null,["Last updated 2025-06-06 UTC."],[[["\u003cp\u003eThis page details the BusinessIdentity resource, which stores information about a business's identity, including attributes like being black-owned, women-owned, etc.\u003c/p\u003e\n"],["\u003cp\u003eBusiness owners can specify whether they consent to having their business identity used for promotions through the \u003ccode\u003epromotionsConsent\u003c/code\u003e field.\u003c/p\u003e\n"],["\u003cp\u003eEach identity attribute (e.g., black-owned) includes an \u003ccode\u003eidentityDeclaration\u003c/code\u003e that specifies whether the business self-identifies with that attribute.\u003c/p\u003e\n"],["\u003cp\u003eThis resource is accessed through the \u003ccode\u003egetBusinessIdentity\u003c/code\u003e and \u003ccode\u003eupdateBusinessIdentity\u003c/code\u003e methods, allowing retrieval and modification of the business's identity information.\u003c/p\u003e\n"]]],["The provided content outlines the `BusinessIdentity` resource, detailing how businesses can declare their identity. Key actions include: specifying `promotionsConsent` to allow or deny promotional use of identity attributes, and declaring attributes like `blackOwned`, `womenOwned`, `veteranOwned`, `latinoOwned`, and `smallBusiness`. These attributes, defined via `IdentityAttribute` and `IdentityDeclaration`, indicate if the business self-identifies with them. `getBusinessIdentity` retrieves and `updateBusinessIdentity` modifies the business identity information.\n"],null,["# REST Resource: accounts.businessIdentity\n\n- [Resource: BusinessIdentity](#BusinessIdentity)\n - [JSON representation](#BusinessIdentity.SCHEMA_REPRESENTATION)\n- [PromotionsConsent](#PromotionsConsent)\n- [IdentityAttribute](#IdentityAttribute)\n - [JSON representation](#IdentityAttribute.SCHEMA_REPRESENTATION)\n- [IdentityDeclaration](#IdentityDeclaration)\n- [Methods](#METHODS_SUMMARY)\n\nResource: BusinessIdentity\n--------------------------\n\nCollection of information related to the [identity of a business](https://support.google.com/merchants/answer/12564247).\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"promotionsConsent\": enum (/merchant/api/reference/rest/accounts_v1beta/accounts.businessIdentity#PromotionsConsent), \"blackOwned\": { object (/merchant/api/reference/rest/accounts_v1beta/accounts.businessIdentity#IdentityAttribute) }, \"womenOwned\": { object (/merchant/api/reference/rest/accounts_v1beta/accounts.businessIdentity#IdentityAttribute) }, \"veteranOwned\": { object (/merchant/api/reference/rest/accounts_v1beta/accounts.businessIdentity#IdentityAttribute) }, \"latinoOwned\": { object (/merchant/api/reference/rest/accounts_v1beta/accounts.businessIdentity#IdentityAttribute) }, \"smallBusiness\": { object (/merchant/api/reference/rest/accounts_v1beta/accounts.businessIdentity#IdentityAttribute) } } ``` |\n\n| Fields ||\n|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Identifier. The resource name of the business identity. Format: `accounts/{account}/businessIdentity` |\n| `promotionsConsent` | `enum (`[PromotionsConsent](/merchant/api/reference/rest/accounts_v1beta/accounts.businessIdentity#PromotionsConsent)`)` Required. Whether the identity attributes may be used for promotions. |\n| `blackOwned` | `object (`[IdentityAttribute](/merchant/api/reference/rest/accounts_v1beta/accounts.businessIdentity#IdentityAttribute)`)` Optional. Specifies whether the business identifies itself as being black-owned. This optional field will only be available for businesses with the business country set to `US`. It is also not applicable for marketplaces or marketplace sellers. |\n| `womenOwned` | `object (`[IdentityAttribute](/merchant/api/reference/rest/accounts_v1beta/accounts.businessIdentity#IdentityAttribute)`)` Optional. Specifies whether the business identifies itself as being women-owned. This optional field will only be available for businesses with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers. |\n| `veteranOwned` | `object (`[IdentityAttribute](/merchant/api/reference/rest/accounts_v1beta/accounts.businessIdentity#IdentityAttribute)`)` Optional. Specifies whether the business identifies itself as being veteran-owned. This optional field will only be available for businesses with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers. |\n| `latinoOwned` | `object (`[IdentityAttribute](/merchant/api/reference/rest/accounts_v1beta/accounts.businessIdentity#IdentityAttribute)`)` Optional. Specifies whether the business identifies itself as being latino-owned. This optional field will only be available for businesses with the business country set to `US`. It is also not applicable for marketplaces or marketplace sellers. |\n| `smallBusiness` | `object (`[IdentityAttribute](/merchant/api/reference/rest/accounts_v1beta/accounts.businessIdentity#IdentityAttribute)`)` Optional. Specifies whether the business identifies itself as a small business. This optional field will only be available for businesses with a business country set to `US`. It is also not applicable for marketplaces. |\n\nPromotionsConsent\n-----------------\n\nAll possible settings regarding promotions related to the business identity.\n\n| Enums ||\n|----------------------------------|---------------------------------------------------------------------------------------------------|\n| `PROMOTIONS_CONSENT_UNSPECIFIED` | Default value indicating that no selection was made. |\n| `PROMOTIONS_CONSENT_GIVEN` | Indicates that the account consented to having their business identity used for promotions. |\n| `PROMOTIONS_CONSENT_DENIED` | Indicates that the account did not consent to having their business identity used for promotions. |\n\nIdentityAttribute\n-----------------\n\nAll information related to an identity attribute.\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"identityDeclaration\": enum (/merchant/api/reference/rest/accounts_v1beta/accounts.businessIdentity#IdentityDeclaration) } ``` |\n\n| Fields ||\n|-----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `identityDeclaration` | `enum (`[IdentityDeclaration](/merchant/api/reference/rest/accounts_v1beta/accounts.businessIdentity#IdentityDeclaration)`)` Required. The declaration of identity for this attribute. |\n\nIdentityDeclaration\n-------------------\n\nAll possible settings regarding the declaration of an identity.\n\n| Enums ||\n|------------------------------------|------------------------------------------------------------------|\n| `IDENTITY_DECLARATION_UNSPECIFIED` | Default value indicating that no selection was made. |\n| `SELF_IDENTIFIES_AS` | Indicates that the account identifies with the attribute. |\n| `DOES_NOT_SELF_IDENTIFY_AS` | Indicates that the account does not identify with the attribute. |\n\n| Methods ------- ||\n|-----------------------------------------------------------------------------------------------------------------------------|------------------------------------------------|\n| ### [getBusinessIdentity](/merchant/api/reference/rest/accounts_v1beta/accounts.businessIdentity/getBusinessIdentity) | Retrieves the business identity of an account. |\n| ### [updateBusinessIdentity](/merchant/api/reference/rest/accounts_v1beta/accounts.businessIdentity/updateBusinessIdentity) | Updates the business identity of an account. |"]]
