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

# Check an archive-vendor connector's pre-activation readiness

> Runs a read-only preflight over one configured connector — transport compatibility, delivery-endpoint grammar, record classes, and whether a credential reference is set — and returns a readiness checklist the operator can review before activating it for compliance delivery. Live reachability, authentication, and sample-record delivery are verified after the connector is active; this preflight makes no network call and reads no stored credential.



## OpenAPI

````yaml /openapi.yaml get /api/v1/compliance/archive-connectors/{vendor}/readiness
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/compliance/archive-connectors/{vendor}/readiness:
    get:
      tags:
        - Compliance
      summary: Check an archive-vendor connector's pre-activation readiness
      description: >-
        Runs a read-only preflight over one configured connector — transport
        compatibility, delivery-endpoint grammar, record classes, and whether a
        credential reference is set — and returns a readiness checklist the
        operator can review before activating it for compliance delivery. Live
        reachability, authentication, and sample-record delivery are verified
        after the connector is active; this preflight makes no network call and
        reads no stored credential.
      parameters:
        - schema:
            type: string
          in: path
          name: vendor
          required: true
      responses:
        '200':
          description: The connector's pre-activation readiness checklist.
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                properties:
                  data:
                    type: object
                    required:
                      - vendor
                      - state
                      - ready
                      - checks
                      - note
                    properties:
                      vendor:
                        type: string
                        enum:
                          - smarsh
                          - global_relay
                          - bloomberg_vault
                      state:
                        type: string
                        enum:
                          - pending
                          - active
                          - paused
                      ready:
                        type: boolean
                        description: >-
                          True when no check is `fail` — the connector is safely
                          activatable. `warn` items are advisory and do not
                          block activation.
                      checks:
                        type: array
                        description: >-
                          One line item per pre-activation check the control
                          plane can evaluate without a network call or
                          credential material.
                        items:
                          type: object
                          required:
                            - id
                            - label
                            - status
                            - detail
                          properties:
                            id:
                              type: string
                            label:
                              type: string
                            status:
                              type: string
                              enum:
                                - pass
                                - warn
                                - fail
                            detail:
                              type: string
                      note:
                        type: string
                        description: >-
                          Why live network verification is not performed by this
                          control-plane surface.
        '404':
          description: >-
            `error.code` is `ARCHIVE_CONNECTOR_NOT_FOUND` — no connector is
            configured for the vendor.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '422':
          description: >-
            `error.code` is `VALIDATION_ERROR` — the vendor failed schema
            validation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
components:
  schemas:
    ErrorEnvelope:
      type: object
      required:
        - error
        - meta
      additionalProperties: false
      properties:
        error:
          type: object
          required:
            - code
            - message
            - status
          additionalProperties: false
          properties:
            code:
              type: string
            message:
              type: string
            status:
              type: integer
            details:
              type: object
              additionalProperties: true
              nullable: true
        meta:
          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_*)

````