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

# File a data-subject access or erasure request (DSAR)

> File a data-subject request (GDPR Article 15/17, CCPA/CPRA, LGPD, and other regimes) on behalf of a contact. Identify the subject with a `contact_id` and/or their `subject_email`/`subject_phone`, and give the `requester_email` where the finished export link is mailed. CCPA/CPRA requests may set `request_type`, `applicable_jurisdiction`, `consumer_categories`, and a verification posture; the request is queued and a background worker produces the access export or runs the erasure. Owner/admin only.



## OpenAPI

````yaml /openapi.yaml post /api/v1/compliance/dsar/
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/compliance/dsar/:
    post:
      tags:
        - Compliance
      summary: File a data-subject access or erasure request (DSAR)
      description: >-
        File a data-subject request (GDPR Article 15/17, CCPA/CPRA, LGPD, and
        other regimes) on behalf of a contact. Identify the subject with a
        `contact_id` and/or their `subject_email`/`subject_phone`, and give the
        `requester_email` where the finished export link is mailed. CCPA/CPRA
        requests may set `request_type`, `applicable_jurisdiction`,
        `consumer_categories`, and a verification posture; the request is queued
        and a background worker produces the access export or runs the erasure.
        Owner/admin only.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - requester_email
              properties:
                contact_id:
                  type: string
                  description: >-
                    Existing contact the request is about (optional if an
                    identifier is given).
                subject_email:
                  type: string
                  description: >-
                    The data subject's email, used to resolve or match their
                    records.
                subject_phone:
                  type: string
                  description: The data subject's phone in E.164 format.
                requester_email:
                  type: string
                  description: Where the signed export link (or status update) is emailed.
                applicable_jurisdiction:
                  type: string
                  enum:
                    - gdpr
                    - ccpa
                    - cpra
                    - lgpd
                    - pdpa
                    - pipeda
                    - dpdp
                  description: >-
                    Legal regime the request is filed under (defaults to
                    `gdpr`).
                request_type:
                  type: string
                  enum:
                    - know
                    - delete
                    - correct
                    - opt_out_sale
                    - limit_sensitive_pi
                    - portability
                    - non_discrimination
                  description: The right being exercised (defaults to `know`).
                consumer_categories:
                  type: array
                  items:
                    type: string
                  description: CCPA categories of personal information the request covers.
                verification_method:
                  type: string
                  enum:
                    - email_link
                    - email_phone
                    - document
                    - manual_review
                  description: Identity-verification posture the operator requires.
                requester_statement:
                  type: string
                  description: Free-text description of the request (max 4096 chars).
            example:
              subject_email: jane@example.com
              requester_email: jane@example.com
              applicable_jurisdiction: gdpr
              request_type: know
      responses:
        '202':
          description: The request was accepted and queued for processing.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                      status:
                        type: string
                      applicable_jurisdiction:
                        type: string
                      request_type:
                        type: string
                      verification_status:
                        type: string
                      message:
                        type: string
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
              example:
                data:
                  id: dsar_1a2b3c4d5e6f
                  status: received
                  applicable_jurisdiction: gdpr
                  request_type: know
                  verification_status: not_required
                  message: >-
                    DSAR request received. You will be emailed a download link
                    when the export completes (typically within a few minutes).
                meta:
                  request_id: req_1a2b3c4d5e6f
                  timestamp: '2026-08-07T12:00:00.000Z'
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_*)

````