Create brand vetting

POST /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 create .

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

application/x-www-form-urlencoded

Body

  • VettingProvider string Required

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

    Values are campaign-verify or aegis.

  • VettingId string

    The unique ID of the vetting

Responses

  • 201 application/json

    Created

    Hide headers attributes Show headers attributes
    • Access-Control-Allow-Origin string

      Specify the origin(s) allowed to access the resource

    • Access-Control-Allow-Methods string

      Specify the HTTP methods allowed when accessing the resource

    • Access-Control-Allow-Headers string

      Specify the headers allowed when accessing the resource

    • Access-Control-Allow-Credentials boolean

      Indicates whether the browser should include credentials

    • Access-Control-Expose-Headers string

      Headers exposed to the client

    Hide response attributes Show response attributes object
    • account_sid string | null

      The SID of the Account that created the vetting record.

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

    • brand_sid string | null

      The unique string to identify Brand Registration.

      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

      The Twilio SID of the 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_updated string(date-time) | null

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

    • date_created string(date-time) | null

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

    • vetting_id string | null

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

    • vetting_class string | null

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

    • vetting_status string | null

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

    • vetting_provider string

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

      Values are campaign-verify or aegis.

    • url string(uri) | null

      The absolute URL of the Brand Vetting resource.

  • 202 application/json

    Accepted

    Hide headers attributes Show headers attributes
    • Access-Control-Allow-Origin string

      Specify the origin(s) allowed to access the resource

    • Access-Control-Allow-Methods string

      Specify the HTTP methods allowed when accessing the resource

    • Access-Control-Allow-Headers string

      Specify the headers allowed when accessing the resource

    • Access-Control-Allow-Credentials boolean

      Indicates whether the browser should include credentials

    • Access-Control-Expose-Headers string

      Headers exposed to the client

    Hide response attributes Show response attributes object
    • account_sid string | null

      The SID of the Account that created the vetting record.

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

    • brand_sid string | null

      The unique string to identify Brand Registration.

      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

      The Twilio SID of the 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_updated string(date-time) | null

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

    • date_created string(date-time) | null

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

    • vetting_id string | null

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

    • vetting_class string | null

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

    • vetting_status string | null

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

    • vetting_provider string

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

      Values are campaign-verify or aegis.

    • url string(uri) | null

      The absolute URL of the Brand Vetting resource.

POST /v1/a2p/BrandRegistrations/{BrandSid}/Vettings
curl \
 --request POST 'https://messaging.twilio.com/v1/a2p/BrandRegistrations/{BrandSid}/Vettings' \
 --user "username:password" \
 --header "Content-Type: application/x-www-form-urlencoded" \
 --data 'VettingId=cv%7C1.0%7Ctcr%7C10dlc%7C9975c339-d46f-49b7-a399-EXAMPLETOKEN%7CGQ3EXAMPLETOKENAXXBUNBT2AgL-LdQuPveFhEyY&VettingProvider=campaign-verify'
Request examples
{"VettingId"=>"cv|1.0|tcr|10dlc|9975c339-d46f-49b7-a399-EXAMPLETOKEN|GQ3EXAMPLETOKENAXXBUNBT2AgL-LdQuPveFhEyY", "VettingProvider"=>"campaign-verify"}
{"VettingId"=>"cv|1.0|tcr|10dlc|9975c339-d46f-49b7-a399-EXAMPLETOKEN|GQ3EXAMPLETOKENAXXBUNBT2AgL-LdQuPveFhEyY", "VettingProvider"=>"campaign-verify"}
Response examples (201)
{
  "url": "https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/Vettings/VT12445353",
  "brand_sid": "BN0044409f7e067e279523808d267e2d85",
  "vetting_id": "cv|1.0|tcr|10dlc|9975c339-d46f-49b7-a399-EXAMPLETOKEN|GQ3EXAMPLETOKENAXXBUNBT2AgL-LdQuPveFhEyY",
  "account_sid": "AC78e8e67fc0246521490fb9907fd0c165",
  "date_created": "2021-01-27T14:18:35Z",
  "date_updated": "2021-01-27T14:18:35Z",
  "vetting_class": "POLITICAL",
  "vetting_status": "IN_PROGRESS",
  "vetting_provider": "campaign-verify",
  "brand_vetting_sid": "VT12445353"
}
Response examples (202)
{
  "url": "https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/Vettings/VT12445353",
  "brand_sid": "BN0044409f7e067e279523808d267e2d85",
  "vetting_id": "cv|1.0|tcr|10dlc|9975c339-d46f-49b7-a399-EXAMPLETOKEN|GQ3EXAMPLETOKENAXXBUNBT2AgL-LdQuPveFhEyY",
  "account_sid": "AC78e8e67fc0246521490fb9907fd0c165",
  "date_created": "2021-01-27T14:18:35Z",
  "date_updated": "2021-01-27T14:18:35Z",
  "vetting_class": "POLITICAL",
  "vetting_status": "IN_PROGRESS",
  "vetting_provider": "campaign-verify",
  "brand_vetting_sid": "VT12445353"
}