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

# Capture dual-party recording consent for a call

> Captures per-call recording consent for a non-conference call before recording starts. EVERY listed party (`recipient` and/or `originator`) must have `granted: true`; if any party declines the request fails with 422 (`RECORDING_CONSENT_DECLINED`) and persists nothing. On success it returns a `consent_receipt_id` you pass in when you start recording, along with the party count and expiry, and adds the capture to the call's consent audit trail. Records consent only — it does not start recording or place a call.



## OpenAPI

````yaml /openapi.yaml post /api/v1/compliance/recording-consent
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/recording-consent:
    post:
      tags:
        - Compliance
      summary: Capture dual-party recording consent for a call
      description: >-
        Captures per-call recording consent for a non-conference call before
        recording starts. EVERY listed party (`recipient` and/or `originator`)
        must have `granted: true`; if any party declines the request fails with
        422 (`RECORDING_CONSENT_DECLINED`) and persists nothing. On success it
        returns a `consent_receipt_id` you pass in when you start recording,
        along with the party count and expiry, and adds the capture to the
        call's consent audit trail. Records consent only — it does not start
        recording or place a call.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              required:
                - call_id
                - parties
              properties:
                call_id:
                  type: string
                  minLength: 1
                  maxLength: 64
                  description: The call this consent covers.
                recording_id:
                  type: string
                  minLength: 1
                  maxLength: 64
                  description: >-
                    Optional recording id to bind the receipt to a specific
                    artifact.
                consent_method:
                  type: string
                  default: ivr_announcement
                  enum:
                    - ivr_dtmf
                    - ivr_speech
                    - ivr_announcement
                    - pre_recorded_disclosure
                    - operator_attested
                    - verbal_attested
                    - written_consent
                  description: How consent was collected. Defaults to `ivr_announcement`.
                consent_text_version:
                  type: string
                  minLength: 1
                  maxLength: 32
                  default: v1
                  description: >-
                    Version tag of the consent disclosure text shown. Defaults
                    to `v1`.
                consent_text:
                  type: string
                  maxLength: 2000
                  description: Optional verbatim disclosure text presented to the parties.
                jurisdiction:
                  type: string
                  maxLength: 64
                  description: Optional jurisdiction code the consent was captured under.
                parties:
                  type: array
                  minItems: 1
                  maxItems: 16
                  description: >-
                    One entry per party whose consent is being recorded. Every
                    entry must be `granted: true`.
                  items:
                    type: object
                    additionalProperties: false
                    required:
                      - role
                      - granted
                    properties:
                      role:
                        type: string
                        enum:
                          - recipient
                          - originator
                        description: Which side of the call this party is.
                      granted:
                        type: boolean
                        description: >-
                          Whether this party granted consent. A single `false`
                          declines the whole capture.
      responses:
        '201':
          description: >-
            Consent captured — returns the minted `consent_receipt_id`,
            `call_id`, `party_count`, and `expires_at`.
        '422':
          description: >-
            Validation error, or a party declined (`RECORDING_CONSENT_DECLINED`)
            — nothing is persisted.
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_*)

````