DSAR API Reference

Last updated: March 19, 20266 min readAdvancedDeveloper

The DSAR API lets you programmatically create, manage, and automate data subject access requests.

Available Endpoints

POST /api/dsar/requests — Create a new DSAR
GET /api/dsar/requests — List all DSARs
GET /api/dsar/requests/:id — Get DSAR details
PATCH /api/dsar/requests/:id — Update DSAR status
POST /api/dsar/requests/:id/auto-retrieve — Trigger automated data retrieval

Create a DSAR

javascript

POST /api/dsar/requests

{
  "type": "access",
  "subjectEmail": "user@example.com",
  "subjectName": "Ahmed Ali",
  "description": "Request for all personal data"
}

Update Status

javascript

PATCH /api/dsar/requests/:id

{
  "status": "in_progress"
}
// Setting status to 'in_progress' auto-triggers data retrieval

Trigger Automation

javascript

POST /api/dsar/requests/:id/auto-retrieve

// Retrieves data from:
// - Arqam360 (consent records, scan results)
// - Shopify (via ShopifyInstallation tokens)
// - Salla (via SallaInstallation tokens)

Set up a webhook for the 'dsar.completed' event to be notified when automated retrieval finishes.

Was this article helpful?

API Authentication

Compliance