Sign in
MessagingV1BrandRegistration

get/v1/a2p/BrandRegistrations/{Sid}

Path parameters

Sidstring required

The SID of the Brand Registration resource to fetch.

Response

OK

sidstring nullable

The unique string to identify Brand Registration.

account_sidstring nullable

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

customer_profile_bundle_sidstring nullable

A2P Messaging Profile Bundle BundleSid.

a2p_profile_bundle_sidstring nullable

A2P Messaging Profile Bundle BundleSid.

date_createdstring date-time nullable

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

date_updatedstring date-time nullable

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

brand_typestring nullable

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'PENDING' | 'APPROVED' | 'FAILED' | 'IN_REVIEW' | 'DELETION_PENDING' | 'DELETION_FAILED' | 'SUSPENDED'

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

tcr_idstring nullable

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

failure_reasonstring nullable

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

urlstring uri nullable

The absolute URL of the Brand Registration resource.

brand_scoreinteger nullable

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_feedbackBrandRegistrationsEnumBrandFeedback[] nullable

DEPRECATED. Feedback on how to improve brand score

identity_status'SELF_DECLARED' | 'UNVERIFIED' | 'VERIFIED' | 'VETTED_VERIFIED'

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

russell_3000boolean nullable

Publicly traded company identified in the Russell 3000 Index

government_entityboolean nullable

Identified as a government entity

tax_exempt_statusstring nullable

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

skip_automatic_sec_vetboolean nullable

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

mockboolean nullable

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.

linksobject nullable

Changes

Changed in 4 of the 103 revisions of this API.233

  • v11001b3de98851See the full diff
    • ▲

      the / response's property type changed from object to no type for status

      response-property-type-changed

  • v167b38e582c68131See the full diff
    • ▲

      the / response's property type changed from no type to object for status

      response-property-type-changed

    • ●

      added the new DELETION_FAILED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new DELETION_PENDING enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new SUSPENDED enum value to the response property for the response status

      response-property-enum-value-added

    • ○

      removed the DELETED enum value from the response property for the response status

      response-property-enum-value-removed

  • v185041ad8c4691See the full diff
    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • v18faf729647351See the full diff
    • ○

      api tag MessagingV1BrandRegistration added

      api-tag-added