API ReferenceBrands

Vet Brand

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.

Errors

400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error
501
Not Implemented Error