# WhatsApp Business API - WhatsApp Account Number API | Developer Documentation

<div id="bkmrk-whatsapp-business-ap"><div><div>## WhatsApp Business API - WhatsApp Account Number API

<div><div><div><span>Copy for LLM</span></div></div><div>[<span>View as Markdown</span>](/books/meta-whatsapp/page/whatsapp-business-api-whatsapp-account-number-api-developer-documentation)</div></div></div><div><div>Version</div></div><div><div><div><div><div><div><span><span>API for retrieving WhatsApp Account Number details and configuration information.</span></span></div></div><div><div><span><span>This endpoint allows businesses to retrieve comprehensive information about their</span></span></div></div><div><div><span><span>WhatsApp Account Numbers, including status, verification details, and configuration settings.</span></span></div></div></div></div></div></div></div><div><div>---

<div><div><div id="bkmrk-get-%2F%7Bversion%7D%2F%7Bwhat"><div id="bkmrk-get-%2F%7Bversion%7D%2F%7Bwhat-1"><div>### GET /{Version}/{WhatsApp-Account-Number-ID}

</div></div></div><div><div><div><div><div><div><span><span>Retrieve comprehensive details about a WhatsApp Account Number, including its current status,</span></span></div></div><div><div><span><span>verification information, quality rating, and configuration settings.</span></span></div></div><div><div><span><span>Use Cases:</span></span></div></div><div><span><span>Monitor account number status and quality rating</span></span></div><div><span><span>Verify account number configuration before messaging operations</span></span></div><div><span><span>Check verification and approval status</span></span></div><div><span><span>Retrieve display name and business profile information</span></span></div><div><div><span><span>Rate Limiting:</span></span></div></div><div><div><span><span>Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff.</span></span></div></div><div><div><span><span>Caching:</span></span></div></div><div><div><span><span>Account number details can be cached for short periods, but status information may change</span></span></div></div><div><div><span><span>frequently. Implement appropriate cache invalidation strategies.</span></span></div></div></div></div></div></div>#### Request Syntax

<div><div><div><div><div><div><span>Try it</span></div></div></div></div></div></div><div><div><div><div><div><div><div>Select language</div></div></div></div>---

</div><div><div><div><div><div><div>Select status code</div></div></div></div>---

</div></div></div></div><div><span>Header Parameters</span>---

<div><div><span>User-Agent</span><span>string</span></div><div><div><div><div><div><div><span><span>The user agent string identifying the client software making the request.</span></span></div></div></div></div></div></div></div><div><div><span>Authorization</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token.</span></span></div></div></div></div></div></div></div></div><div><span>Path Parameters</span>---

<div><div><span>Version</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Graph API version to use for this request. Determines the API behavior and available features.</span></span></div></div></div></div></div></div></div><div><div><span>WhatsApp-Account-Number-ID</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Your WhatsApp Account Number ID. This ID represents the account number entity</span></span></div></div><div><div><span><span>and can be obtained from your WhatsApp Business Account phone numbers list.</span></span></div></div></div></div></div></div></div></div><div><span>Query Parameters</span>---

<div><div><span>fields</span><span>string</span></div><div><div><div><div><div><div><span><span>Comma-separated list of fields to include in the response. If not specified,</span></span></div></div><div><div><span><span>default fields will be returned (id, display\_phone\_number, status).</span></span></div></div><div><div><span><span>Available fields: id, display\_phone\_number, verified\_name, status, quality\_rating,</span></span></div></div><div><div><span><span>country\_code, country\_dial\_code, code\_verification\_status, name\_status,</span></span></div></div><div><div><span><span>messaging\_limit\_tier, account\_mode, certificate, is\_official\_business\_account</span></span></div></div></div></div></div></div></div></div><div><span>Responses</span>---

