Create a brand vetting

A successful request to this endpoint will mean you are charged a brand vetting fee.

Create a brand vetting at workspace level.

post

Create a brand vetting in a workspace. Brand vetting should be requested when the brand is not getting approved, or if the customer needs a higher throughput.

Authorizations

accessKey

HTTPRequired

Uses the Authorization header: 'AccessKey ' followed by your access key token (e.g., 'Authorization: AccessKey AbCdEfGhIjKlMnOpQrStUvWxYzAbCdEfGhIj')

Path parameters

workspaceIdstring · uuidRequired

The ID for the workspace.

Example: d386a801-ee8d-4aba-a7e4-78671bd3b11e

brandIdstringRequired

A unique identifier for the brand.

Body

application/json

classstring · enumRequired

Identifies the vetting classification.

Example: STANDARDPossible values:

vettingProviderIdstringOptional

External vetting provider ID for the brand.

Responses

201

Brand vetting successfully created

application/json

idstring · uuidRequired

Unique ID that identifies a vetting transaction performed by a vetting provider.

brandIdstring · uuidRequired

createdAtstring · date-timeRequired

Vetting submission date (UTC). This is the date when the vetting request is generated

updatedAtstring · date-time · nullableOptional

Timestamp (UTC) when the brand vetting was last updated.

statusstring · enumRequired

Identifies the vetting request status.

Example: PENDINGPossible values:

vettingProviderIdstringRequired

External vetting provider ID for the Brand vetting.

tokenstringOptional

scorestringRequired

Brand vetting score (0-100). Higher is better.

classstring · enumRequired

Identifies the vetting classification.

Example: STANDARDPossible values:

reasonsstring[]Optional

A list of reasons for FAILED vetting.

422

Invalid workspace brand vetting

application/json

post

/workspaces/{workspaceId}/tcr-brands/{brandId}/vettings

HTTPcURLJavaScriptPython

POST /workspaces/{workspaceId}/tcr-brands/{brandId}/vettings HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "class": "STANDARD",
  "vettingProviderId": "text"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "brandId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2026-03-12T01:31:05.831Z",
  "updatedAt": "2026-03-12T01:31:05.831Z",
  "status": "PENDING",
  "vettingProviderId": "text",
  "token": "text",
  "score": "text",
  "class": "STANDARD",
  "reasons": [
    "text"
  ]
}

VettingRequest object

Field	Type	Description	Mandatory
vettingClass	vettingClass	Vetting Class	Required
vettingProviderId	vettingProviderId	Vetting Provider	Required

VettingResponse object

Field	Type	Description
id	string	Vetting ID
brandId	string	ID of the brand that relates to this vetting
class	vettingClass	Identifies the vetting classification
status	vettingStatus	Identifies the vetting request status
vettingProviderId	vettingProviderId	Id of the provider used for vetting
score	string	Brand vetting score (0-100). Higher is better
token	string
reasons	array<string>	A list of reasons for FAILED vetting
updatedAt	string	Timestamp (UTC) when the brand vetting was last updated.
createdAt	string	Timestamp (UTC) when the brand vetting was created