Create a brand vetting

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

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.

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

Authorization

useraccessKey

Path parameters

workspaceId*string

brandId*string

Body

application/json

class*BrandVettingClass (enum)

Identifies the vetting classification.

Example: "STANDARD"

STANDARD

vettingProviderIdstring

External vetting provider ID for the brand.

Response

201422

Brand vetting successfully created

Body

application/json

id*string (uuid)

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

brandId*string (uuid)

createdAt*string (date-time)

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

updatedAtnullable string (date-time)

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

status*BrandVettingStatus (enum)

Identifies the vetting request status.

Example: "PENDING"

PENDINGREJECTEDFAILEDAPPROVEDEXPIRED

vettingProviderId*string

External vetting provider ID for the Brand vetting.

tokenstring

score*string

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

class*BrandVettingClass (enum)

Identifies the vetting classification.

Example: "STANDARD"

STANDARD

reasonsarray of string

A list of reasons for FAILED vetting.

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/tcr-brands/{brandId}/vettings', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "class": "STANDARD"
    }),
});
const data = await response.json();

Response

201422

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "brandId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2024-11-21T08:50:08.412Z",
  "updatedAt": "2024-11-21T08:50:08.412Z",
  "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