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

# List compliance registration use-cases

> Lists every compliance registration use-case Orbit defines (phone-number purchase, 10DLC brand/campaign, alphanumeric sender ID, toll-free verification, WhatsApp/RCS brand verification, email-domain and voice-carrier KYC) together with a `ready` flag and the downstream providers each one fans out to. Use it to drive the compliance-profile creation wizard: render ready use-cases as selectable, disable not-ready ones as "Coming soon", read `needs_country` to decide whether to require a country on the form, and follow an `available_via` deep-link when a use-case is delivered on its own dedicated surface (e.g. Toll-Free Verification, RCS Brands) rather than as a brand-level compliance bundle. Read-only.



## OpenAPI

````yaml /openapi.yaml get /api/v1/compliance/use-cases
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/use-cases:
    get:
      tags:
        - Compliance
      summary: List compliance registration use-cases
      description: >-
        Lists every compliance registration use-case Orbit defines (phone-number
        purchase, 10DLC brand/campaign, alphanumeric sender ID, toll-free
        verification, WhatsApp/RCS brand verification, email-domain and
        voice-carrier KYC) together with a `ready` flag and the downstream
        providers each one fans out to. Use it to drive the compliance-profile
        creation wizard: render ready use-cases as selectable, disable not-ready
        ones as "Coming soon", read `needs_country` to decide whether to require
        a country on the form, and follow an `available_via` deep-link when a
        use-case is delivered on its own dedicated surface (e.g. Toll-Free
        Verification, RCS Brands) rather than as a brand-level compliance
        bundle. Read-only.
      responses:
        '200':
          description: The catalogue of compliance use-cases and their readiness.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      items:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              description: Stable use-case identifier.
                            label:
                              type: string
                              description: Human-readable name for display.
                            ready:
                              type: boolean
                              description: >-
                                Whether the use-case has a working submission
                                path today. Not-ready ones are shown but
                                disabled so tenants see the roadmap instead of a
                                form that 422s on submit.
                            providers:
                              type: array
                              items:
                                type: string
                              description: >-
                                Downstream provider ids this use-case submits
                                to.
                            unsupported_providers:
                              type: array
                              items:
                                type: string
                              description: >-
                                Providers listed for this use-case that are not
                                yet implemented.
                            needs_country:
                              type: boolean
                              description: >-
                                Whether creating a profile for this use-case
                                requires a country.
                            available_via:
                              type: object
                              nullable: true
                              description: >-
                                Deep-link to the dedicated surface that delivers
                                this use-case, or null when it is created as a
                                brand-level bundle here.
                              properties:
                                label:
                                  type: string
                                href:
                                  type: string
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
              example:
                data:
                  items:
                    - id: phone_number_purchase
                      label: Phone-number purchase
                      ready: true
                      providers:
                        - tcr_us
                      unsupported_providers: []
                      needs_country: true
                      available_via: null
                    - id: sms_tfv_us
                      label: Toll-free verification (US)
                      ready: false
                      providers:
                        - tcr_us
                      unsupported_providers: []
                      needs_country: false
                      available_via:
                        label: Toll-Free Verification
                        href: /settings/compliance#tfv
                meta:
                  request_id: req_1a2b3c4d5e6f
                  timestamp: '2026-08-03T12:00:00.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_*)

````