REST Resource: accounts.businessInfo

Resource: BusinessInfo

The BusinessInfo message contains essential information about a business.

This message captures key business details such as physical address, customer service contacts, and region-specific identifiers.

JSON representation
{
  "name": string,
  "address": {
    object (PostalAddress)
  },
  "phone": {
    object (PhoneNumber)
  },
  "phoneVerificationState": enum (PhoneVerificationState),
  "customerService": {
    object (CustomerService)
  },
  "koreanBusinessRegistrationNumber": string
}
Fields
name

string

Identifier. The resource name of the business info. Format: accounts/{account}/businessInfo

address

object (PostalAddress)

Optional. The address of the business. Only regionCode, addressLines, postalCode, administrativeArea and locality fields are supported. All other fields are ignored.

phone

object (PhoneNumber)

Output only. The phone number of the business.

phoneVerificationState

enum (PhoneVerificationState)

Output only. The phone verification state of the business.

customerService

object (CustomerService)

Optional. The customer service of the business.

koreanBusinessRegistrationNumber

string

Optional. The 10-digit Korean business registration number separated with dashes in the format: XXX-XX-XXXXX.

PhoneVerificationState

The phone verification state.

Enums
PHONE_VERIFICATION_STATE_UNSPECIFIED Default value. This value is unused.
PHONE_VERIFICATION_STATE_VERIFIED The phone is verified.
PHONE_VERIFICATION_STATE_UNVERIFIED The phone is unverified.

CustomerService

Customer service information.

JSON representation
{
  "uri": string,
  "email": string,
  "phone": {
    object (PhoneNumber)
  }
}
Fields
uri

string

Optional. The URI where customer service may be found.

email

string

Optional. The email address where customer service may be reached.

phone

object (PhoneNumber)

Optional. The phone number where customer service may be called.

Methods

getBusinessInfo

Retrieves the business info of an account.

updateBusinessInfo

Updates the business info of an account.