On this page

A2P 10DLC - BrandRegistration Resource

(warning)

Warning

This API Reference page is meant to supplement the ISV API Onboarding Guides. Do not attempt to use this API Resource without following the appropriate guide, or you may incur delays in registration and unintended fees.

The BrandRegistration resource represents an A2P 10DLC Brand. It is a "container" that holds all of the business details required by The Campaign Registry (TCR) to create an A2P 10DLC Brand.

BrandRegistrations Properties

Resource properties

sidtype: SID<BN>Not PII

The unique string to identify Brand Registration.

account_sidtype: SID<AC>Not PII

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

customer_profile_bundle_sidtype: SID<BU>Not PII

A2P Messaging Profile Bundle BundleSid.

a2p_profile_bundle_sidtype: SID<BU>Not PII

A2P Messaging Profile Bundle BundleSid.

date_createdtype: string<DATE TIME>Not PII

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

date_updatedtype: string<DATE TIME>Not PII

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

brand_typetype: stringNot PII

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.

statustype: enum<STRING>Not PII

Brand Registration status. One of "PENDING", "APPROVED", "FAILED", "IN_REVIEW", "DELETED".

Possible values:

PENDINGAPPROVEDFAILEDIN_REVIEWDELETED

tcr_idtype: stringNot PII

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

failure_reasontype: stringNot PII

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

errorstype: arrayNot PII

A list of errors that occurred during the brand registration process.

urltype: string<URI>Not PII

The absolute URL of the Brand Registration resource.

brand_scoretype: integerNot PII

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_feedbacktype: string[]Not PII

DEPRECATED. Feedback on how to improve brand score

Possible values:

TAX_IDSTOCK_SYMBOLNONPROFITGOVERNMENT_ENTITYOTHERS

identity_statustype: enum<STRING>Not PII

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

Possible values:

SELF_DECLAREDUNVERIFIEDVERIFIEDVETTED_VERIFIED

russell_3000type: booleanNot PII

Publicly traded company identified in the Russell 3000 Index

government_entitytype: booleanNot PII

Identified as a government entity

tax_exempt_statustype: stringNot PII

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

skip_automatic_sec_vettype: booleanNot PII

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

mocktype: booleanNot PII

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.

linkstype: object<URI MAP>Not PII

Create a BrandRegistration resource

POST https://messaging.twilio.com/v1/a2p/BrandRegistrations

Parameters

Request body parameters

CustomerProfileBundleSidtype: SID<BU>Not PII

Required

Customer Profile Bundle Sid.

A2PProfileBundleSidtype: SID<BU>Not PII

Required

A2P Messaging Profile Bundle Sid.

BrandTypetype: stringNot PII

Type of brand being created. One of: "STANDARD", "SOLE_PROPRIETOR". SOLE_PROPRIETOR is for low volume, SOLE_PROPRIETOR use cases. STANDARD is for all other use cases.

Mocktype: booleanNot PII

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.

SkipAutomaticSecVettype: booleanNot PII

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

The sample below shows how to create a BrandRegistration resource.

The customer_profile_bundle_sid is the SID associated with the Secondary Customer Profile. It starts with BU. You can see Secondary Customer Profile SIDs in the the Console, or you can list CustomerProfiles via the TrustHub API. Be sure to use the correct Account SID and Auth Token for the request.

The a2p_profile_bundle_sid is the SID of the TrustProduct resource associated with the business. It also starts with BU. You can find the appropriate SID by using the TrustHub API to list all of an Account's TrustProducts. Be sure to use the correct Account SID and Auth Token for the request.

Create a BrandRegistration resource

Node.js

Python

Java

PHP

Ruby

twilio-cli

curl


_13// Download the helper library from https://www.twilio.com/docs/node/install
_13// Find your Account SID and Auth Token at twilio.com/console
_13// and set the environment variables. See http://twil.io/secure
_13const accountSid = process.env.TWILIO_ACCOUNT_SID;
_13const authToken = process.env.TWILIO_AUTH_TOKEN;
_13const client = require('twilio')(accountSid, authToken);
_13
_13client.messaging.v1.brandRegistrations
_13      .create({
_13         customerProfileBundleSid: 'BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX',
_13         a2PProfileBundleSid: 'BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
_13       })
_13      .then(brand_registration => console.log(brand_registration.sid));

Output


_29{
_29  "sid": "BN0044409f7e067e279523808d267e2d85",
_29  "account_sid": "AC78e8e67fc0246521490fb9907fd0c165",
_29  "customer_profile_bundle_sid": "BU0000009f7e067e279523808d267e2d90",
_29  "a2p_profile_bundle_sid": "BU1111109f7e067e279523808d267e2d85",
_29  "date_created": "2021-01-28T10:45:51Z",
_29  "date_updated": "2021-01-28T10:45:51Z",
_29  "brand_type": "STANDARD",
_29  "status": "PENDING",
_29  "tcr_id": "BXXXXXX",
_29  "failure_reason": "Registration error",
_29  "url": "https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85",
_29  "brand_score": 42,
_29  "brand_feedback": [
_29    "TAX_ID",
_29    "NONPROFIT"
_29  ],
_29  "identity_status": "VERIFIED",
_29  "russell_3000": true,
_29  "government_entity": false,
_29  "tax_exempt_status": "501c3",
_29  "skip_automatic_sec_vet": false,
_29  "errors": [],
_29  "mock": false,
_29  "links": {
_29    "brand_vettings": "https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/Vettings",
_29    "brand_registration_otps": "https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/SmsOtp"
_29  }
_29}

