オンプレミスAPIを終了します。詳細と次世代クラウドAPIへの移行方法については、オンプレミスAPIの終了のドキュメントを参照してください。

Business Compliance

/v1/settings/business/compliance_info

Use this endpoint to provide and retrieve e-commerce compliance information. Currently, compliance information includes a business's legal entity details.

Business compliance data is only exposed in the WhatsApp app and the WhatsApp Business app, and only if the app user's phone number is India-based (it begins with +91).

Before You Start

  • You must use the admin account to access the business compliance settings.
  • You must have a business address.
  • Your business address must be set on your WhatsApp business using the business profile settings endpoint. If you do not complete this step, business compliance will remain incomplete and the storefront icon will not appear for customers when messaging with them.

Retrieving

Make a GET API call to access a business' compliance information.

Example

GET /v1/settings/business/compliance_info

A successful response includes the following information:

{
  "settings": {
    "business": {
      "compliance_info": {
      "customer_care_details": {
        "email": "EMAIL",
        "landline_number": "+00000000000",
        "mobile_number": "+00000000000"
        },
      "entity_name": "NAME",
      "entity_type": "TYPE",
      "entity_type_custom": "",
      "grievance_officer_details": {
          "email": "EMAIL",
          "landline_number": "+00000000000",
          "mobile_number": "+00000000000",
          "name": "NAME"
          },
      "is_registered": false,
      "meta": {
        "api_status": "stable",
        "version": "2.38.0"
        }
      }
    }
  }
}

Providing Information

Make a POST call to provide a business' compliance information. In your call, include the parameters listed below.

Parameters

NameDescription

entity_name

Required.

A business' legal name.

entity_type

Required.

Available options are:

  • "Limited liability partnership"
  • "Sole proprietorship"
  • "Partnership"
  • "Public Company"
  • "Private Company"
  • "Other"

entity_type_custom

Required in some cases.

Use when entity_type is set to "Other".

is_registered

type: Boolean

Required in some cases.

Use when entity_type is set to "Other" or "Partnership".

customer_care_details

Required.

A customer_care_details object.

grievance_officer_details

At least one contact field must be specified.

A grievance_officer_details object.

customer_care_details Object

NameDescription

email

Required.

An email customers can use to reach the business.

landline_number

Either landline_number or mobile_number must be provided.

A landline phone number customers can use to reach the business.


Phone numbers must be provided with a + sign and the country code.

mobile_number

Either landline_number or mobile_number must be provided.

A mobile phone number customers can use to reach the business.


Phone numbers must be provided with a + sign and the country code.

grievance_officer_details Object

NameDescription

name

Required.

The name of the business' grievance officer.

email

Either one of these contact methods (email, landline and mobile) is mandatory.

The email of the business' grievance officer.

landline_number

Either one of these contact methods (email, landline and mobile) is mandatory.

A landline phone number for the business' grievance officer.


Phone numbers must be provided with a + sign and the country code.

mobile_number

Either one of these contact methods (email, landline and mobile) is mandatory.

A mobile phone number for the business' grievance officer.


Phone numbers must be provided with a + sign and the country code.

Example

POST /v1/settings/business/compliance_info
{
      "entity_name": "NAME",
      "entity_type": "TYPE",
      "entity_type_custom": "",
      "is_registered": false,
      "customer_care_details": {
        "email": "EMAIL",
        "landline_number": "+00000000000",
        "mobile_number": "+00000000000"
      },
      "grievance_officer_details": {
        "name": "NAME",
        "email": "EMAIL",
        "landline_number": "+00000000000",
        "mobile_number": "+00000000000"
      }
}