Create Privacy Request

POST /api/v1/privacy/requests

Create Privacy Request

cURL

curl --request POST \
  --url https://api.veridical.dev/api/v1/privacy/requests \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "request_type": "<string>",
  "scope": [
    "<string>"
  ],
  "subject_id": "<string>",
  "subject_provider": "<string>",
  "workspace_id": "<string>",
  "client_request_id": "<string>",
  "intake_ref": "<string>"
}
'

201

{}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key · string | null

Required string length: 8 - 200

X-Correlation-ID · string | null

authorization · string | null

Body

application/json

request_type · string · required

Pattern: ^(access|export|correction|deletion)$

scope · string[] · required

Required array length: 1 - 20 elements

subject_id · string · required

Required string length: 1 - 300

subject_provider · string · required

Required string length: 1 - 100

workspace_id · string · required

Required string length: 1 - 200

client_request_id · string | null

Required string length: 8 - 200

intake_ref · string | null

Required string length: 1 - 1100

Response

201

application/json

Successful Response

The response is of type Response Create Privacy Request Api V1 Privacy Requests Post · object.