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

# Unified cross-channel brand trust posture

> Returns one consolidated brand-identity verification posture across every trust channel (10DLC, toll-free, WhatsApp, RCS, branded calling, number regulatory KYC), rolled up into a single trust score + prioritized next-action list. Every source read is fail-soft — one degraded subsystem never blanks the hub.



## OpenAPI

````yaml /openapi.yaml get /api/v1/brand-identity/status
openapi: 3.1.0
info:
  title: Devotel CPaaS API
  description: Orbit by Devotel — Communications Platform as a Service API
  version: 1.0.0
  contact:
    name: Devotel
    url: https://devotel.io
    email: support@devotel.io
  license:
    name: Proprietary
servers:
  - url: https://api.orbit.devotel.io
    description: Production
security:
  - Bearer: []
  - ApiKey: []
tags:
  - name: Messages
    description: >-
      Send and manage messages across all channels (SMS, WhatsApp, RCS, Email,
      Viber, etc.)
  - name: Fax
    description: >-
      List and track fax (MMS/T.38) transmissions on Telnyx-backed fax numbers
      (sending flows through the Messaging API)
  - name: Agents
    description: AI agent creation, configuration, and execution
  - name: Voice
    description: Voice calls, IVR, conferencing, and SIP trunking
  - name: OnCall
    description: On-call rotations and escalation policy planning for incident alerting
  - name: Webhooks
    description: Webhook endpoint management and delivery logs
  - name: Numbers
    description: Phone number search, provisioning, and configuration
  - name: Brand Identity
    description: >-
      Unified cross-channel brand trust posture (10DLC, toll-free, WhatsApp,
      RCS, branded calling, number KYC)
  - name: Contacts
    description: Contact management, segmentation, and lifecycle tracking
  - name: Campaigns
    description: Marketing campaign orchestration and analytics
  - name: Flows
    description: Automation flow builder and execution engine
  - name: Templates
    description: Message template management and approval workflows
  - name: Settings
    description: Organization, channel, and user preference settings
  - name: Verify
    description: OTP generation and verification across channels
  - name: Push
    description: Push notification delivery via FCM and APNs
  - name: Integrations
    description: Third-party service connections and OAuth management
  - name: CDP
    description: >-
      Customer Data Platform — activation surface (CRM object sync, streaming
      destinations, ad-audience activation)
  - name: Files
    description: >-
      Server-to-server media upload, listing, retrieval, and deletion
      (signed-URL backed)
  - name: Commerce
    description: >-
      Omnichannel conversational-commerce — persistent cart + checkout state
      machine, channel-agnostic hosted pay-by-link, native WhatsApp checkout,
      and AP2-style agent payment mandates.
  - name: Sync
    description: >-
      Real-time shared-state primitive (Twilio Sync parity) — Documents, Maps,
      Lists, and ephemeral Streams, with change events relayed over the
      /api/v1/ws/sync WebSocket gateway
paths:
  /api/v1/brand-identity/status:
    get:
      tags:
        - Brand Identity
      summary: Unified cross-channel brand trust posture
      description: >-
        Returns one consolidated brand-identity verification posture across
        every trust channel (10DLC, toll-free, WhatsApp, RCS, branded calling,
        number regulatory KYC), rolled up into a single trust score +
        prioritized next-action list. Every source read is fail-soft — one
        degraded subsystem never blanks the hub.
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                  - meta
                properties:
                  data:
                    type: object
                    required:
                      - summary
                      - channels
                      - nextActions
                    properties:
                      summary:
                        type: object
                        required:
                          - applicable
                          - verified
                          - inProgress
                          - actionRequired
                          - notStarted
                          - trustScore
                          - overallState
                        properties:
                          applicable:
                            type: integer
                            description: >-
                              Channels that count toward scoring (all except
                              unavailable).
                          verified:
                            type: integer
                          inProgress:
                            type: integer
                          actionRequired:
                            type: integer
                          notStarted:
                            type: integer
                          trustScore:
                            type: integer
                            minimum: 0
                            maximum: 100
                            description: >-
                              verified / applicable, rounded. 0 when nothing is
                              applicable.
                          overallState:
                            type: string
                            enum:
                              - not_started
                              - in_progress
                              - verified
                              - action_required
                              - unavailable
                      channels:
                        type: array
                        items:
                          type: object
                          required:
                            - key
                            - label
                            - pillar
                            - state
                            - manageHref
                          properties:
                            key:
                              type: string
                              enum:
                                - messaging_10dlc
                                - messaging_toll_free
                                - branded_calling
                                - rcs_business
                                - whatsapp_business
                                - number_regulatory
                            label:
                              type: string
                            pillar:
                              type: string
                              enum:
                                - messaging
                                - voice
                            state:
                              type: string
                              enum:
                                - not_started
                                - in_progress
                                - verified
                                - action_required
                                - unavailable
                            detail:
                              type:
                                - string
                                - 'null'
                              description: >-
                                Short tenant-facing detail, e.g. '2 of 3
                                number(s) verified'.
                            reason:
                              type:
                                - string
                                - 'null'
                              description: >-
                                Provider rejection reason / required action when
                                state is action_required.
                            verifiedAt:
                              type:
                                - string
                                - 'null'
                              format: date-time
                              description: >-
                                ISO timestamp the brand was verified on this
                                channel.
                            manageHref:
                              type: string
                              description: >-
                                Deep-link path the dashboard uses to drive this
                                channel.
                      nextActions:
                        type: array
                        items:
                          type: object
                          required:
                            - channel
                            - label
                            - href
                            - priority
                          properties:
                            channel:
                              type: string
                              enum:
                                - messaging_10dlc
                                - messaging_toll_free
                                - branded_calling
                                - rcs_business
                                - whatsapp_business
                                - number_regulatory
                            label:
                              type: string
                            href:
                              type: string
                            priority:
                              type: string
                              enum:
                                - urgent
                                - todo
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: date-time
components:
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Dashboard JWT token from Clerk
    ApiKey:
      type: apiKey
      name: X-API-Key
      in: header
      description: Server-to-server API key (dv_live_sk_*)

````