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

# Validate a provider connect-form config

> Structural, credential-redacted validation of an operator-submitted config against the provider's catalog field spec — required fields present, url / select shapes valid, unknown keys reported. It does NOT persist anything and does NOT contact the provider; a valid config does not start an enrichment (the backend is gated on appendsLive). A 200 is returned for both valid and invalid configs; a malformed request body is the only 400. Owner / admin / developer only.



## OpenAPI

````yaml /openapi.yaml post /api/v1/cdp/enrichment-catalog/{provider_id}/validate-config
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/cdp/enrichment-catalog/{provider_id}/validate-config:
    post:
      tags:
        - CDP
      summary: Validate a provider connect-form config
      description: >-
        Structural, credential-redacted validation of an operator-submitted
        config against the provider's catalog field spec — required fields
        present, url / select shapes valid, unknown keys reported. It does NOT
        persist anything and does NOT contact the provider; a valid config does
        not start an enrichment (the backend is gated on appendsLive). A 200 is
        returned for both valid and invalid configs; a malformed request body is
        the only 400. Owner / admin / developer only.
      parameters:
        - in: path
          name: provider_id
          required: true
          description: The provider slug.
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - config
              properties:
                config:
                  type: object
                  additionalProperties: true
                  description: >-
                    The operator-supplied credential/config map keyed by the
                    provider's configFields[].key. Secret values are echoed back
                    redacted. Capped at 40 keys.
      responses:
        '200':
          description: >-
            The validation outcome plus a credential-redacted echo of the
            config.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      provider_id:
                        type: string
                      valid:
                        type: boolean
                      errors:
                        type: array
                        items:
                          type: object
                          properties:
                            field:
                              type: string
                            message:
                              type: string
                      redacted_config:
                        type: object
                        additionalProperties:
                          type: string
                        description: >-
                          Config echoed back with every secret field collapsed
                          to [set] / [unset].
                      status:
                        type: string
                        enum:
                          - ga
                          - beta
                          - coming_soon
                          - deprecated
                      enrichment_available:
                        type: boolean
                        description: >-
                          True only when a live enrichment backend exists for
                          the provider.
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
        '400':
          description: Malformed request body.
        '404':
          description: No enrichment provider with that id in the catalog.
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_*)

````