> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.pinnacle.sh/v-2/api-reference/brands/vet/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.pinnacle.sh/_mcp/server.

# Vet Brand

POST https://api.pinnacle.sh/brands/{brandId}/vet
Content-Type: application/json

Submit a brand for external vetting verification to enhance your brand's trust score and improved message delivery rates.

Reference: https://docs.pinnacle.sh/api-reference/brands/vet

## Authentication

- `PINNACLE-API-KEY` header (required) — API Key authentication via header

## Request

### Path parameters

- `brandId` (string, required) — The unique identifier of the brand to vet.  This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890` and must correspond to an existing brand in your account that is ready for vetting.

### Body (application/json)

This endpoint expects a vettingOptionsSchema.

- `type` (enum, required) — Select `EXTERNAL` for third-party vetting.
  - Allowed values: `EXTERNAL`
- `provider` (enum, required) — The vetting provider used.
  - Allowed values: `AEGIS`
- `vettingClass` (enum, required) — The vetting class level.
  - Allowed values: `STANDARD`

## Response

### 200

Successfully initiated brand vetting process.

- `success` (boolean, required) — Indicates if the vetting was successful.

## Errors

### 400 Bad Request Error

Validation failed. The payload has missing required fields and/or invalid types.  See [https://zod.dev/error-formatting](https://zod.dev/error-formatting) for more information.

- `description` (string, required) — Human-readable summary of validation failures.
- `errors` (ZodErrorErrors, required) — Structured dictionary of issues containing two main sections: - `errors`: Array of global validation errors not tied to specific fields - `properties`: Object mapping field names to their specific validation errors, where each field contains an `errors` array

### 401 Unauthorized Error

The request lacks valid authentication credentials or the provided credentials are invalid.  Ensure you're including a valid API key in the request headers and that your account has the necessary permissions to access this endpoint.

- `error` (string, required) — Human-readable description of the error that occurred, corresponding to the HTTP status code.

### 402 Payment Required Error

Insufficient credits to complete this request.  This occurs when your account balance is below the required amount for processing the operation. Please add credits to your account to continue using the service.

- `error` (string, required) — Human-readable description of the error that occurred, corresponding to the HTTP status code.

### 403 Forbidden Error

Your subscription does not include access to this feature.  This occurs when attempting to use functionality that requires a higher subscription tier. Please upgrade your subscription to access this feature.

- `error` (string, required) — Human-readable description of the error that occurred, corresponding to the HTTP status code.

### 404 Not Found Error

The requested resource could not be found.  This may occur if the identifier is incorrect, the resource has been deleted, or you don't have permission to access it.

- `error` (string, required) — Human-readable description of the error that occurred, corresponding to the HTTP status code.

### 500 Internal Server Error

An unexpected error occurred on Pinnacle's servers while processing your request.  If this error persists, please contact support with the request details.

- `error` (string, required) — Human-readable description of the error that occurred, corresponding to the HTTP status code.

### 501 Not Implemented Error

The requested functionality is not implemented on the server.  This typically indicates that the feature or endpoint you attempted to access is unavailable or not yet supported.

- `error` (string, required) — Human-readable description of the error that occurred, corresponding to the HTTP status code.

## Types

### ZodErrorErrors

Structured dictionary of issues containing two main sections: - `errors`: Array of global validation errors not tied to specific fields - `properties`: Object mapping field names to their specific validation errors, where each field contains an `errors` array

## Examples

**Request**

```json
{
  "type": "EXTERNAL",
  "provider": "AEGIS",
  "vettingClass": "STANDARD"
}
```

**Response**

```json
{
  "success": true
}
```

**SDK Code**

```python Brand Vetting Initiated
import requests

url = "https://api.pinnacle.sh/brands/b_1234567890/vet"

payload = {
    "type": "EXTERNAL",
    "provider": "AEGIS",
    "vettingClass": "STANDARD"
}
headers = {
    "PINNACLE-API-KEY": "<apiKey>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript Brand Vetting Initiated
const url = 'https://api.pinnacle.sh/brands/b_1234567890/vet';
const options = {
  method: 'POST',
  headers: {'PINNACLE-API-KEY': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{"type":"EXTERNAL","provider":"AEGIS","vettingClass":"STANDARD"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Brand Vetting Initiated
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.pinnacle.sh/brands/b_1234567890/vet"

	payload := strings.NewReader("{\n  \"type\": \"EXTERNAL\",\n  \"provider\": \"AEGIS\",\n  \"vettingClass\": \"STANDARD\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("PINNACLE-API-KEY", "<apiKey>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Brand Vetting Initiated
require 'uri'
require 'net/http'

url = URI("https://api.pinnacle.sh/brands/b_1234567890/vet")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["PINNACLE-API-KEY"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"type\": \"EXTERNAL\",\n  \"provider\": \"AEGIS\",\n  \"vettingClass\": \"STANDARD\"\n}"

response = http.request(request)
puts response.read_body
```

```java Brand Vetting Initiated
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.pinnacle.sh/brands/b_1234567890/vet")
  .header("PINNACLE-API-KEY", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": \"EXTERNAL\",\n  \"provider\": \"AEGIS\",\n  \"vettingClass\": \"STANDARD\"\n}")
  .asString();
```

```php Brand Vetting Initiated
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.pinnacle.sh/brands/b_1234567890/vet', [
  'body' => '{
  "type": "EXTERNAL",
  "provider": "AEGIS",
  "vettingClass": "STANDARD"
}',
  'headers' => [
    'Content-Type' => 'application/json',
    'PINNACLE-API-KEY' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp Brand Vetting Initiated
using RestSharp;

var client = new RestClient("https://api.pinnacle.sh/brands/b_1234567890/vet");
var request = new RestRequest(Method.POST);
request.AddHeader("PINNACLE-API-KEY", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"type\": \"EXTERNAL\",\n  \"provider\": \"AEGIS\",\n  \"vettingClass\": \"STANDARD\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Brand Vetting Initiated
import Foundation

let headers = [
  "PINNACLE-API-KEY": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = [
  "type": "EXTERNAL",
  "provider": "AEGIS",
  "vettingClass": "STANDARD"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.pinnacle.sh/brands/b_1234567890/vet")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

> One API for RCS, iMessage, MMS, and SMS. Build, test, and scale every channel — send your first message in minutes, not weeks.