Skip to content
Clym

DSAR

Data subject request (DSAR) lifecycle events.

Triggered when DSAR email verification completes.

Request bodyapplication/json
eventstringrequired
The DSAR event name.
paramsobjectrequired
Event-specific context; may be empty.
entityobjectoptional
The related DSAR record.
Show properties
kindstringenumoptional
Entity type; always `request`.
Possible values: request
dataobjectoptional
Data subject request (DSAR) record. Fields are emitted only when set, including the linked `profile`. Requester contact fields (`first_name`, `last_name`, `phone_number`) hold PII and appear only when present.
Show properties
idstringoptional
Request ID.
statusstringenumoptional
Request status.
Possible values: PENDING OPEN IN_PROGRESS CLOSED
is_closedbooleanoptional
Whether the request has been closed.
countrystringoptional
Requester country code.
statestringoptional
Requester state/region.
languagestringoptional
Request language.
channelstringoptional
Submission channel.
first_namestringoptional
Requester first name (PII; when set).
last_namestringoptional
Requester last name (PII; when set).
phone_numberstringoptional
Requester phone number (PII; when set).
changed_by_idstringnullableoptional
ID of the account that last changed it.
system_request_idstringoptional
Source system DSR template ID.
property_idstringoptional
Property ID.
company_idstringoptional
Company ID.
profileobjectoptional
Linked end-user profile, when present.
Show properties
idstringoptional
emailstringoptional
first_namestringoptional
last_namestringoptional
is_verifiedbooleanoptional
countrystringoptional
statestringoptional
confirmed_atstringnullableoptional
due_onstringnullableoptional
extended_due_onstringnullableoptional
created_atstringoptional
updated_atstringoptional

Response 200: Acknowledged

Payload

