Path parameters

• Sid string Required

  The SID of the Brand Registration resource to fetch.

  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^BN[0-9a-fA-F]{32}$.

Responses

• 200 application/json

  OK

  Hide headers attributes Show headers attributes

  • Access-Control-Allow-Origin string

    Specify the origin(s) allowed to access the resource

  • Access-Control-Allow-Methods string

    Specify the HTTP methods allowed when accessing the resource

  • Access-Control-Allow-Headers string

    Specify the headers allowed when accessing the resource

  • Access-Control-Allow-Credentials boolean

    Indicates whether the browser should include credentials

  • Access-Control-Expose-Headers string

    Headers exposed to the client

  Hide response attributes Show response attributes object

  • sid string | null

    The unique string to identify Brand Registration.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^BN[0-9a-fA-F]{32}$.

  • account_sid string | null

    The SID of the Account that created the Brand Registration resource.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

  • customer_profile_bundle_sid string | null

    A2P Messaging Profile Bundle BundleSid.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^BU[0-9a-fA-F]{32}$.

  • a2p_profile_bundle_sid string | null

    A2P Messaging Profile Bundle BundleSid.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^BU[0-9a-fA-F]{32}$.

  • date_created string(date-time) | null

    The date and time in GMT when the resource was created specified in ISO 8601 format.

  • date_updated string(date-time) | null

    The date and time in GMT when the resource was last updated specified in ISO 8601 format.

  • brand_type string | null

    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 string

    Brand Registration status. One of "PENDING", "APPROVED", "FAILED", "IN_REVIEW", "DELETION_PENDING", "DELETION_FAILED", "SUSPENDED".

    Values are PENDING, APPROVED, FAILED, IN_REVIEW, DELETION_PENDING, DELETION_FAILED, or SUSPENDED.

  • tcr_id string | null

    Campaign Registry (TCR) Brand ID. Assigned only after successful brand registration.

  • failure_reason string | null

    DEPRECATED. A reason why brand registration has failed. Only applicable when status is FAILED.

  • errors array[object] | null

    A list of errors that occurred during the brand registration process.
  • url string(uri) | null

    The absolute URL of the Brand Registration resource.

  • brand_score integer | null

    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 array[string] | null

    DEPRECATED. Feedback on how to improve brand score

    Values are TAX_ID, STOCK_SYMBOL, NONPROFIT, GOVERNMENT_ENTITY, or OTHERS.

  • identity_status string

    When a brand is registered, TCR will attempt to verify the identity of the brand based on the supplied information.

    Values are SELF_DECLARED, UNVERIFIED, VERIFIED, or VETTED_VERIFIED.

  • russell_3000 boolean | null

    Publicly traded company identified in the Russell 3000 Index

  • government_entity boolean | null

    Identified as a government entity

  • tax_exempt_status string | null

    Nonprofit organization tax-exempt status per section 501 of the U.S. tax code.

  • skip_automatic_sec_vet boolean | null

    A flag to disable automatic secondary vetting for brands which it would otherwise be done.

  • mock boolean | null

    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 object(uri-map) | null