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

# Verify a custom domain

> Check the CNAME record for a registered custom domain and, once it resolves to the expected target, advance the domain toward the verified state and trigger TLS certificate provisioning. Returns the refreshed domain record. Requires the owner or admin role.



## OpenAPI

````yaml /openapi.yaml post /api/v1/organization/domains/{domainId}/verify
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/organization/domains/{domainId}/verify:
    post:
      tags:
        - Organization
      summary: Verify a custom domain
      description: >-
        Check the CNAME record for a registered custom domain and, once it
        resolves to the expected target, advance the domain toward the verified
        state and trigger TLS certificate provisioning. Returns the refreshed
        domain record. Requires the owner or admin role.
      parameters:
        - name: domainId
          in: path
          required: true
          schema:
            type: string
            minLength: 1
            description: Custom-domain record identifier.
      responses:
        '200':
          description: The refreshed custom-domain record after a verification run.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                properties:
                  data:
                    type: object
                    additionalProperties: true
                    properties:
                      id:
                        type: string
                        description: Domain record identifier.
                      organization_id:
                        type: string
                        description: Owning organization id.
                      domain:
                        type: string
                        description: The registered hostname.
                      status:
                        type: string
                        description: >-
                          Lifecycle status — e.g. `pending`, `verifying`,
                          `verified`, or `error`.
                      cname_target:
                        type: string
                        description: >-
                          CNAME value to add at your DNS provider to verify the
                          domain.
                      cname_verified_at:
                        type:
                          - string
                          - 'null'
                        format: date-time
                        description: When the CNAME was first observed to resolve, or null.
                      ssl_cert_provisioned_at:
                        type:
                          - string
                          - 'null'
                        format: date-time
                        description: >-
                          When the managed TLS certificate finished
                          provisioning, or null.
                      ssl_cert_secret_name:
                        type:
                          - string
                          - 'null'
                        description: Internal certificate secret reference, or null.
                      error:
                        type:
                          - string
                          - 'null'
                        description: Last verification / provisioning error, or null.
                      created_at:
                        type: string
                        format: date-time
                      updated_at:
                        type: string
                        format: date-time
                  meta:
                    type: object
                    additionalProperties: true
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: date-time
              example:
                data:
                  id: domain_01J9Z8ABCDEF
                  organization_id: org_01J9Z8ABCDEF
                  domain: app.acme.example
                  status: verifying
                  cname_target: cname.orbit.devotel.io
                  cname_verified_at: '2026-08-13T12:05:00.000Z'
                  ssl_cert_provisioned_at: null
                  ssl_cert_secret_name: null
                  error: null
                  created_at: '2026-08-13T12:00:00.000Z'
                  updated_at: '2026-08-13T12:00:00.000Z'
                meta:
                  request_id: req_01J9Z8ABCDEF
                  timestamp: '2026-08-13T12:00:00.000Z'
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_*)

````