> ## Documentation Index
> Fetch the complete documentation index at: https://www.vobiz.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Request brand authentication

> Starts the registry's brand authentication for a brand whose `brandType` is `TENDLC_PUBLIC_COMPANY`.



## OpenAPI

````yaml openapi-sms.yaml POST /10dlc/brands/{id}/brand-auth-verification
openapi: 3.0.3
info:
  title: Vobiz Messaging API
  description: >
    Send and receive SMS, MMS and RCS messages, buy messaging numbers, register
    for

    US 10DLC and toll-free, run broadcasts, manage conversations, opt-outs and
    webhooks.


    **Base URL:** `https://api.vobiz.ai/api/v1/sms`


    **Authentication:** every request needs the `X-Auth-ID` and `X-Auth-Token`
    headers.

    The account is taken from your credentials; you never put an account ID in a
    path or body.

    Field names in this API are camelCase.
  version: '1.0'
  contact:
    email: support@vobiz.ai
    url: https://vobiz.ai
servers:
  - url: https://api.vobiz.ai/api/v1/sms
    description: Production
security:
  - AuthID: []
    AuthToken: []
tags:
  - name: Messages
    description: Send messages and inspect their delivery state.
  - name: Numbers
    description: >-
      Messaging-capable numbers on your account, inventory search, purchase and
      release.
  - name: Coverage
    description: Where you can send, per country.
  - name: Conversations
    description: Two-way threads between one of your numbers and a contact.
  - name: Opt-outs
    description: Numbers that must not receive messages on a channel.
  - name: Webhooks
    description: Subscriptions that deliver message and broadcast events to your server.
  - name: Broadcasts
    description: Bulk sends from an uploaded recipient list.
  - name: RCS Senders
    description: RCS sender (agent) identities and their message templates.
  - name: 10DLC Brands
    description: US 10DLC brand registration.
  - name: 10DLC Campaigns
    description: US 10DLC campaigns, toll-free verification and supporting documents.
paths:
  /10dlc/brands/{id}/brand-auth-verification:
    post:
      tags:
        - 10DLC Brands
      summary: Request brand authentication
      description: >-
        Starts the registry's brand authentication for a brand whose `brandType`
        is `TENDLC_PUBLIC_COMPANY`. The registry sends a two-factor verification
        request to the brand's `businessContactEmail`, and the brand shows
        `registrationStatus` `PENDING_2FA` until the contact completes it. The
        request has no body and returns `202` with `{"status":"requested"}`. Any
        other brand type returns `400` with `invalid request: brand
        authentication is only available for TENDLC_PUBLIC_COMPANY brands`.
      operationId: brand-auth-verification
      parameters:
        - name: id
          in: path
          required: true
          description: >-
            Brand ID (UUID) returned by `POST /10dlc/brands`. An unknown ID, an
            ID from another account, or a value that is not a UUID returns `404`
            with `{"error":"brand not found"}`.
          schema:
            type: string
            format: uuid
          example: 8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10
      responses:
        '202':
          description: >-
            The request was accepted. Track progress with `GET
            /10dlc/brands/{id}/registrar-statuses`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BrandAuthRequested'
              example:
                status: requested
        '400':
          description: The brand is not a public company.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: >-
                  invalid request: brand authentication is only available for
                  TENDLC_PUBLIC_COMPANY brands
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          description: The brand does not exist on your account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: brand not found
        '422':
          description: >-
            The US 10DLC registry declined the request. `error` carries the
            registry's description.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenDLCError'
              example:
                error: >-
                  registration provider rejected the request: brand is not yet
                  submitted
                providerError: 'registration error 403 (HTTP 403): brand is not yet submitted'
        '500':
          $ref: '#/components/responses/ServerError'
        '502':
          description: The US 10DLC registry did not answer. Retry the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenDLCError'
              example:
                error: registration provider unavailable
                providerError: 'registration error 500 (HTTP 500): upstream timeout'
      x-codeSamples:
        - lang: typescript
          label: Node SDK
          source: >
            import { VobizClient } from "@vobiz/sdk";


            const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken:
            "YOUR_AUTH_TOKEN" });


            await client.sms.brands.brandAuthVerification({
                id: "8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10"
            })
        - lang: python
          label: Python SDK
          source: |
            from vobiz import Vobiz

            client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

            client.sms.brands.brand_auth_verification(
                id="8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10",
            )
        - lang: go
          label: Go SDK
          source: |
            import (
                "context"

                vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
                "github.com/vobiz-ai/Vobiz-Go-SDK/client"
                "github.com/vobiz-ai/Vobiz-Go-SDK/option"
                "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
            )

            c := client.NewClient(
                option.WithAPIKey("MA_XXXXXXXX"),
                option.WithAuthToken("YOUR_AUTH_TOKEN"),
            )

            request := &sms.BrandAuthVerificationRequest{
                    ID: "8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10",
                }
            c.Sms.Brands.BrandAuthVerification(
                    context.TODO(),
                    request,
                )
        - lang: java
          label: Java SDK
          source: |
            import com.vobiz.api.VobizApiClient;

            VobizApiClient client = VobizApiClient
                .builder()
                .apiKey("MA_XXXXXXXX")
                .authToken("YOUR_AUTH_TOKEN")
                .build();

            client.sms().brands().brandAuthVerification(
                "8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10",
                BrandAuthVerificationRequest
                    .builder()
                    .build()
            );
        - lang: ruby
          label: Ruby SDK
          source: >
            require 'vobiz'


            client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token:
            'YOUR_AUTH_TOKEN')


            client.sms.brands.brand_auth_verification(id:
            "8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10")
        - lang: csharp
          label: C# SDK
          source: |
            using Vobiz;
            using Vobiz.Sms;

            var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

            await client.Sms.Brands.BrandAuthVerificationAsync(
                new BrandAuthVerificationRequest { Id = "8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10" }
            );
        - lang: php
          label: PHP SDK
          source: >
            <?php


            require 'vendor/autoload.php';


            use Vobiz\VobizClient;


            $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken:
            'YOUR_AUTH_TOKEN');


            $client->sms->brands->brandAuthVerification(
                '8e6c4a2f-0d9b-4b7a-a5c3-1e9f7d5b3a10',
            );
