Vet Brand | Pinnacle | Documentation

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

Authentication

PINNACLE-API-KEYstring

API Key authentication via header

Path parameters

brandIdstringRequired

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.

Request

This endpoint expects an object.

typeenumRequired

Select EXTERNAL for third-party vetting.

Allowed values:

providerenumRequired

The vetting provider used.

Allowed values:

vettingClassenumRequired

The vetting class level.

Allowed values:

Response

Successfully initiated brand vetting process.

successboolean

Indicates if the vetting was successful.

1	import { PinnacleClient } from "rcs-js";
2
3	async function main() {
4	const client = new PinnacleClient({
5	environment: "https://api.pinnacle.sh",
6	});
7	await client.brands.vet("b_1234567890", {
8	type: "EXTERNAL",
9	provider: "AEGIS",
10	vettingClass: "STANDARD",
11	});
12	}
13	main();

Authentication

Path parameters

Request

Response

Errors