The sample below shows an example of how to use the skip_automatic_sec_vet parameter when creating a new BrandRegistration. This is only for registering a Low Volume Standard Brand, 527 political organization, or political organization with a Campaign Verify token.

Create a BrandRegistration resource and skip secondary vetting

Node.js

Python

Java

PHP

Ruby

twilio-cli

curl


_14// Download the helper library from https://www.twilio.com/docs/node/install
_14// Find your Account SID and Auth Token at twilio.com/console
_14// and set the environment variables. See http://twil.io/secure
_14const accountSid = process.env.TWILIO_ACCOUNT_SID;
_14const authToken = process.env.TWILIO_AUTH_TOKEN;
_14const client = require('twilio')(accountSid, authToken);
_14
_14client.messaging.v1.brandRegistrations
_14      .create({
_14         skipAutomaticSecVet: true,
_14         customerProfileBundleSid: 'BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX',
_14         a2PProfileBundleSid: 'BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
_14       })
_14      .then(brand_registration => console.log(brand_registration.sid));

Output


_29{
_29  "sid": "BN0044409f7e067e279523808d267e2d85",
_29  "account_sid": "AC78e8e67fc0246521490fb9907fd0c165",
_29  "customer_profile_bundle_sid": "BU0000009f7e067e279523808d267e2d90",
_29  "a2p_profile_bundle_sid": "BU1111109f7e067e279523808d267e2d85",
_29  "date_created": "2021-01-28T10:45:51Z",
_29  "date_updated": "2021-01-28T10:45:51Z",
_29  "brand_type": "STANDARD",
_29  "status": "PENDING",
_29  "tcr_id": "BXXXXXX",
_29  "failure_reason": "Registration error",
_29  "url": "https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85",
_29  "brand_score": 42,
_29  "brand_feedback": [
_29    "TAX_ID",
_29    "NONPROFIT"
_29  ],
_29  "identity_status": "VERIFIED",
_29  "russell_3000": true,
_29  "government_entity": false,
_29  "tax_exempt_status": "501c3",
_29  "skip_automatic_sec_vet": true,
_29  "errors": [],
_29  "mock": false,
_29  "links": {
_29    "brand_vettings": "https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/Vettings",
_29    "brand_registration_otps": "https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/SmsOtp"
_29  }
_29}

Fetch a specific BrandRegistration resource

GET https://messaging.twilio.com/v1/a2p/BrandRegistrations/{Sid}

This request returns a specific BrandRegistration. You can use this request to check the status of a BrandRegistration.

Parameters

URI parameters

Sidtype: SID<BN>Not PII

Path Parameter

The SID of the Brand Registration resource to fetch.

Fetch a BrandRegistration resource

Node.js

Python

Java

PHP

Ruby

twilio-cli

curl