components:
  schemas:
    BrandAuthRequested:
      type: object
      properties:
        status:
          type: string
          example: requested
          description: >-
            Always `requested`. Follow the result in the brand's
            `registrationStatus` or in `GET
            /10dlc/brands/{id}/registrar-statuses`.
      description: >-
        Acknowledgement that the registry accepted a brand-authentication or 2FA
        resend request. The outcome arrives later on the brand.
    Error:
      type: object
      description: >-
        The body of every error response: a flat object with one `error` string
        that explains what went wrong. Use the HTTP status code to decide how to
        handle the error, and log `error` for diagnosis.
      required:
        - error
      properties:
        error:
          type: string
          example: 'recipient has opted out: +14155550123'
          description: >-
            Human-readable explanation of the error, for example `phoneNumber is
            required` or `recipient has opted out: +14155550123`. Branch on the
            HTTP status code rather than on this text.
    TenDLCError:
      description: >-
        Error returned when the US 10DLC registry declines or cannot process a
        request. `error` is a human-readable message you can show or log. When
        the registry answers with `400`, `404`, `409`, `422` or `429`, the same
        status is passed through with this body; `502` means the registry did
        not answer and `503` means it did not accept Vobiz's service
        credentials.
      allOf:
        - $ref: '#/components/schemas/Error'
        - type: object
          properties:
            providerError:
              type: string
              description: >-
                Opaque diagnostic string you can quote to support. Do not parse
                it.
              example: 'registration error 400 (HTTP 400): brand legalName is required'
  responses:
    Unauthorized:
      description: Missing or invalid `X-Auth-ID` / `X-Auth-Token`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: missing or invalid credentials
    ServerError:
      description: Unexpected error. Retry with the same idempotency key where one applies.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: internal error
  securitySchemes:
    AuthID:
      type: apiKey
      in: header
      name: X-Auth-ID
      description: Your Vobiz account Auth ID (`MA_XXXXXXXX`).
    AuthToken:
      type: apiKey
      in: header
      name: X-Auth-Token
      description: Your Vobiz account Auth Token.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.