<div><div><div><div><div><div><span><span>Retrieve comprehensive details about a WhatsApp Account Number, including its current status,</span></span></div></div><div><div><span><span>verification information, quality rating, and configuration settings.</span></span></div></div><div><div><span><span>Use Cases:</span></span></div></div><div><span><span>Monitor account number status and quality rating</span></span></div><div><span><span>Verify account number configuration before messaging operations</span></span></div><div><span><span>Check verification and approval status</span></span></div><div><span><span>Retrieve display name and business profile information</span></span></div><div><div><span><span>Rate Limiting:</span></span></div></div><div><div><span><span>Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff.</span></span></div></div><div><div><span><span>Caching:</span></span></div></div><div><div><span><span>Account number details can be cached for short periods, but status information may change</span></span></div></div><div><div><span><span>frequently. Implement appropriate cache invalidation strategies.</span></span></div></div></div></div></div></div><div><span>200</span><div><div><div><div><div><div><span><span>Successfully retrieved WhatsApp Account Number details</span></span></div></div></div></div></div></div><div><div><span>Content Type: </span><span>application/json</span></div><div><div><span>Schema: </span><span>WhatsAppAccountNumber</span></div><div><div><div id="bkmrk-show-child-attribute"><div><span>Show child attributes</span></div></div><div id="bkmrk-whatsappaccountnumbe"><div>---

<div><span>WhatsAppAccountNumber</span></div><div>---

<div><div><span>id</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Unique identifier for the WhatsApp Account Number</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>display\_phone\_number</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Phone number in international format for display purposes</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>verified\_name</span><span>string</span></div><div><div><div><div><div><div><span><span>Business name verified for this phone number</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>status</span><span>WhatsAppAccountNumberStatus</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Current status of the WhatsApp Account Number</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>quality\_rating</span><span>WhatsAppPhoneNumberQualityRating</span></div><div><div><div><div><div><div><span><span>Quality rating based on message delivery and user feedback</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>country\_code</span><span>string</span></div><div><div><div><div><div><div><span><span>ISO 3166-1 alpha-2 country code</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>country\_dial\_code</span><span>string</span></div><div><div><div><div><div><div><span><span>Country dialing code</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>code\_verification\_status</span><span>WhatsAppCodeVerificationStatus</span></div><div><div><div><div><div><div><span><span>Two-step verification status for the phone number</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>name\_status</span><span>WhatsAppDisplayNameStatus</span></div><div><div><div><div><div><div><span><span>Status of the display name associated with the phone number</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>messaging\_limit\_tier</span><span>One of "TIER\_50", "TIER\_250", "TIER\_1K", "TIER\_10K", "TIER\_100K", "TIER\_UNLIMITED"</span></div><div><div><div><div><div><div><span><span>Current messaging limit tier for the account number</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>account\_mode</span><span>WhatsAppBusinessSandboxEligibility</span></div><div><div><div><div><div><div><span><span>Account mode indicating sandbox or live environment</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>certificate</span><span>string</span></div><div><div><div><div><div><div><span><span>Business certificate information for the account number</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>is\_official\_business\_account</span><span>boolean</span></div><div><div><div><div><div><div><span><span>Whether this is an official business account</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div><div><span>400</span><div><div><div><div><div><div><span><span>Bad Request - Invalid parameters or malformed request</span></span></div></div></div></div></div></div><div><div><span>Content Type: </span><span>application/json</span></div><div><div><span>Schema: </span><span>GraphAPIError</span></div><div><div><div id="bkmrk-show-child-attribute-1"><div><span>Show child attributes</span></div></div><div id="bkmrk-graphapierrorerrorob"><div>---

<div><span>GraphAPIError</span></div><div>---

<div><div><span>error</span><span>object</span><span>·</span><span>required</span></div></div><div><div><div id="bkmrk-show-child-attribute-2"><div><span>Show child attributes</span></div></div><div id="bkmrk-messagestring%C2%B7requir"><div><div>---

<div><div><span>message</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Human-readable error message</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>type</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Error category type</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>code</span><span>integer</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Numeric error code</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_subcode</span><span>integer</span></div><div><div><div><div><div><div><span><span>More specific error subcode when available</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>fbtrace\_id</span><span>string</span></div><div><div><div><div><div><div><span><span>Unique identifier for debugging and support requests with Meta</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>is\_transient</span><span>boolean</span></div><div><div><div><div><div><div><span><span>Indicates whether this error is temporary and the request should be retried</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_title</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error title for display purposes</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_msg</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error message for display purposes</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div><div><span>401</span><div><div><div><div><div><div><span><span>Unauthorized - Invalid or missing access token</span></span></div></div></div></div></div></div><div><div><span>Content Type: </span><span>application/json</span></div><div><div><span>Schema: </span><span>GraphAPIError</span></div><div><div><div id="bkmrk-show-child-attribute-3"><div><span>Show child attributes</span></div></div><div id="bkmrk-graphapierrorerrorob-1"><div>---

<div><span>GraphAPIError</span></div><div>---

