Create a DSAR request
Settings module
POST/dsar-requestsdsarRequests.create
A data subject access request. Creates a DSAR request. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.
- Requires the capability data.request.manage.
- OAuth scopes: data.
- Send an Idempotency-Key header. A replay with the same key returns the original response.
- Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.
Request body: DsarRequestCreate
| Field | Type | Required | Description |
|---|---|---|---|
| request_type | "Access" | "Rectification" | "Erasure" | "Restriction" | "Portability" | "Objection" | "Opt Out of Sale" | Yes | What the requester exercises. |
| subject_person_id | string (uuid) | null | No | Identifier of the person the request is about, when they have an account. |
| subject_email | string (email) | Yes | Email the requester gave, used to verify identity and to reply. |
| details | string | null | No | What the requester asked for, in their words.Constraints: length 1 to 4000 |
{
"request_type": "Access",
"subject_person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"subject_email": "alex.rivera@northwindlive.example",
"details": "Send me my timesheets."
}Response 201: DsarRequest
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the dsar request. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| request_type | "Access" | "Rectification" | "Erasure" | "Restriction" | "Portability" | "Objection" | "Opt Out of Sale" | Yes | What the requester exercises. |
| dsar_state | string | Yes | Request state. A Title Case value from the lifecycle's database enum.Constraints: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]*( [A-Za-z0-9&'/.()-]+)*$ |
| subject_person_id | string (uuid) | null | Yes | Identifier of the person the request is about, when they have an account. |
| subject_email | string (email) | Yes | Email the requester gave, used to verify identity and to reply. |
| details | string | null | Yes | What the requester asked for, in their words.Constraints: length 1 to 4000 |
| received_at | string (date-time) | Yes | When the request was received; the clock starts here. |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"request_type": "Access",
"dsar_state": "In Review",
"subject_person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"subject_email": "alex.rivera@northwindlive.example",
"details": "Send me my timesheets.",
"received_at": "2026-10-08T14:30:00Z"
}Code samples
curl -X POST "$XOS_BASE_URL/dsar-requests" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"request_type":"Access","subject_person_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","subject_email":"alex.rivera@northwindlive.example","details":"Send me my timesheets."}'const { data } = await xos.dsarRequests.create({
"request_type": "Access",
"subject_person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"subject_email": "alex.rivera@northwindlive.example",
"details": "Send me my timesheets."
});response = xos.dsar_requests.create({"request_type": "Access", "subject_person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "subject_email": "alex.rivera@northwindlive.example", "details": "Send me my timesheets."})xos dsar-requests create --data '{"request_type":"Access","subject_person_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","subject_email":"alex.rivera@northwindlive.example","details":"Send me my timesheets."}'