Create a brand vetting

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

Create brand vetting at organization level

post

Create brand vetting in organization. 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

organizationIdstring · uuidRequired

The ID for the organization.

Example: d0b85ccc-b63a-4e81-b698-c359d77d250e

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

422

Invalid organization brand vet

application/json

post

/organizations/{organizationId}/tcr-brands/{brandId}/vettings

HTTPcURLJavaScriptPython

POST /organizations/{organizationId}/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-01-29T09:15:47.325Z",
  "updatedAt": "2026-01-29T09:15:47.325Z",
  "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