Path parameters

• BrandSid string Required

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

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

Query parameters

• VettingProvider string

  The third-party provider of the vettings to read

  Values are campaign-verify or aegis.

Responses

• 200 application/json

  OK

  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

  • data array[object]
    Hide data attributes Show data 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.

  • meta object
    Hide meta attributes Show meta attributes object

    • first_page_url string(uri)
    • key string
    • next_page_url string(uri) | null
    • page integer
    • page_size integer
    • previous_page_url string(uri) | null
    • url string(uri)