> ## 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.

# Lint a 10DLC brand and campaign before submitting to TCR

> Scores an ad-hoc 10DLC brand and campaign payload against known TCR and carrier rejection patterns BEFORE you pay the vetting fee, returning a 0-100 score, an aggregate verdict, and per-field findings with concrete rewrite suggestions. It is a pure lint — it never submits to TCR. Use it to catch common rejections (missing opt-out, shortener links, use-case mismatch) up front.



## OpenAPI

````yaml /openapi.yaml post /api/v1/compliance/10dlc/preflight
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
  - name: Risk
    description: >-
      Unified cross-channel Trust & Fraud risk scoring — fuses SMS-pumping,
      URL-reputation, Verify Fraud Guard, and Voice Biometrics signals into one
      composite verdict queryable before a send or a call.
  - name: Orby
    description: >-
      In-dashboard Orby operator assistant: streamed assistant turns,
      conversation threads, product knowledge-base search, and the tool-action
      approval gate. Available to signed-in operators only (dashboard session
      auth — API-key requests are rejected).
paths:
  /api/v1/compliance/10dlc/preflight:
    post:
      tags:
        - Compliance
      summary: Lint a 10DLC brand and campaign before submitting to TCR
      description: >-
        Scores an ad-hoc 10DLC brand and campaign payload against known TCR and
        carrier rejection patterns BEFORE you pay the vetting fee, returning a
        0-100 score, an aggregate verdict, and per-field findings with concrete
        rewrite suggestions. It is a pure lint — it never submits to TCR. Use it
        to catch common rejections (missing opt-out, shortener links, use-case
        mismatch) up front.
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                brand:
                  type: object
                  additionalProperties: true
                campaign:
                  type: object
                  additionalProperties: true
                brand_vetting_score:
                  type: number
                  nullable: true
                  minimum: 0
                  maximum: 100
            example:
              campaign:
                usecase: MARKETING
                sample_message:
                  - 'Acme: 20% off today. Reply STOP to opt out.'
              brand_vetting_score: 75
      responses:
        '200':
          description: Preflight lint result for the supplied payload.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      score:
                        type: integer
                      verdict:
                        type: string
                        enum:
                          - pass
                          - warn
                          - block
                      findings:
                        type: array
                        items:
                          type: object
                          properties:
                            ruleId:
                              type: string
                            severity:
                              type: string
                              enum:
                                - error
                                - warn
                                - info
                            field:
                              type: string
                            message:
                              type: string
                            match:
                              type: string
                            suggestion:
                              type: string
                      engine:
                        type: string
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
              example:
                data:
                  score: 82
                  verdict: warn
                  findings:
                    - ruleId: campaign.sample_message.missing_optout
                      severity: warn
                      field: campaign.sample_message[0]
                      message: Sample message should reference STOP to opt out.
                      suggestion: Reply STOP to unsubscribe.
                  engine: tcr-preflight/v1
                meta:
                  request_id: req_9s8d7f6g5h4j
                  timestamp: '2026-08-03T12:34:56.000Z'
components:
  schemas:
    ResponseMeta:
      type: object
      required:
        - request_id
        - timestamp
      additionalProperties: false
      properties:
        request_id:
          type: string
          description: Unique request identifier (also returned as X-Request-Id header)
        timestamp:
          type: string
          format: date-time
        docs_url:
          type: string
          format: uri
          nullable: true
  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_*)

````