List brand vetting

GET /v1/a2p/BrandRegistrations/{BrandSid}/Vettings

A Messaging Service resource to add and get Brand Vettings.

Path parameters

  • BrandSid string Required

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

Query parameters

  • VettingProvider string

    The third-party provider of the vettings to read

    Value is campaign-verify.

  • PageSize integer

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

    Minimum value is 1, maximum value is 1000.

Responses

  • • 200

    OK

    Hide response attributes Show response attributes object
    • data array[object]
      Hide data attributes Show data attributes
      • account_sid string | null

        The SID of the Account that created the vetting

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

      • brand_sid string | null

        A2P BrandRegistration Sid

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

      • brand_vetting_sid string | null

        SID for third-party vetting record

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

      • date_created string(date-time) | null

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

      • date_updated string(date-time) | null

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

      • url string(uri) | null

        The absolute URL of the Brand Vetting

      • vetting_class string | null

        The type of vetting

      • vetting_id string | null

        The unique ID of the vetting

      • vetting_provider string | null

        Third-party provider that has conducted the vetting

        Value is campaign-verify.

      • vetting_status string | null

        Status of vetting attempt

    • meta object
      Hide meta attributes Show meta attributes
GET /v1/a2p/BrandRegistrations/{BrandSid}/Vettings 
curl \
 -X GET https://messaging.twilio.com/v1/a2p/BrandRegistrations/{BrandSid}/Vettings \
 --user "username:password"
Response examples (200) 
{
  "data": [
    {
      "account_sid": "string",
      "brand_sid": "string",
      "brand_vetting_sid": "string",
      "date_created": "2023-05-04T09:42:00+00:00",
      "date_updated": "2023-05-04T09:42:00+00:00",
      "url": "https://example.com",
      "vetting_class": "string",
      "vetting_id": "string",
      "vetting_provider": "campaign-verify",
      "vetting_status": "string"
    }
  ],
  "meta": {
    "first_page_url": "https://example.com",
    "key": "string",
    "next_page_url": "https://example.com",
    "page": 42,
    "page_size": 42,
    "previous_page_url": "https://example.com",
    "url": "https://example.com"
  }
}