Get Brand Feedback By Id

GET 
/brand/feedback/:brandId

Get feedback about a brand by ID. This endpoint can be used after creating or revetting a brand.

Possible values for .category[].id:

• TAX_ID - Data mismatch related to tax id and its associated properties.
• STOCK_SYMBOL - Non public entity registered as a public for profit entity or the stock information mismatch.
• GOVERNMENT_ENTITY - Non government entity registered as a government entity. Must be a U.S. government entity.
• NONPROFIT - Not a recognized non-profit entity. No IRS tax-exempt status found.
• OTHERS - Details of the data misrepresentation if any.

Path Parameters

brandId Brandidrequired

200: Successful Response

application/json

• Schema
• Example (from schema)

Schema

brandId Brandid (string)required

ID of the brand being queried about

category

object[]

required

A list of reasons why brand creation/revetting didn't go as planned

Array [

id Id (string)required

One of TAX_ID, STOCK_SYMBOL, GOVERNMENT_ENTITY, NONPROFIT, and OTHERS

displayName Displayname (string)required

Human-readable version of the id field

description Description (string)required

Long-form description of the feedback with additional information

fields string[]required

List of relevant fields in the originally-submitted brand json

]

A list of reasons why brand creation/revetting didn't go as planned

{
  "brandId": "d88dd2aa-1bb9-4ef0-9ec8-1752b80316a5",
  "category": [
    {
      "id": "TAX_ID",
      "displayName": "Tax Id",
      "description": "Tax Id does not match with the company name or business type.",
      "fields": [
        "ein",
        "companyName",
        "entityType"
      ]
    }
  ]
}

422: Validation Error

application/json

• Schema
• Example (from schema)

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

• MOD1
• MOD2

string

integer

]

msg Message (string)required

type Error Type (string)required

]

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Request samples

• cURL

---

curl -L 'https://api.telnyx.com/10dlc/brand/feedback/:brandId' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

• 200
• 422

---

{
  "brandId": "d88dd2aa-1bb9-4ef0-9ec8-1752b80316a5",
  "category": [
    {
      "id": "TAX_ID",
      "displayName": "Tax Id",
      "description": "Tax Id does not match with the company name or business type.",
      "fields": [
        "ein",
        "companyName",
        "entityType"
      ]
    }
  ]
}

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}