Skip to contentSkip to navigationSkip to topbar
Twilio Docs
Rate this page:
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

Property nameTypePIIDescription
account_sidSID<AC>
Not PII

The SID of the Account that created the vetting record.

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34
brand_sidSID<BN>
Not PII

The unique string to identify Brand Registration.

Pattern: ^BN[0-9a-fA-F]{32}$Min length: 34Max length: 34
brand_vetting_sidSID<VT>
Not PII

The Twilio SID of the third-party vetting record.

Pattern: ^VT[0-9a-fA-F]{32}$Min length: 34Max length: 34
date_updatedstring<date-time>
Not PII

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

date_createdstring<date-time>
Not PII

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

vetting_idstring
Not PII

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

vetting_classstring
Not PII

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

vetting_statusstring
Not PII

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

vetting_providerenum<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
urlstring<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.

Path parameters

Property nameTypeRequiredPIIDescription
BrandSidSID<BN>required
Not PII

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

Pattern: ^BN[0-9a-fA-F]{32}$Min length: 34Max length: 34

Request body parameters

Property nameTypeRequiredPIIDescription
VettingProviderenum<string>required
Not PII

The third-party provider of the vettings to create .

Possible values:
campaign-verify
VettingIdstringOptional
Not PII

The unique ID of the vetting

Create a BrandVetting resource for a 527 political organization

Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_22
// Download the helper library from https://www.twilio.com/docs/node/install
_22
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_22
_22
// Find your Account SID and Auth Token at twilio.com/console
_22
// and set the environment variables. See http://twil.io/secure
_22
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_22
const authToken = process.env.TWILIO_AUTH_TOKEN;
_22
const client = twilio(accountSid, authToken);
_22
_22
async function createBrandVetting() {
_22
const brandVetting = await client.messaging.v1
_22
.brandRegistrations("BNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
_22
.brandVettings.create({
_22
vettingId:
_22
"cv|1.0|tcr|10dlc|9975c339-d46f-49b7-a399-2e6d5ebac66d|EXAMPLEjEd8xSlaAgRXAXXBUNBT2AgL-LdQuPveFhEyY",
_22
vettingProvider: "campaign-verify",
_22
});
_22
_22
console.log(brandVetting.accountSid);
_22
}
_22
_22
createBrandVetting();

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.

Path parameters

Property nameTypeRequiredPIIDescription
BrandSidSID<BN>required
Not PII

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

Pattern: ^BN[0-9a-fA-F]{32}$Min length: 34Max length: 34
BrandVettingSidSID<VT>required
Not PII

The Twilio SID of the third-party vetting record.

Pattern: ^VT[0-9a-fA-F]{32}$Min length: 34Max length: 34

Fetch a specific BrandVetting resource

Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_19
// Download the helper library from https://www.twilio.com/docs/node/install
_19
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_19
_19
// Find your Account SID and Auth Token at twilio.com/console
_19
// and set the environment variables. See http://twil.io/secure
_19
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_19
const authToken = process.env.TWILIO_AUTH_TOKEN;
_19
const client = twilio(accountSid, authToken);
_19
_19
async function fetchBrandVetting() {
_19
const brandVetting = await client.messaging.v1
_19
.brandRegistrations("BNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
_19
.brandVettings("VTXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
_19
.fetch();
_19
_19
console.log(brandVetting.accountSid);
_19
}
_19
_19
fetchBrandVetting();

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.

Path parameters

Property nameTypeRequiredPIIDescription
BrandSidSID<BN>required
Not PII

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

Pattern: ^BN[0-9a-fA-F]{32}$Min length: 34Max length: 34

Query parameters

Property nameTypeRequiredPIIDescription
VettingProviderenum<string>Optional
Not PII

The third-party provider of the vettings to read

Possible values:
campaign-verify
PageSizeintegerOptional
Not PII

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

Minimum: 1Maximum: 1000
PageintegerOptional
Not PII

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

Minimum: 0
PageTokenstringOptional
Not PII

The page token. This is provided by the API.

List all BrandVetting resources for a specific BrandRegistration resource

Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_18
// Download the helper library from https://www.twilio.com/docs/node/install
_18
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_18
_18
// Find your Account SID and Auth Token at twilio.com/console
_18
// and set the environment variables. See http://twil.io/secure
_18
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_18
const authToken = process.env.TWILIO_AUTH_TOKEN;
_18
const client = twilio(accountSid, authToken);
_18
_18
async function listBrandVetting() {
_18
const brandVettings = await client.messaging.v1
_18
.brandRegistrations("BNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
_18
.brandVettings.list({ limit: 20 });
_18
_18
brandVettings.forEach((b) => console.log(b.accountSid));
_18
}
_18
_18
listBrandVetting();

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": null,
_25
"next_page_url": null,
_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
}

Rate this page: