{
  "opencollection": "1.0.0",
  "info": {
    "name": "Telnyx Access Tokens Brands API",
    "version": "2.0.0"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Brands",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Brands",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/10dlc/brand",
            "params": [
              {
                "name": "page",
                "value": "",
                "type": "query"
              },
              {
                "name": "recordsPerPage",
                "value": "",
                "type": "query",
                "description": "number of records per page. maximum of 500"
              },
              {
                "name": "sort",
                "value": "-identityStatus",
                "type": "query",
                "description": "Specifies the sort order for results. If not given, results are sorted by createdAt in descending order."
              },
              {
                "name": "displayName",
                "value": "",
                "type": "query"
              },
              {
                "name": "entityType",
                "value": "",
                "type": "query"
              },
              {
                "name": "state",
                "value": "",
                "type": "query"
              },
              {
                "name": "country",
                "value": "",
                "type": "query"
              },
              {
                "name": "brandId",
                "value": "",
                "type": "query",
                "description": "Filter results by the Telnyx Brand id"
              },
              {
                "name": "tcrBrandId",
                "value": "",
                "type": "query",
                "description": "Filter results by the TCR Brand id"
              }
            ]
          },
          "docs": "This endpoint is used to list all brands associated with your organization."
        },
        {
          "info": {
            "name": "Create Brand",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/10dlc/brand",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This endpoint is used to create a new brand. A brand is an entity created by The Campaign Registry (TCR) that represents an organization or a company. It is this entity that TCR created campaigns will be associated with. Each brand creation will entail an upfront, non-refundable $4 expense."
        },
        {
          "info": {
            "name": "Get Brand Feedback By Id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/10dlc/brand/feedback/:brandId",
            "params": [
              {
                "name": "brandId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Get feedback about a brand by ID. This endpoint can be used after creating or revetting\na brand.\n\nPossible values for `.category[].id`:\n\n* `TAX_ID` - Data mismatch related to tax id and its associated properties.\n* `STOCK_SYMBOL` - Non public entity registered as a public for profit entity or\n  the stock information mismatch.\n* `GOVERNMENT_ENTITY` - Non government entity registered as a government entity.\n  Must be a U.S. government entity.\n* `NONPROFIT` - Not a recognized non-profit entity. No "
        },
        {
          "info": {
            "name": "Get Brand SMS OTP Status",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/10dlc/brand/smsOtp/:referenceId",
            "params": [
              {
                "name": "referenceId",
                "value": "",
                "type": "path",
                "description": "The reference ID returned when the OTP was initially triggered"
              },
              {
                "name": "brandId",
                "value": "",
                "type": "query",
                "description": "Filter by Brand ID for easier lookup in portal applications"
              }
            ]
          },
          "docs": "Query the status of an SMS OTP (One-Time Password) for Sole Proprietor brand verification.\n\nThis endpoint allows you to check the delivery and verification status of an OTP sent during the Sole Proprietor brand verification process. You can query by either:\n\n* `referenceId` - The reference ID returned when the OTP was initially triggered\n* `brandId` - Query parameter for portal users to look up OTP status by Brand ID\n\nThe response includes delivery status, verification dates, and detailed delive"
        },
        {
          "info": {
            "name": "Get Brand",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/10dlc/brand/:brandId",
            "params": [
              {
                "name": "brandId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Retrieve a brand by `brandId`."
        },
        {
          "info": {
            "name": "Update Brand",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.telnyx.com/v2/10dlc/brand/:brandId",
            "params": [
              {
                "name": "brandId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update a brand's attributes by `brandId`."
        },
        {
          "info": {
            "name": "Delete Brand",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.telnyx.com/v2/10dlc/brand/:brandId",
            "params": [
              {
                "name": "brandId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Delete Brand. This endpoint is used to delete a brand. Note the brand cannot be deleted if it contains one or more active campaigns, the campaigns need to be inactive and at least 3 months old due to billing purposes."
        },
        {
          "info": {
            "name": "Resend brand 2FA email",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/10dlc/brand/:brandId/2faEmail",
            "params": [
              {
                "name": "brandId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Resend brand 2FA email"
        },
        {
          "info": {
            "name": "List External Vettings",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/10dlc/brand/:brandId/externalVetting",
            "params": [
              {
                "name": "brandId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Get list of valid external vetting record for a given brand"
        },
        {
          "info": {
            "name": "Order Brand External Vetting",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/10dlc/brand/:brandId/externalVetting",
            "params": [
              {
                "name": "brandId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Order new external vetting for a brand.\n\nDuplicate orders for the same `evpId` and `vettingClass` return `400` with code `10012` if a successful vetting exists within the last 180 days, or one is currently being processed. Failed vettings can be retried immediately."
        },
        {
          "info": {
            "name": "Import External Vetting Record",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.telnyx.com/v2/10dlc/brand/:brandId/externalVetting",
            "params": [
              {
                "name": "brandId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This operation can be used to import an external vetting record from a TCR-approved\nvetting provider. If the vetting provider confirms validity of the record, it will be\nsaved with the brand and will be considered for future campaign qualification."
        },
        {
          "info": {
            "name": "Revet Brand",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.telnyx.com/v2/10dlc/brand/:brandId/revet",
            "params": [
              {
                "name": "brandId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This operation allows you to revet the brand. However, revetting is allowed once after the successful brand registration and thereafter limited to once every 3 months."
        },
        {
          "info": {
            "name": "Get Brand SMS OTP Status by Brand ID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/10dlc/brand/:brandId/smsOtp",
            "params": [
              {
                "name": "brandId",
                "value": "",
                "type": "path",
                "description": "The Brand ID for which to query OTP status"
              }
            ]
          },
          "docs": "Query the status of an SMS OTP (One-Time Password) for Sole Proprietor brand verification using the Brand ID.\n\nThis endpoint allows you to check the delivery and verification status of an OTP sent during the Sole Proprietor brand verification process by looking it up with the brand ID.\n\nThe response includes delivery status, verification dates, and detailed delivery information.\n\n**Note:** This is an alternative to the `/10dlc/brand/smsOtp/{referenceId}` endpoint when you have the Brand ID but n"
        },
        {
          "info": {
            "name": "Trigger Brand SMS OTP",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/10dlc/brand/:brandId/smsOtp",
            "params": [
              {
                "name": "brandId",
                "value": "",
                "type": "path",
                "description": "The Brand ID for which to trigger the OTP"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Trigger or re-trigger an SMS OTP (One-Time Password) for Sole Proprietor brand verification.\n\n**Important Notes:**\n\n* Only allowed for Sole Proprietor (`SOLE_PROPRIETOR`) brands\n* Triggers generation of a one-time password sent to the `mobilePhone` number in the brand's profile\n* Campaigns cannot be created until OTP verification is complete\n* US/CA numbers only for real OTPs; mock brands can use non-US/CA numbers for testing\n* Returns a `referenceId` that can be used to check OTP status via the"
        },
        {
          "info": {
            "name": "Verify Brand SMS OTP",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.telnyx.com/v2/10dlc/brand/:brandId/smsOtp",
            "params": [
              {
                "name": "brandId",
                "value": "",
                "type": "path",
                "description": "The Brand ID for which to verify the OTP"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Verify the SMS OTP (One-Time Password) for Sole Proprietor brand verification.\n\n**Verification Flow:**\n\n1. User receives OTP via SMS after triggering\n2. User submits the OTP pin through this endpoint\n3. Upon successful verification:\n   - A `BRAND_OTP_VERIFIED` webhook event is sent to the CSP\n   - The brand's `identityStatus` changes to `VERIFIED`\n   - Campaigns can now be created for this brand\n\n**Error Handling:**\n\nProvides proper error responses for:\n* Invalid OTP pins\n* Expired OTPs\n* OTP ve"
        }
      ]
    }
  ],
  "bundled": true
}