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

# Run a live multi-vendor broker enrichment

> The live multi-vendor broker. For a vendor with a configured live transport it fetches the vendor's enrichment response through the connected account, normalizes it onto the canonical attribute vocabulary, and prices the lookup (vendor list-cost pass-through plus tenant margin). Caller-driven compute — it reads no database and persists nothing. A vendor without a configured transport returns 409; a live vendor failure surfaces as 502. Owner / admin / developer only.



## OpenAPI

````yaml /openapi.yaml post /api/v1/cdp/enrichment-catalog/{provider_id}/broker-enrich
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}/broker-enrich:
    post:
      tags:
        - CDP
      summary: Run a live multi-vendor broker enrichment
      description: >-
        The live multi-vendor broker. For a vendor with a configured live
        transport it fetches the vendor's enrichment response through the
        connected account, normalizes it onto the canonical attribute
        vocabulary, and prices the lookup (vendor list-cost pass-through plus
        tenant margin). Caller-driven compute — it reads no database and
        persists nothing. A vendor without a configured transport returns 409; a
        live vendor failure surfaces as 502. Owner / admin / developer only.
      parameters:
        - in: path
          name: provider_id
          required: true
          description: A third-party enrichment vendor slug.
          schema:
            type: string
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                signals:
                  type: object
                  description: The contact identifiers handed to the vendor.
                  properties:
                    email:
                      type: string
                    company_domain:
                      type: string
                    first_name:
                      type: string
                    last_name:
                      type: string
                    display_name:
                      type: string
                    company_name:
                      type: string
                margin_pct:
                  type: number
                  minimum: 0
                  maximum: 1000
                  description: Tenant margin percent applied over the vendor list cost.
                units:
                  type: integer
                  minimum: 0
                  maximum: 100000
                  description: Number of lookups to price.
      responses:
        '200':
          description: >-
            The normalized attribute patch plus the cost pass-through and margin
            breakdown.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      provider_id:
                        type: string
                      vendor:
                        type: string
                      preview:
                        type: boolean
                      patch:
                        type: object
                        additionalProperties:
                          type: string
                      billing:
                        type: object
                        properties:
                          vendor:
                            type: string
                          units:
                            type: integer
                          baseCents:
                            type: integer
                          finalCents:
                            type: integer
                          marginCents:
                            type: integer
                          marginPct:
                            type: number
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
        '400':
          description: Malformed request body.
        '404':
          description: No third-party enrichment vendor with that id in the broker.
        '409':
          description: No live enrichment transport is configured for the vendor yet.
        '502':
          description: The vendor enrichment lookup failed.
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_*)

````