messaging.v1.brand_registrations

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/twilio/main/json-schema/twilio-messaging-v1-brand-registrations-schema.json",
  "title": "messaging.v1.brand_registrations",
  "x-generated": "2026-10-08",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/twilio-a2p-api-openapi.yml#/components/schemas/messaging.v1.brand_registrations",
  "type": "object",
  "properties": {
    "sid": {
      "type": [
        "string",
        "null"
      ],
      "minLength": 34,
      "maxLength": 34,
      "pattern": "^BN[0-9a-fA-F]{32}$",
      "description": "The unique string to identify Brand Registration."
    },
    "account_sid": {
      "type": [
        "string",
        "null"
      ],
      "minLength": 34,
      "maxLength": 34,
      "pattern": "^AC[0-9a-fA-F]{32}$",
      "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Brand Registration resource."
    },
    "customer_profile_bundle_sid": {
      "type": [
        "string",
        "null"
      ],
      "minLength": 34,
      "maxLength": 34,
      "pattern": "^BU[0-9a-fA-F]{32}$",
      "description": "A2P Messaging Profile Bundle BundleSid."
    },
    "a2p_profile_bundle_sid": {
      "type": [
        "string",
        "null"
      ],
      "minLength": 34,
      "maxLength": 34,
      "pattern": "^BU[0-9a-fA-F]{32}$",
      "description": "A2P Messaging Profile Bundle BundleSid."
    },
    "date_created": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format."
    },
    "date_updated": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format."
    },
    "brand_type": {
      "type": [
        "string",
        "null"
      ],
      "description": "Type of brand. One of: \"STANDARD\", \"SOLE_PROPRIETOR\". SOLE_PROPRIETOR is for the low volume, SOLE_PROPRIETOR campaign use case. There can only be one SOLE_PROPRIETOR campaign created per SOLE_PROPRIETOR brand. STANDARD is for all other campaign use cases. Multiple campaign use cases can be created per STANDARD brand."
    },
    "status": {
      "type": [
        "string",
        "null"
      ],
      "$ref": "#/$defs/brand_registrations_enum_status",
      "description": "Brand Registration status. One of \"PENDING\", \"APPROVED\", \"FAILED\", \"IN_REVIEW\", \"DELETED\"."
    },
    "tcr_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "Campaign Registry (TCR) Brand ID. Assigned only after successful brand registration."
    },
    "failure_reason": {
      "type": [
        "string",
        "null"
      ],
      "description": "A reason why brand registration has failed. Only applicable when status is FAILED."
    },
    "url": {
      "type": [
        "string",
        "null"
      ],
      "format": "uri",
      "description": "The absolute URL of the Brand Registration resource."
    },
    "brand_score": {
      "type": [
        "integer",
        "null"
      ],
      "description": "The secondary vetting score if it was done. Otherwise, it will be the brand score if it's returned from TCR. It may be null if no score is available."
    },
    "brand_feedback": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": "string",
        "$ref": "#/$defs/brand_registrations_enum_brand_feedback"
      },
      "description": "Feedback on how to improve brand score"
    },
    "identity_status": {
      "type": [
        "string",
        "null"
      ],
      "$ref": "#/$defs/brand_registrations_enum_identity_status",
      "description": "When a brand is registered, TCR will attempt to verify the identity of the brand based on the supplied information."
    },
    "russell_3000": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Publicly traded company identified in the Russell 3000 Index"
    },
    "government_entity": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Identified as a government entity"
    },
    "tax_exempt_status": {
      "type": [
        "string",
        "null"
      ],
      "description": "Nonprofit organization tax-exempt status per section 501 of the U.S. tax code."
    },
    "skip_automatic_sec_vet": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "A flag to disable automatic secondary vetting for brands which it would otherwise be done."
    },
    "mock": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "A boolean that specifies whether brand should be a mock or not. If true, brand will be registered as a mock brand. Defaults to false if no value is provided."
    },
    "links": {
      "type": [
        "object",
        "null"
      ],
      "format": "uri-map"
    }
  },
  "$defs": {
    "brand_registrations_enum_brand_feedback": {
      "type": "string",
      "enum": [
        "TAX_ID",
        "STOCK_SYMBOL",
        "NONPROFIT",
        "GOVERNMENT_ENTITY",
        "OTHERS"
      ]
    },
    "brand_registrations_enum_identity_status": {
      "type": "string",
      "enum": [
        "SELF_DECLARED",
        "UNVERIFIED",
        "VERIFIED",
        "VETTED_VERIFIED"
      ]
    },
    "brand_registrations_enum_status": {
      "type": "string",
      "enum": [
        "PENDING",
        "APPROVED",
        "FAILED",
        "IN_REVIEW",
        "DELETED"
      ]
    }
  }
}