<div><div><span>error</span><span>object</span><span>·</span><span>required</span></div></div><div><div><div id="bkmrk-show-child-attribute-4"><div><span>Show child attributes</span></div></div><div id="bkmrk-messagestring%C2%B7requir-1"><div><div>---

<div><div><span>message</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Human-readable error message</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>type</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Error category type</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>code</span><span>integer</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Numeric error code</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_subcode</span><span>integer</span></div><div><div><div><div><div><div><span><span>More specific error subcode when available</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>fbtrace\_id</span><span>string</span></div><div><div><div><div><div><div><span><span>Unique identifier for debugging and support requests with Meta</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>is\_transient</span><span>boolean</span></div><div><div><div><div><div><div><span><span>Indicates whether this error is temporary and the request should be retried</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_title</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error title for display purposes</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_msg</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error message for display purposes</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div><div><span>403</span><div><div><div><div><div><div><span><span>Forbidden - Insufficient permissions or access denied</span></span></div></div></div></div></div></div><div><div><span>Content Type: </span><span>application/json</span></div><div><div><span>Schema: </span><span>GraphAPIError</span></div><div><div><div id="bkmrk-show-child-attribute-5"><div><span>Show child attributes</span></div></div><div id="bkmrk-graphapierrorerrorob-2"><div>---

<div><span>GraphAPIError</span></div><div>---

<div><div><span>error</span><span>object</span><span>·</span><span>required</span></div></div><div><div><div id="bkmrk-show-child-attribute-6"><div><span>Show child attributes</span></div></div><div id="bkmrk-messagestring%C2%B7requir-2"><div><div>---

<div><div><span>message</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Human-readable error message</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>type</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Error category type</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>code</span><span>integer</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Numeric error code</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_subcode</span><span>integer</span></div><div><div><div><div><div><div><span><span>More specific error subcode when available</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>fbtrace\_id</span><span>string</span></div><div><div><div><div><div><div><span><span>Unique identifier for debugging and support requests with Meta</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>is\_transient</span><span>boolean</span></div><div><div><div><div><div><div><span><span>Indicates whether this error is temporary and the request should be retried</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_title</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error title for display purposes</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_msg</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error message for display purposes</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div><div><span>404</span><div><div><div><div><div><div><span><span>Not Found - Account Number ID does not exist or is not accessible</span></span></div></div></div></div></div></div><div><div><span>Content Type: </span><span>application/json</span></div><div><div><span>Schema: </span><span>GraphAPIError</span></div><div><div><div id="bkmrk-show-child-attribute-7"><div><span>Show child attributes</span></div></div><div id="bkmrk-graphapierrorerrorob-3"><div>---

<div><span>GraphAPIError</span></div><div>---

<div><div><span>error</span><span>object</span><span>·</span><span>required</span></div></div><div><div><div id="bkmrk-show-child-attribute-8"><div><span>Show child attributes</span></div></div><div id="bkmrk-messagestring%C2%B7requir-3"><div><div>---

<div><div><span>message</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Human-readable error message</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>type</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Error category type</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>code</span><span>integer</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Numeric error code</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_subcode</span><span>integer</span></div><div><div><div><div><div><div><span><span>More specific error subcode when available</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>fbtrace\_id</span><span>string</span></div><div><div><div><div><div><div><span><span>Unique identifier for debugging and support requests with Meta</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>is\_transient</span><span>boolean</span></div><div><div><div><div><div><div><span><span>Indicates whether this error is temporary and the request should be retried</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_title</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error title for display purposes</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_msg</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error message for display purposes</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div><div><span>422</span><div><div><div><div><div><div><span><span>Unprocessable Entity - Request parameters are valid but cannot be processed</span></span></div></div></div></div></div></div><div><div><span>Content Type: </span><span>application/json</span></div><div><div><span>Schema: </span><span>GraphAPIError</span></div><div><div><div id="bkmrk-show-child-attribute-9"><div><span>Show child attributes</span></div></div><div id="bkmrk-graphapierrorerrorob-4"><div>---

<div><span>GraphAPIError</span></div><div>---

<div><div><span>error</span><span>object</span><span>·</span><span>required</span></div></div><div><div><div id="bkmrk-show-child-attribute-10"><div><span>Show child attributes</span></div></div><div id="bkmrk-messagestring%C2%B7requir-4"><div><div>---

