Sign in

v1

latestOpenAPI 3.0.02026-07-2491237338.9 KB
WhatsApp Business Accounts

Retrieve a WABA

Retrieves a WABA you've registered.

get/whatsapp/businessAccounts/{id}

Path parameters

idstring required
Example:whatsapp-business-account-id

WhatsApp Business Account ID.

Response

Successfully retrieved the WABA.

idstring

WhatApp Business Account ID.

namestring

User-friendly name to differentiate WhatsApp Business Accounts.

currencystring

The currency in which the payment transactions for the WhatsApp Business Account will be processed.

messageTemplateNamespacestring

Namespace string for the message templates that belong to the WhatsApp Business Account.

accountReviewStatus'PENDING' | 'APPROVED' | 'REJECTED'

WhatsApp Business Account review status.

businessVerificationStatus'expired' | 'failed' | 'ineligible' | 'not_verified' | 'pending' | 'pending_need_more_info' | 'pending_submission' | 'rejected' | 'revoked' | 'verified'

Current status of business verification of Meta Business Account which owns this WhatsApp Business Account.

countrystring

Country of the WhatsApp Business Account's owning Meta Business account.

ownershipTypestring

Ownership type of the WhatsApp Business Account.

paymentMethodAttachedboolean

Whether we have attached a payment method to the WhatsApp Business Account.

primaryFundingIdstring

Primary funding ID for the WhatsApp Business Account paid service.

purchaseOrderNumberstring

The purchase order number supplied by the business for payment management purposes.

timezoneIdstring

The timezone ID of the WhatsApp Business Account. See Timezone IDs.

decision'APPROVED' | 'REJECTED'

Used if a decision about WhatsApp accounts or phone numbers has been made.

updateEvent'DISABLED_UPDATE' | 'ACCOUNT_RESTRICTION' | 'ACCOUNT_VIOLATION' | 'PARTNER_REMOVED' | 'PARTNER_APP_UNINSTALLED' | 'AUTH_INTL_PRICE_ELIGIBILITY_UPDATE' | 'BUSINESS_PRIMARY_LOCATION_COUNTRY_UPDATE'

Indicates the update event type of the WABA when a notification is sent to you to report a policy violation, a WABA has been banned and more.

  • DISABLED_UPDATE: WhatsApp Business Account Banned.
  • ACCOUNT_RESTRICTION: WhatsApp Business Account Restricted Due To Policy Violations.
  • ACCOUNT_VIOLATION: WhatsApp Business Account Violates Policy.
  • PARTNER_REMOVED: WhatsApp Business Account was removed from the partner connection.
  • PARTNER_APP_UNINSTALLED: WhatsApp Business Account partner app was uninstalled.
  • AUTH_INTL_PRICE_ELIGIBILITY_UPDATE: WhatsApp Business Account is eligible for the authentication-international rate.
  • BUSINESS_PRIMARY_LOCATION_COUNTRY_UPDATE: Business's primary business location is set.
banState'SCHEDULE_FOR_DISABLE' | 'DISABLE' | 'REINSTATE'

The ban state of the WhatsApp Business Account.

banDatestring

The date when the WABA is banned.

violationTypestring

Used to report violations imposed on the WABA. See also WhatsApp Business Platform Policy Violations.

primaryBusinessLocationstring

Your primary business location is the country where your business is based. It will appear in the Business Manager under the Primary Business Location field starting May 1, 2024. ISO 3166-1 alpha-2 country code.

removedReasonstring

Raw reason from the WhatsApp Business Account deletion event. Known values include:

  • ACCOUNT_DISCONNECTED: The account was disconnected due to enforcement or because the WhatsApp account was explicitly deleted.
  • BUSINESS_DOWNGRADE: The phone number was registered with the consumer WhatsApp app.
  • CHANGE_NUMBER: The WhatsApp phone number was changed.
  • COMPANION_INACTIVITY: A companion device was inactive for approximately 30 days.
  • PRIMARY_INACTIVITY: A primary device was inactive for approximately 30 days.
  • USER_RE_REGISTERED: WhatsApp was re-registered on a new device.

Unknown values are returned as received.

removedInitiatedBystring

Raw initiator from the WhatsApp Business Account deletion event. Known values include:

  • USER: The removal was initiated by the WhatsApp user.
  • SYSTEM: The removal was initiated by the Meta system.

Unknown values are returned as received.

removedTimestring date-time

The time when the WhatsApp Business Account deletion event was received, formatted in RFC 3339. e.g., 2026-05-19T12:00:00.000Z.

Example response

{
  "timezoneId": "1",
  "banDate": "December 9, 2022",
  "violationType": "SCAM",
  "restrictions": [
    {
      "expiration": "2022-06-01T12:00:00.000Z"
    }
  ],
  "authIntlRateEligibilityCountries": [
    {
      "countryCode": "IN",
      "startTime": "2024-07-01T00:00:00.000Z"
    }
  ],
  "primaryBusinessLocation": "US",
  "removedReason": "ACCOUNT_DISCONNECTED",
  "removedInitiatedBy": "USER",
  "removedTime": "2026-05-19T12:00:00.000Z"
}