{
  "event": "dsar.verification.completed",
  "params": {},
  "entity": {
    "kind": "request",
    "data": {
      "id": "string",
      "status": "PENDING",
      "is_closed": false,
      "country": "string",
      "state": "string",
      "language": "string",
      "channel": "string",
      "first_name": "string",
      "last_name": "string",
      "phone_number": "string",
      "changed_by_id": "string",
      "system_request_id": "string",
      "property_id": "string",
      "company_id": "string",
      "profile": {
        "id": "string",
        "email": "string",
        "first_name": "string",
        "last_name": "string",
        "is_verified": false,
        "country": "string",
        "state": "string"
      },
      "confirmed_at": "string",
      "due_on": "string",
      "extended_due_on": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  }
}

Triggered when a DSAR verification email is sent.

Request bodyapplication/json
eventstringrequired
The DSAR event name.
paramsobjectrequired
Event-specific context; may be empty.
entityobjectoptional
The related DSAR record.
Show properties
kindstringenumoptional
Entity type; always `request`.
Possible values: request
dataobjectoptional
Data subject request (DSAR) record. Fields are emitted only when set, including the linked `profile`. Requester contact fields (`first_name`, `last_name`, `phone_number`) hold PII and appear only when present.
Show properties
idstringoptional
Request ID.
statusstringenumoptional
Request status.
Possible values: PENDING OPEN IN_PROGRESS CLOSED
is_closedbooleanoptional
Whether the request has been closed.
countrystringoptional
Requester country code.
statestringoptional
Requester state/region.
languagestringoptional
Request language.
channelstringoptional
Submission channel.
first_namestringoptional
Requester first name (PII; when set).
last_namestringoptional
Requester last name (PII; when set).
phone_numberstringoptional
Requester phone number (PII; when set).
changed_by_idstringnullableoptional
ID of the account that last changed it.
system_request_idstringoptional
Source system DSR template ID.
property_idstringoptional
Property ID.
company_idstringoptional
Company ID.
profileobjectoptional
Linked end-user profile, when present.
Show properties
idstringoptional
emailstringoptional
first_namestringoptional
last_namestringoptional
is_verifiedbooleanoptional
countrystringoptional
statestringoptional
confirmed_atstringnullableoptional
due_onstringnullableoptional
extended_due_onstringnullableoptional
created_atstringoptional
updated_atstringoptional

Response 200: Acknowledged

Payload

{
  "event": "dsar.verification.completed",
  "params": {},
  "entity": {
    "kind": "request",
    "data": {
      "id": "string",
      "status": "PENDING",
      "is_closed": false,
      "country": "string",
      "state": "string",
      "language": "string",
      "channel": "string",
      "first_name": "string",
      "last_name": "string",
      "phone_number": "string",
      "changed_by_id": "string",
      "system_request_id": "string",
      "property_id": "string",
      "company_id": "string",
      "profile": {
        "id": "string",
        "email": "string",
        "first_name": "string",
        "last_name": "string",
        "is_verified": false,
        "country": "string",
        "state": "string"
      },
      "confirmed_at": "string",
      "due_on": "string",
      "extended_due_on": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  }
}

Triggered when a DSAR notification is sent.

Request bodyapplication/json
eventstringrequired
The DSAR event name.
paramsobjectrequired
Event-specific context; may be empty.
entityobjectoptional
The related DSAR record.
Show properties
kindstringenumoptional
Entity type; always `request`.
Possible values: request
dataobjectoptional
Data subject request (DSAR) record. Fields are emitted only when set, including the linked `profile`. Requester contact fields (`first_name`, `last_name`, `phone_number`) hold PII and appear only when present.
Show properties
idstringoptional
Request ID.
statusstringenumoptional
Request status.
Possible values: PENDING OPEN IN_PROGRESS CLOSED
is_closedbooleanoptional
Whether the request has been closed.
countrystringoptional
Requester country code.
statestringoptional
Requester state/region.
languagestringoptional
Request language.
channelstringoptional
Submission channel.
first_namestringoptional
Requester first name (PII; when set).
last_namestringoptional
Requester last name (PII; when set).
phone_numberstringoptional
Requester phone number (PII; when set).
changed_by_idstringnullableoptional
ID of the account that last changed it.
system_request_idstringoptional
Source system DSR template ID.
property_idstringoptional
Property ID.
company_idstringoptional
Company ID.
profileobjectoptional
Linked end-user profile, when present.
Show properties
idstringoptional
emailstringoptional
first_namestringoptional
last_namestringoptional
is_verifiedbooleanoptional
countrystringoptional
statestringoptional
confirmed_atstringnullableoptional
due_onstringnullableoptional
extended_due_onstringnullableoptional
created_atstringoptional
updated_atstringoptional

Response 200: Acknowledged

Payload

{
  "event": "dsar.verification.completed",
  "params": {},
  "entity": {
    "kind": "request",
    "data": {
      "id": "string",
      "status": "PENDING",
      "is_closed": false,
      "country": "string",
      "state": "string",
      "language": "string",
      "channel": "string",
      "first_name": "string",
      "last_name": "string",
      "phone_number": "string",
      "changed_by_id": "string",
      "system_request_id": "string",
      "property_id": "string",
      "company_id": "string",
      "profile": {
        "id": "string",
        "email": "string",
        "first_name": "string",
        "last_name": "string",
        "is_verified": false,
        "country": "string",
        "state": "string"
      },
      "confirmed_at": "string",
      "due_on": "string",
      "extended_due_on": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  }
}

Triggered when a DSAR submission email is sent.

Request bodyapplication/json
eventstringrequired
The DSAR event name.
paramsobjectrequired
Event-specific context; may be empty.
entityobjectoptional
The related DSAR record.
Show properties
kindstringenumoptional
Entity type; always `request`.
Possible values: request
dataobjectoptional
Data subject request (DSAR) record. Fields are emitted only when set, including the linked `profile`. Requester contact fields (`first_name`, `last_name`, `phone_number`) hold PII and appear only when present.
Show properties
idstringoptional
Request ID.
statusstringenumoptional
Request status.
Possible values: PENDING OPEN IN_PROGRESS CLOSED
is_closedbooleanoptional
Whether the request has been closed.
countrystringoptional
Requester country code.
statestringoptional
Requester state/region.
languagestringoptional
Request language.
channelstringoptional
Submission channel.
first_namestringoptional
Requester first name (PII; when set).
last_namestringoptional
Requester last name (PII; when set).
phone_numberstringoptional
Requester phone number (PII; when set).
changed_by_idstringnullableoptional
ID of the account that last changed it.
system_request_idstringoptional
Source system DSR template ID.
property_idstringoptional
Property ID.
company_idstringoptional
Company ID.
profileobjectoptional
Linked end-user profile, when present.
Show properties
idstringoptional
emailstringoptional
first_namestringoptional
last_namestringoptional
is_verifiedbooleanoptional
countrystringoptional
statestringoptional
confirmed_atstringnullableoptional
due_onstringnullableoptional
extended_due_onstringnullableoptional
created_atstringoptional
updated_atstringoptional

Response 200: Acknowledged

Payload

{
  "event": "dsar.verification.completed",
  "params": {},
  "entity": {
    "kind": "request",
    "data": {
      "id": "string",
      "status": "PENDING",
      "is_closed": false,
      "country": "string",
      "state": "string",
      "language": "string",
      "channel": "string",
      "first_name": "string",
      "last_name": "string",
      "phone_number": "string",
      "changed_by_id": "string",
      "system_request_id": "string",
      "property_id": "string",
      "company_id": "string",
      "profile": {
        "id": "string",
        "email": "string",
        "first_name": "string",
        "last_name": "string",
        "is_verified": false,
        "country": "string",
        "state": "string"
      },
      "confirmed_at": "string",
      "due_on": "string",
      "extended_due_on": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  }
}

Triggered 7 days before DSAR deadline

Request bodyapplication/json
eventstringrequired
The DSAR event name.
paramsobjectrequired
Event-specific context; may be empty.
entityobjectoptional
The related DSAR record.
Show properties
kindstringenumoptional
Entity type; always `request`.
Possible values: request
dataobjectoptional
Data subject request (DSAR) record. Fields are emitted only when set, including the linked `profile`. Requester contact fields (`first_name`, `last_name`, `phone_number`) hold PII and appear only when present.
Show properties
idstringoptional
Request ID.
statusstringenumoptional
Request status.
Possible values: PENDING OPEN IN_PROGRESS CLOSED
is_closedbooleanoptional
Whether the request has been closed.
countrystringoptional
Requester country code.
statestringoptional
Requester state/region.
languagestringoptional
Request language.
channelstringoptional
Submission channel.
first_namestringoptional
Requester first name (PII; when set).
last_namestringoptional
Requester last name (PII; when set).
phone_numberstringoptional
Requester phone number (PII; when set).
changed_by_idstringnullableoptional
ID of the account that last changed it.
system_request_idstringoptional
Source system DSR template ID.
property_idstringoptional
Property ID.
company_idstringoptional
Company ID.
profileobjectoptional
Linked end-user profile, when present.
Show properties
idstringoptional
emailstringoptional
first_namestringoptional
last_namestringoptional
is_verifiedbooleanoptional
countrystringoptional
statestringoptional
confirmed_atstringnullableoptional
due_onstringnullableoptional
extended_due_onstringnullableoptional
created_atstringoptional
updated_atstringoptional

Response 200: Acknowledged

Payload

{
  "event": "dsar.verification.completed",
  "params": {},
  "entity": {
    "kind": "request",
    "data": {
      "id": "string",
      "status": "PENDING",
      "is_closed": false,
      "country": "string",
      "state": "string",
      "language": "string",
      "channel": "string",
      "first_name": "string",
      "last_name": "string",
      "phone_number": "string",
      "changed_by_id": "string",
      "system_request_id": "string",
      "property_id": "string",
      "company_id": "string",
      "profile": {
        "id": "string",
        "email": "string",
        "first_name": "string",
        "last_name": "string",
        "is_verified": false,
        "country": "string",
        "state": "string"
      },
      "confirmed_at": "string",
      "due_on": "string",
      "extended_due_on": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  }
}

Triggered 2 days before DSAR deadline

Request bodyapplication/json
eventstringrequired
The DSAR event name.
paramsobjectrequired
Event-specific context; may be empty.
entityobjectoptional
The related DSAR record.
Show properties
kindstringenumoptional
Entity type; always `request`.
Possible values: request
dataobjectoptional
Data subject request (DSAR) record. Fields are emitted only when set, including the linked `profile`. Requester contact fields (`first_name`, `last_name`, `phone_number`) hold PII and appear only when present.
Show properties
idstringoptional
Request ID.
statusstringenumoptional
Request status.
Possible values: PENDING OPEN IN_PROGRESS CLOSED
is_closedbooleanoptional
Whether the request has been closed.
countrystringoptional
Requester country code.
statestringoptional
Requester state/region.
languagestringoptional
Request language.
channelstringoptional
Submission channel.
first_namestringoptional
Requester first name (PII; when set).
last_namestringoptional
Requester last name (PII; when set).
phone_numberstringoptional
Requester phone number (PII; when set).
changed_by_idstringnullableoptional
ID of the account that last changed it.
system_request_idstringoptional
Source system DSR template ID.
property_idstringoptional
Property ID.
company_idstringoptional
Company ID.
profileobjectoptional
Linked end-user profile, when present.
Show properties
idstringoptional
emailstringoptional
first_namestringoptional
last_namestringoptional
is_verifiedbooleanoptional
countrystringoptional
statestringoptional
confirmed_atstringnullableoptional
due_onstringnullableoptional
extended_due_onstringnullableoptional
created_atstringoptional
updated_atstringoptional

Response 200: Acknowledged

Payload

{
  "event": "dsar.verification.completed",
  "params": {},
  "entity": {
    "kind": "request",
    "data": {
      "id": "string",
      "status": "PENDING",
      "is_closed": false,
      "country": "string",
      "state": "string",
      "language": "string",
      "channel": "string",
      "first_name": "string",
      "last_name": "string",
      "phone_number": "string",
      "changed_by_id": "string",
      "system_request_id": "string",
      "property_id": "string",
      "company_id": "string",
      "profile": {
        "id": "string",
        "email": "string",
        "first_name": "string",
        "last_name": "string",
        "is_verified": false,
        "country": "string",
        "state": "string"
      },
      "confirmed_at": "string",
      "due_on": "string",
      "extended_due_on": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  }
}

Triggered 1 day before DSAR deadline

Request bodyapplication/json
eventstringrequired
The DSAR event name.
paramsobjectrequired
Event-specific context; may be empty.
entityobjectoptional
The related DSAR record.
Show properties
kindstringenumoptional
Entity type; always `request`.
Possible values: request
dataobjectoptional
Data subject request (DSAR) record. Fields are emitted only when set, including the linked `profile`. Requester contact fields (`first_name`, `last_name`, `phone_number`) hold PII and appear only when present.
Show properties
idstringoptional
Request ID.
statusstringenumoptional
Request status.
Possible values: PENDING OPEN IN_PROGRESS CLOSED
is_closedbooleanoptional
Whether the request has been closed.
countrystringoptional
Requester country code.
statestringoptional
Requester state/region.
languagestringoptional
Request language.
channelstringoptional
Submission channel.
first_namestringoptional
Requester first name (PII; when set).
last_namestringoptional
Requester last name (PII; when set).
phone_numberstringoptional
Requester phone number (PII; when set).
changed_by_idstringnullableoptional
ID of the account that last changed it.
system_request_idstringoptional
Source system DSR template ID.
property_idstringoptional
Property ID.
company_idstringoptional
Company ID.
profileobjectoptional
Linked end-user profile, when present.
Show properties
idstringoptional
emailstringoptional
first_namestringoptional
last_namestringoptional
is_verifiedbooleanoptional
countrystringoptional
statestringoptional
confirmed_atstringnullableoptional
due_onstringnullableoptional
extended_due_onstringnullableoptional
created_atstringoptional
updated_atstringoptional

Response 200: Acknowledged

Payload

{
  "event": "dsar.verification.completed",
  "params": {},
  "entity": {
    "kind": "request",
    "data": {
      "id": "string",
      "status": "PENDING",
      "is_closed": false,
      "country": "string",
      "state": "string",
      "language": "string",
      "channel": "string",
      "first_name": "string",
      "last_name": "string",
      "phone_number": "string",
      "changed_by_id": "string",
      "system_request_id": "string",
      "property_id": "string",
      "company_id": "string",
      "profile": {
        "id": "string",
        "email": "string",
        "first_name": "string",
        "last_name": "string",
        "is_verified": false,
        "country": "string",
        "state": "string"
      },
      "confirmed_at": "string",
      "due_on": "string",
      "extended_due_on": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  }
}

Triggered on auto-response when a DSAR opens.

Request bodyapplication/json
eventstringrequired
The DSAR event name.
paramsobjectrequired
Event-specific context; may be empty.
entityobjectoptional
The related DSAR record.
Show properties
kindstringenumoptional
Entity type; always `request`.
Possible values: request
dataobjectoptional
Data subject request (DSAR) record. Fields are emitted only when set, including the linked `profile`. Requester contact fields (`first_name`, `last_name`, `phone_number`) hold PII and appear only when present.
Show properties
idstringoptional
Request ID.
statusstringenumoptional
Request status.
Possible values: PENDING OPEN IN_PROGRESS CLOSED
is_closedbooleanoptional
Whether the request has been closed.
countrystringoptional
Requester country code.
statestringoptional
Requester state/region.
languagestringoptional
Request language.
channelstringoptional
Submission channel.
first_namestringoptional
Requester first name (PII; when set).
last_namestringoptional
Requester last name (PII; when set).
phone_numberstringoptional
Requester phone number (PII; when set).
changed_by_idstringnullableoptional
ID of the account that last changed it.
system_request_idstringoptional
Source system DSR template ID.
property_idstringoptional
Property ID.
company_idstringoptional
Company ID.
profileobjectoptional
Linked end-user profile, when present.
Show properties
idstringoptional
emailstringoptional
first_namestringoptional
last_namestringoptional
is_verifiedbooleanoptional
countrystringoptional
statestringoptional
confirmed_atstringnullableoptional
due_onstringnullableoptional
extended_due_onstringnullableoptional
created_atstringoptional
updated_atstringoptional

Response 200: Acknowledged

Payload

{
  "event": "dsar.verification.completed",
  "params": {},
  "entity": {
    "kind": "request",
    "data": {
      "id": "string",
      "status": "PENDING",
      "is_closed": false,
      "country": "string",
      "state": "string",
      "language": "string",
      "channel": "string",
      "first_name": "string",
      "last_name": "string",
      "phone_number": "string",
      "changed_by_id": "string",
      "system_request_id": "string",
      "property_id": "string",
      "company_id": "string",
      "profile": {
        "id": "string",
        "email": "string",
        "first_name": "string",
        "last_name": "string",
        "is_verified": false,
        "country": "string",
        "state": "string"
      },
      "confirmed_at": "string",
      "due_on": "string",
      "extended_due_on": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  }
}

Triggered when a DSAR moves from open to closed.

Request bodyapplication/json
eventstringrequired
The DSAR event name.
paramsobjectrequired
Event-specific context; may be empty.
entityobjectoptional
The related DSAR record.
Show properties
kindstringenumoptional
Entity type; always `request`.
Possible values: request
dataobjectoptional
Data subject request (DSAR) record. Fields are emitted only when set, including the linked `profile`. Requester contact fields (`first_name`, `last_name`, `phone_number`) hold PII and appear only when present.
Show properties
idstringoptional
Request ID.
statusstringenumoptional
Request status.
Possible values: PENDING OPEN IN_PROGRESS CLOSED
is_closedbooleanoptional
Whether the request has been closed.
countrystringoptional
Requester country code.
statestringoptional
Requester state/region.
languagestringoptional
Request language.
channelstringoptional
Submission channel.
first_namestringoptional
Requester first name (PII; when set).
last_namestringoptional
Requester last name (PII; when set).
phone_numberstringoptional
Requester phone number (PII; when set).
changed_by_idstringnullableoptional
ID of the account that last changed it.
system_request_idstringoptional
Source system DSR template ID.
property_idstringoptional
Property ID.
company_idstringoptional
Company ID.
profileobjectoptional
Linked end-user profile, when present.
Show properties
idstringoptional
emailstringoptional
first_namestringoptional
last_namestringoptional
is_verifiedbooleanoptional
countrystringoptional
statestringoptional
confirmed_atstringnullableoptional
due_onstringnullableoptional
extended_due_onstringnullableoptional
created_atstringoptional
updated_atstringoptional

Response 200: Acknowledged

Payload

{
  "event": "dsar.verification.completed",
  "params": {},
  "entity": {
    "kind": "request",
    "data": {
      "id": "string",
      "status": "PENDING",
      "is_closed": false,
      "country": "string",
      "state": "string",
      "language": "string",
      "channel": "string",
      "first_name": "string",
      "last_name": "string",
      "phone_number": "string",
      "changed_by_id": "string",
      "system_request_id": "string",
      "property_id": "string",
      "company_id": "string",
      "profile": {
        "id": "string",
        "email": "string",
        "first_name": "string",
        "last_name": "string",
        "is_verified": false,
        "country": "string",
        "state": "string"
      },
      "confirmed_at": "string",
      "due_on": "string",
      "extended_due_on": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  }
}

Triggered when a DSAR moves from open to in-progress.

Request bodyapplication/json
eventstringrequired
The DSAR event name.
paramsobjectrequired
Event-specific context; may be empty.
entityobjectoptional
The related DSAR record.
Show properties
kindstringenumoptional
Entity type; always `request`.
Possible values: request
dataobjectoptional
Data subject request (DSAR) record. Fields are emitted only when set, including the linked `profile`. Requester contact fields (`first_name`, `last_name`, `phone_number`) hold PII and appear only when present.
Show properties
idstringoptional
Request ID.
statusstringenumoptional
Request status.
Possible values: PENDING OPEN IN_PROGRESS CLOSED
is_closedbooleanoptional
Whether the request has been closed.
countrystringoptional
Requester country code.
statestringoptional
Requester state/region.
languagestringoptional
Request language.
channelstringoptional
Submission channel.
first_namestringoptional
Requester first name (PII; when set).
last_namestringoptional
Requester last name (PII; when set).
phone_numberstringoptional
Requester phone number (PII; when set).
changed_by_idstringnullableoptional
ID of the account that last changed it.
system_request_idstringoptional
Source system DSR template ID.
property_idstringoptional
Property ID.
company_idstringoptional
Company ID.
profileobjectoptional
Linked end-user profile, when present.
Show properties
idstringoptional
emailstringoptional
first_namestringoptional
last_namestringoptional
is_verifiedbooleanoptional
countrystringoptional
statestringoptional
confirmed_atstringnullableoptional
due_onstringnullableoptional
extended_due_onstringnullableoptional
created_atstringoptional
updated_atstringoptional

Response 200: Acknowledged

Payload

{
  "event": "dsar.verification.completed",
  "params": {},
  "entity": {
    "kind": "request",
    "data": {
      "id": "string",
      "status": "PENDING",
      "is_closed": false,
      "country": "string",
      "state": "string",
      "language": "string",
      "channel": "string",
      "first_name": "string",
      "last_name": "string",
      "phone_number": "string",
      "changed_by_id": "string",
      "system_request_id": "string",
      "property_id": "string",
      "company_id": "string",
      "profile": {
        "id": "string",
        "email": "string",
        "first_name": "string",
        "last_name": "string",
        "is_verified": false,
        "country": "string",
        "state": "string"
      },
      "confirmed_at": "string",
      "due_on": "string",
      "extended_due_on": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  }
}

Triggered on auto-response when a DSAR enters progress.

Request bodyapplication/json
eventstringrequired
The DSAR event name.
paramsobjectrequired
Event-specific context; may be empty.
entityobjectoptional
The related DSAR record.
Show properties
kindstringenumoptional
Entity type; always `request`.
Possible values: request
dataobjectoptional
Data subject request (DSAR) record. Fields are emitted only when set, including the linked `profile`. Requester contact fields (`first_name`, `last_name`, `phone_number`) hold PII and appear only when present.
Show properties
idstringoptional
Request ID.
statusstringenumoptional
Request status.
Possible values: PENDING OPEN IN_PROGRESS CLOSED
is_closedbooleanoptional
Whether the request has been closed.
countrystringoptional
Requester country code.
statestringoptional
Requester state/region.
languagestringoptional
Request language.
channelstringoptional
Submission channel.
first_namestringoptional
Requester first name (PII; when set).
last_namestringoptional
Requester last name (PII; when set).
phone_numberstringoptional
Requester phone number (PII; when set).
changed_by_idstringnullableoptional
ID of the account that last changed it.
system_request_idstringoptional
Source system DSR template ID.
property_idstringoptional
Property ID.
company_idstringoptional
Company ID.
profileobjectoptional
Linked end-user profile, when present.
Show properties
idstringoptional
emailstringoptional
first_namestringoptional
last_namestringoptional
is_verifiedbooleanoptional
countrystringoptional
statestringoptional
confirmed_atstringnullableoptional
due_onstringnullableoptional
extended_due_onstringnullableoptional
created_atstringoptional
updated_atstringoptional

Response 200: Acknowledged

Payload

{
  "event": "dsar.verification.completed",
  "params": {},
  "entity": {
    "kind": "request",
    "data": {
      "id": "string",
      "status": "PENDING",
      "is_closed": false,
      "country": "string",
      "state": "string",
      "language": "string",
      "channel": "string",
      "first_name": "string",
      "last_name": "string",
      "phone_number": "string",
      "changed_by_id": "string",
      "system_request_id": "string",
      "property_id": "string",
      "company_id": "string",
      "profile": {
        "id": "string",
        "email": "string",
        "first_name": "string",
        "last_name": "string",
        "is_verified": false,
        "country": "string",
        "state": "string"
      },
      "confirmed_at": "string",
      "due_on": "string",
      "extended_due_on": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  }
}

Triggered on auto-response when a DSAR closes.

Request bodyapplication/json
eventstringrequired
The DSAR event name.
paramsobjectrequired
Event-specific context; may be empty.
entityobjectoptional
The related DSAR record.
Show properties
kindstringenumoptional
Entity type; always `request`.
Possible values: request
dataobjectoptional
Data subject request (DSAR) record. Fields are emitted only when set, including the linked `profile`. Requester contact fields (`first_name`, `last_name`, `phone_number`) hold PII and appear only when present.
Show properties
idstringoptional
Request ID.
statusstringenumoptional
Request status.
Possible values: PENDING OPEN IN_PROGRESS CLOSED
is_closedbooleanoptional
Whether the request has been closed.
countrystringoptional
Requester country code.
statestringoptional
Requester state/region.
languagestringoptional
Request language.
channelstringoptional
Submission channel.
first_namestringoptional
Requester first name (PII; when set).
last_namestringoptional
Requester last name (PII; when set).
phone_numberstringoptional
Requester phone number (PII; when set).
changed_by_idstringnullableoptional
ID of the account that last changed it.
system_request_idstringoptional
Source system DSR template ID.
property_idstringoptional
Property ID.
company_idstringoptional
Company ID.
profileobjectoptional
Linked end-user profile, when present.
Show properties
idstringoptional
emailstringoptional
first_namestringoptional
last_namestringoptional
is_verifiedbooleanoptional
countrystringoptional
statestringoptional
confirmed_atstringnullableoptional
due_onstringnullableoptional
extended_due_onstringnullableoptional
created_atstringoptional
updated_atstringoptional

Response 200: Acknowledged

Payload

{
  "event": "dsar.verification.completed",
  "params": {},
  "entity": {
    "kind": "request",
    "data": {
      "id": "string",
      "status": "PENDING",
      "is_closed": false,
      "country": "string",
      "state": "string",
      "language": "string",
      "channel": "string",
      "first_name": "string",
      "last_name": "string",
      "phone_number": "string",
      "changed_by_id": "string",
      "system_request_id": "string",
      "property_id": "string",
      "company_id": "string",
      "profile": {
        "id": "string",
        "email": "string",
        "first_name": "string",
        "last_name": "string",
        "is_verified": false,
        "country": "string",
        "state": "string"
      },
      "confirmed_at": "string",
      "due_on": "string",
      "extended_due_on": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  }
}

Triggered when a closed-DSAR auto-response email is sent.

Request bodyapplication/json
eventstringrequired
The DSAR event name.
paramsobjectrequired
Event-specific context; may be empty.
entityobjectoptional
The related DSAR record.
Show properties
kindstringenumoptional
Entity type; always `request`.
Possible values: request
dataobjectoptional
Data subject request (DSAR) record. Fields are emitted only when set, including the linked `profile`. Requester contact fields (`first_name`, `last_name`, `phone_number`) hold PII and appear only when present.
Show properties
idstringoptional
Request ID.
statusstringenumoptional
Request status.
Possible values: PENDING OPEN IN_PROGRESS CLOSED
is_closedbooleanoptional
Whether the request has been closed.
countrystringoptional
Requester country code.
statestringoptional
Requester state/region.
languagestringoptional
Request language.
channelstringoptional
Submission channel.
first_namestringoptional
Requester first name (PII; when set).
last_namestringoptional
Requester last name (PII; when set).
phone_numberstringoptional
Requester phone number (PII; when set).
changed_by_idstringnullableoptional
ID of the account that last changed it.
system_request_idstringoptional
Source system DSR template ID.
property_idstringoptional
Property ID.
company_idstringoptional
Company ID.
profileobjectoptional
Linked end-user profile, when present.
Show properties
idstringoptional
emailstringoptional
first_namestringoptional
last_namestringoptional
is_verifiedbooleanoptional
countrystringoptional
statestringoptional
confirmed_atstringnullableoptional
due_onstringnullableoptional
extended_due_onstringnullableoptional
created_atstringoptional
updated_atstringoptional

Response 200: Acknowledged

Payload

{
  "event": "dsar.verification.completed",
  "params": {},
  "entity": {
    "kind": "request",
    "data": {
      "id": "string",
      "status": "PENDING",
      "is_closed": false,
      "country": "string",
      "state": "string",
      "language": "string",
      "channel": "string",
      "first_name": "string",
      "last_name": "string",
      "phone_number": "string",
      "changed_by_id": "string",
      "system_request_id": "string",
      "property_id": "string",
      "company_id": "string",
      "profile": {
        "id": "string",
        "email": "string",
        "first_name": "string",
        "last_name": "string",
        "is_verified": false,
        "country": "string",
        "state": "string"
      },
      "confirmed_at": "string",
      "due_on": "string",
      "extended_due_on": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  }
}

Triggered when an account replies on a DSAR.

Request bodyapplication/json
eventstringrequired
The DSAR event name.
paramsobjectrequired
Event-specific context; may be empty.
entityobjectoptional
The related DSAR record.
Show properties
kindstringenumoptional
Entity type; always `request`.
Possible values: request
dataobjectoptional
Data subject request (DSAR) record. Fields are emitted only when set, including the linked `profile`. Requester contact fields (`first_name`, `last_name`, `phone_number`) hold PII and appear only when present.
Show properties
idstringoptional
Request ID.
statusstringenumoptional
Request status.
Possible values: PENDING OPEN IN_PROGRESS CLOSED
is_closedbooleanoptional
Whether the request has been closed.
countrystringoptional
Requester country code.
statestringoptional
Requester state/region.
languagestringoptional
Request language.
channelstringoptional
Submission channel.
first_namestringoptional
Requester first name (PII; when set).
last_namestringoptional
Requester last name (PII; when set).
phone_numberstringoptional
Requester phone number (PII; when set).
changed_by_idstringnullableoptional
ID of the account that last changed it.
system_request_idstringoptional
Source system DSR template ID.
property_idstringoptional
Property ID.
company_idstringoptional
Company ID.
profileobjectoptional
Linked end-user profile, when present.
Show properties
idstringoptional
emailstringoptional
first_namestringoptional
last_namestringoptional
is_verifiedbooleanoptional
countrystringoptional
statestringoptional
confirmed_atstringnullableoptional
due_onstringnullableoptional
extended_due_onstringnullableoptional
created_atstringoptional
updated_atstringoptional

Response 200: Acknowledged

Payload

{
  "event": "dsar.verification.completed",
  "params": {},
  "entity": {
    "kind": "request",
    "data": {
      "id": "string",
      "status": "PENDING",
      "is_closed": false,
      "country": "string",
      "state": "string",
      "language": "string",
      "channel": "string",
      "first_name": "string",
      "last_name": "string",
      "phone_number": "string",
      "changed_by_id": "string",
      "system_request_id": "string",
      "property_id": "string",
      "company_id": "string",
      "profile": {
        "id": "string",
        "email": "string",
        "first_name": "string",
        "last_name": "string",
        "is_verified": false,
        "country": "string",
        "state": "string"
      },
      "confirmed_at": "string",
      "due_on": "string",
      "extended_due_on": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  }
}

Triggered when a user replies on a DSAR.

Request bodyapplication/json
eventstringrequired
The DSAR event name.
paramsobjectrequired
Event-specific context; may be empty.
entityobjectoptional
The related DSAR record.
Show properties
kindstringenumoptional
Entity type; always `request`.
Possible values: request
dataobjectoptional
Data subject request (DSAR) record. Fields are emitted only when set, including the linked `profile`. Requester contact fields (`first_name`, `last_name`, `phone_number`) hold PII and appear only when present.
Show properties
idstringoptional
Request ID.
statusstringenumoptional
Request status.
Possible values: PENDING OPEN IN_PROGRESS CLOSED
is_closedbooleanoptional
Whether the request has been closed.
countrystringoptional
Requester country code.
statestringoptional
Requester state/region.
languagestringoptional
Request language.
channelstringoptional
Submission channel.
first_namestringoptional
Requester first name (PII; when set).
last_namestringoptional
Requester last name (PII; when set).
phone_numberstringoptional
Requester phone number (PII; when set).
changed_by_idstringnullableoptional
ID of the account that last changed it.
system_request_idstringoptional
Source system DSR template ID.
property_idstringoptional
Property ID.
company_idstringoptional
Company ID.
profileobjectoptional
Linked end-user profile, when present.
Show properties
idstringoptional
emailstringoptional
first_namestringoptional
last_namestringoptional
is_verifiedbooleanoptional
countrystringoptional
statestringoptional
confirmed_atstringnullableoptional
due_onstringnullableoptional
extended_due_onstringnullableoptional
created_atstringoptional
updated_atstringoptional

Response 200: Acknowledged

Payload

{
  "event": "dsar.verification.completed",
  "params": {},
  "entity": {
    "kind": "request",
    "data": {
      "id": "string",
      "status": "PENDING",
      "is_closed": false,
      "country": "string",
      "state": "string",
      "language": "string",
      "channel": "string",
      "first_name": "string",
      "last_name": "string",
      "phone_number": "string",
      "changed_by_id": "string",
      "system_request_id": "string",
      "property_id": "string",
      "company_id": "string",
      "profile": {
        "id": "string",
        "email": "string",
        "first_name": "string",
        "last_name": "string",
        "is_verified": false,
        "country": "string",
        "state": "string"
      },
      "confirmed_at": "string",
      "due_on": "string",
      "extended_due_on": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  }
}

© 2026 ClymTermsPrivacy policyCookie policy