<div><div><span>message</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Human-readable error message</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>type</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Error category type</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>code</span><span>integer</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Numeric error code</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_subcode</span><span>integer</span></div><div><div><div><div><div><div><span><span>More specific error subcode when available</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>fbtrace\_id</span><span>string</span></div><div><div><div><div><div><div><span><span>Unique identifier for debugging and support requests with Meta</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>is\_transient</span><span>boolean</span></div><div><div><div><div><div><div><span><span>Indicates whether this error is temporary and the request should be retried</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_title</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error title for display purposes</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_msg</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error message for display purposes</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div><div><span>429</span><div><div><div><div><div><div><span><span>Too Many Requests - Rate limit exceeded</span></span></div></div></div></div></div></div><div><div><span>Content Type: </span><span>application/json</span></div><div><div><span>Schema: </span><span>GraphAPIError</span></div><div><div><div id="bkmrk-show-child-attribute-11"><div><span>Show child attributes</span></div></div><div id="bkmrk-graphapierrorerrorob-5"><div>---

<div><span>GraphAPIError</span></div><div>---

<div><div><span>error</span><span>object</span><span>·</span><span>required</span></div></div><div><div><div id="bkmrk-show-child-attribute-12"><div><span>Show child attributes</span></div></div><div id="bkmrk-messagestring%C2%B7requir-5"><div><div>---

<div><div><span>message</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Human-readable error message</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>type</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Error category type</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>code</span><span>integer</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Numeric error code</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_subcode</span><span>integer</span></div><div><div><div><div><div><div><span><span>More specific error subcode when available</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>fbtrace\_id</span><span>string</span></div><div><div><div><div><div><div><span><span>Unique identifier for debugging and support requests with Meta</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>is\_transient</span><span>boolean</span></div><div><div><div><div><div><div><span><span>Indicates whether this error is temporary and the request should be retried</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_title</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error title for display purposes</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_msg</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error message for display purposes</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div><div><span>500</span><div><div><div><div><div><div><span><span>Internal Server Error - Unexpected server error</span></span></div></div></div></div></div></div><div><div><span>Content Type: </span><span>application/json</span></div><div><div><span>Schema: </span><span>GraphAPIError</span></div><div><div><div id="bkmrk-show-child-attribute-13"><div><span>Show child attributes</span></div></div><div id="bkmrk-graphapierrorerrorob-6"><div>---

<div><span>GraphAPIError</span></div><div>---

<div><div><span>error</span><span>object</span><span>·</span><span>required</span></div></div><div><div><div id="bkmrk-show-child-attribute-14"><div><span>Show child attributes</span></div></div><div id="bkmrk-messagestring%C2%B7requir-6"><div><div>---

<div><div><span>message</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Human-readable error message</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>type</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Error category type</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>code</span><span>integer</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Numeric error code</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_subcode</span><span>integer</span></div><div><div><div><div><div><div><span><span>More specific error subcode when available</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>fbtrace\_id</span><span>string</span></div><div><div><div><div><div><div><span><span>Unique identifier for debugging and support requests with Meta</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>is\_transient</span><span>boolean</span></div><div><div><div><div><div><div><span><span>Indicates whether this error is temporary and the request should be retried</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_title</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error title for display purposes</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_msg</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error message for display purposes</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div><div><div><div><div><div><div><div>Select language</div></div></div></div>---

</div><div><div><div><div><div><div>Select status code</div></div></div></div>---

</div></div></div></div></div></div></div><div><div id="bkmrk-authentication"><div id="bkmrk-authentication-1"><div>### Authentication

</div></div></div><div><table><tbody><tr><td><div>**Scheme**</div></td><td><div>**Type**</div></td><td><div>**Location**</div></td></tr><tr><td><div><div><div><div><div><div><div><span><span>bearerAuth</span></span></div></div></div></div></div></div></div></td><td><div><div><div><div><div><div><div><span><span>HTTP Bearer</span></span></div></div></div></div></div></div></div></td><td><div><div><div><div><div><div><div><span><span>Header: </span></span>`<span><span>Authorization</span></span>`</div></div></div></div></div></div></div></td></tr></tbody></table>

</div><div>#### Usage Examples

<div><span>bearerAuth:</span><div><div><div><div><div><div><span><span>Include </span></span>`<span><span>Authorization: Bearer your-token-here</span></span>`<span><span> in request headers</span></span></div></div></div></div></div></div></div></div><div>#### Global Authentication Requirements

<div><span>All endpoints require:</span><div><div><div><div><div><div><span><span>bearerAuth</span></span></div></div></div></div></div></div></div></div></div></div>