On this page

A2P 10DLC - BrandVetting Resource

(warning)

Warning

This API Reference page is meant to supplement the A2P 10DLC Government and Nonprofit Onboarding Guide.

Do not attempt to use this API resource without following the appropriate guide, or you may incur delays in registration and unintended fees.

The BrandVetting resource represents the association between a Campaign Verify token and a BrandRegistration resource.

The BrandVetting resource is a subresource of the BrandRegistration resource.

BrandVetting Properties

Resource properties

account_sidtype: SID<AC>

Not PII

The SID of the Account that created the vetting record.

brand_sidtype: SID<BN>

Not PII

The unique string to identify Brand Registration.

brand_vetting_sidtype: SID<VT>

Not PII

The Twilio SID of the third-party vetting record.

date_updatedtype: string<date-time>

Not PII

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

date_createdtype: string<date-time>

Not PII

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

vetting_idtype: string

Not PII

The unique identifier of the vetting from the third-party provider.

vetting_classtype: string

Not PII

The type of vetting that has been conducted. One of “STANDARD” (Aegis) or “POLITICAL” (Campaign Verify).

vetting_statustype: string

Not PII

The status of the import vetting attempt. One of “PENDING,” “SUCCESS,” or “FAILED”.

vetting_providertype: enum<string>

Not PII

The third-party provider that has conducted the vetting. One of “CampaignVerify” (Campaign Verify tokens) or “AEGIS” (Secondary Vetting).

Possible values:

campaign-verify

urltype: string<uri>

Not PII

The absolute URL of the Brand Vetting resource.

Create a BrandVetting resource

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

This API request creates a BrandVetting resource. This associates a BrandRegistration resource and a Campaign Verify token.

The VettingProvider is campaign-verify, and the Campaign Verify token is provided in the VettingId parameter.

Parameters

URI parameters

BrandSidtype: SID<BN>

Path ParameterNot PII

The SID of the Brand Registration resource of the vettings to create .

Request body parameters

VettingProvidertype: enum<string>Required

Not PII

The third-party provider of the vettings to create .

Possible values:

campaign-verify

VettingIdtype: string

Not PII

The unique ID of the vetting

Create a BrandVetting resource for a 527 political organization

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('BNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_14  .brandVettings
_14  .create({
_14     vettingId: 'cv|1.0|tcr|10dlc|9975c339-d46f-49b7-a399-2e6d5ebac66d|EXAMPLEjEd8xSlaAgRXAXXBUNBT2AgL-LdQuPveFhEyY',
_14     vettingProvider: 'campaign-verify'
_14   })
_14  .then(brand_vetting => console.log(brand_vetting.brandSid));

Output


_12{
_12  "account_sid": "AC78e8e67fc0246521490fb9907fd0c165",
_12  "brand_sid": "BNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_12  "brand_vetting_sid": "VT12445353",
_12  "vetting_provider": "campaign-verify",
_12  "vetting_id": "cv|1.0|tcr|10dlc|9975c339-d46f-49b7-a399-2e6d5ebac66d|EXAMPLEjEd8xSlaAgRXAXXBUNBT2AgL-LdQuPveFhEyY",
_12  "vetting_class": "POLITICAL",
_12  "vetting_status": "IN_PROGRESS",
_12  "date_created": "2021-01-27T14:18:35Z",
_12  "date_updated": "2021-01-27T14:18:35Z",
_12  "url": "https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/Vettings/VT12445353"
_12}

(warning)

Warning

Don't create a UsAppToPerson resource until the BrandVetting resource's vetting_status is SUCCESS.

You can check the vetting_status of the BrandVetting resource using the Fetch request below.

Once the BrandVetting status is SUCCESS, the Campaign Verify token has been successfully associated with your Brand. This allows you to use the POLITICAL special use case.

Fetch a specific BrandVetting resource

GET https://messaging.twilio.com/v1/a2p/BrandRegistrations/{BrandSid}/Vettings/{BrandVettingSid}

This API request fetches an individual BrandVetting resource using a BrandVettingSid .

You can use this request to check the vetting_status of a BrandVetting resource.

Parameters

URI parameters

BrandSidtype: SID<BN>

Path ParameterNot PII

The SID of the Brand Registration resource of the vettings to read .

BrandVettingSidtype: SID<VT>

Path ParameterNot PII

The Twilio SID of the third-party vetting record.

Fetch a specific BrandVetting resource

Node.js

Python

Java

PHP

Ruby

twilio-cli

curl


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

Output


_12{
_12  "account_sid": "AC78e8e67fc0246521490fb9907fd0c165",
_12  "brand_sid": "BNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_12  "brand_vetting_sid": "VTXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_12  "vetting_provider": "campaign-verify",
_12  "vetting_id": "cv|1.0|tcr|10dlc|9975c339-d46f-49b7-a399-EXAMPLETOKEN|GQ3EXAMPLETOKENAXXBUNBT2AgL-LdQuPveFhEyY",
_12  "vetting_class": "POLITICAL",
_12  "vetting_status": "IN_PROGRESS",
_12  "date_created": "2021-01-27T14:18:35Z",
_12  "date_updated": "2021-01-27T14:18:35Z",
_12  "url": "https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/Vettings/VT12445353"
_12}

List all BrandVetting resources

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

This request returns all BrandVetting resources associated with a BrandRegistration resource.

Parameters

URI parameters

BrandSidtype: SID<BN>

Path ParameterNot PII

The SID of the Brand Registration resource of the vettings to read .

VettingProvidertype: enum<string>

Query ParameterNot PII

The third-party provider of the vettings to read

Possible values:

campaign-verify

PageSizetype: integer

Query ParameterNot PII

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

Pagetype: integer

Query ParameterNot PII

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

PageTokentype: string

Query ParameterNot PII

The page token. This is provided by the API.

List all BrandVetting resources for a specific BrandRegistration resource

Node.js

Python

Java

PHP

Ruby

twilio-cli

curl


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

Output


_25{
_25  "meta": {
_25    "page": 0,
_25    "page_size": 50,
_25    "first_page_url": "https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/Vettings?PageSize=50&Page=0",
_25    "previous_page_url": "https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/Vettings?PageSize=50&Page=0",
_25    "next_page_url": "https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/Vettings?PageSize=50&Page=1",
_25    "key": "data",
_25    "url": "https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/Vettings?PageSize=50&Page=0"
_25  },
_25  "data": [
_25    {
_25      "account_sid": "AC78e8e67fc0246521490fb9907fd0c165",
_25      "brand_sid": "BN0044409f7e067e279523808d267e2d85",
_25      "brand_vetting_sid": "VT12445353",
_25      "vetting_provider": "campaign-verify",
_25      "vetting_id": "cv|1.0|tcr|10dlc|9975c339-d46f-49b7-a399-EXAMPLETOKEN|GQ3EXAMPLETOKENAXXBUNBT2AgL-LdQuPveFhEyY",
_25      "vetting_class": "POLITICAL",
_25      "vetting_status": "IN_PROGRESS",
_25      "date_created": "2021-01-27T14:18:35Z",
_25      "date_updated": "2021-01-27T14:18:35Z",
_25      "url": "https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/Vettings/VT12445353"
_25    }
_25  ]
_25}