_10// Download the helper library from https://www.twilio.com/docs/node/install
_10// Find your Account SID and Auth Token at twilio.com/console
_10// and set the environment variables. See http://twil.io/secure
_10const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10const authToken = process.env.TWILIO_AUTH_TOKEN;
_10const client = require('twilio')(accountSid, authToken);
_10
_10client.messaging.v1.brandRegistrations('BNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_10      .fetch()
_10      .then(brand_registration => console.log(brand_registration.sid));

Output


_29{
_29  "sid": "BNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_29  "account_sid": "AC78e8e67fc0246521490fb9907fd0c165",
_29  "customer_profile_bundle_sid": "BU3344409f7e067e279523808d267e2d85",
_29  "a2p_profile_bundle_sid": "BU3344409f7e067e279523808d267e2d85",
_29  "date_created": "2021-01-27T14:18:35Z",
_29  "date_updated": "2021-01-27T14:18:36Z",
_29  "brand_type": "STANDARD",
_29  "status": "PENDING",
_29  "tcr_id": "BXXXXXX",
_29  "failure_reason": "Registration error",
_29  "url": "https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85",
_29  "brand_score": 42,
_29  "brand_feedback": [
_29    "TAX_ID",
_29    "NONPROFIT"
_29  ],
_29  "identity_status": "VERIFIED",
_29  "russell_3000": true,
_29  "government_entity": false,
_29  "tax_exempt_status": "501c3",
_29  "skip_automatic_sec_vet": false,
_29  "mock": false,
_29  "errors": [],
_29  "links": {
_29    "brand_vettings": "https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/Vettings",
_29    "brand_registration_otps": "https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/SmsOtp"
_29  }
_29}

Read multiple BrandRegistration resources

GET https://messaging.twilio.com/v1/a2p/BrandRegistrations

This request returns a list of an Account's BrandRegistrations. If working with subaccounts, be sure to use the appropriate Account SID and Auth Token when sending this request.

Parameters

URI parameters

PageSizetype: integerNot PII

Query Parameter

How many resources to return in each list page. The default is 50, and the maximum is 1000.

Pagetype: integerNot PII

Query Parameter

The page index. This value is simply for client state.

PageTokentype: stringNot PII

Query Parameter

The page token. This is provided by the API.

List an Account's BrandRegistration Resources

Node.js

Python

Java

PHP

Ruby

twilio-cli

curl


_10// Download the helper library from https://www.twilio.com/docs/node/install
_10// Find your Account SID and Auth Token at twilio.com/console
_10// and set the environment variables. See http://twil.io/secure
_10const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10const authToken = process.env.TWILIO_AUTH_TOKEN;
_10const client = require('twilio')(accountSid, authToken);
_10
_10client.messaging.v1.brandRegistrations
_10  .list({limit: 20})
_10  .then(brandRegistrations => brandRegistrations.forEach(b => console.log(b.sid)));

Output


_42{
_42  "meta": {
_42    "page": 0,
_42    "page_size": 50,
_42    "first_page_url": "https://messaging.twilio.com/v1/a2p/BrandRegistrations?PageSize=50&Page=0",
_42    "previous_page_url": "https://messaging.twilio.com/v1/a2p/BrandRegistrations?PageSize=50&Page=0",
_42    "next_page_url": "https://messaging.twilio.com/v1/a2p/BrandRegistrations?PageSize=50&Page=1",
_42    "key": "data",
_42    "url": "https://messaging.twilio.com/v1/a2p/BrandRegistrations?PageSize=50&Page=0"
_42  },
_42  "data": [
_42    {
_42      "sid": "BN0044409f7e067e279523808d267e2d85",
_42      "account_sid": "AC78e8e67fc0246521490fb9907fd0c165",
_42      "customer_profile_bundle_sid": "BU3344409f7e067e279523808d267e2d85",
_42      "a2p_profile_bundle_sid": "BU3344409f7e067e279523808d267e2d85",
_42      "date_created": "2021-01-27T14:18:35Z",
_42      "date_updated": "2021-01-27T14:18:36Z",
_42      "brand_type": "STANDARD",
_42      "status": "APPROVED",
_42      "tcr_id": "BXXXXXX",
_42      "failure_reason": "Registration error",
_42      "url": "https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85",
_42      "brand_score": 42,
_42      "brand_feedback": [
_42        "TAX_ID",
_42        "NONPROFIT"
_42      ],
_42      "identity_status": "VERIFIED",
_42      "russell_3000": true,
_42      "tax_exempt_status": "501c3",
_42      "government_entity": false,
_42      "skip_automatic_sec_vet": false,
_42      "errors": [],
_42      "mock": false,
_42      "links": {
_42        "brand_vettings": "https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/Vettings",
_42        "brand_registration_otps": "https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/SmsOtp"
_42      }
_42    }
_42  ]
_42}

Update a BrandRegistration resource

POST https://messaging.twilio.com/v1/a2p/BrandRegistrations/{Sid}

Parameters

URI parameters

Sidtype: SID<BN>Not PII

Path Parameter

The SID of the Brand Registration resource to update.

Update a BrandRegistration Resource

Node.js

Python

Java

PHP

Ruby

twilio-cli

curl


_10// Download the helper library from https://www.twilio.com/docs/node/install
_10// Find your Account SID and Auth Token at twilio.com/console
_10// and set the environment variables. See http://twil.io/secure
_10const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10const authToken = process.env.TWILIO_AUTH_TOKEN;
_10const client = require('twilio')(accountSid, authToken);
_10
_10client.messaging.v1.brandRegistrations('BNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_10      .update()
_10      .then(brand_registration => console.log(brand_registration.sid));

Output


_29{
_29  "sid": "BNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_29  "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_29  "customer_profile_bundle_sid": "BU3344409f7e067e279523808d267e2d85",
_29  "a2p_profile_bundle_sid": "BU3344409f7e067e279523808d267e2d85",
_29  "date_created": "2021-01-27T14:18:35Z",
_29  "date_updated": "2021-01-27T14:18:36Z",
_29  "brand_type": "STANDARD",
_29  "status": "PENDING",
_29  "tcr_id": "BXXXXXX",
_29  "failure_reason": "Registration error",
_29  "url": "https://messaging.twilio.com/v1/a2p/BrandRegistrations/BNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_29  "brand_score": 42,
_29  "brand_feedback": [
_29    "TAX_ID",
_29    "NONPROFIT"
_29  ],
_29  "identity_status": "VERIFIED",
_29  "russell_3000": false,
_29  "government_entity": false,
_29  "tax_exempt_status": "501c3",
_29  "skip_automatic_sec_vet": false,
_29  "errors": [],
_29  "mock": false,
_29  "links": {
_29    "brand_vettings": "https://messaging.twilio.com/v1/a2p/BrandRegistrations/BNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Vettings",
_29    "brand_registration_otps": "https://messaging.twilio.com/v1/a2p/BrandRegistrations/BNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/SmsOtp"
_29  }
_29}