API ReferencePrivacy Requests

Submit a new privacy request (DSAR)

Submits a new data subject access request. The request will be processed asynchronously.

Authentication

Impilo-API-Keystring
API Key authentication via header

Request

This endpoint expects an object.
jurisdictionenumRequired
The regulatory jurisdiction for this request.
Allowed values:
receivedAtstringRequiredformat: "date-time"

The date/time when the request was received from the data subject.

subjectobjectRequired
The data subject and their identifiers.
typeenumRequired
The type of privacy request.
Allowed values:
metadatamap from strings to objectsOptional
Optional metadata associated with this request.

Response

Request accepted for processing
completedAtstring or nullformat: "date-time"

The date/time when processing completed.

createdAtstring or nullformat: "date-time"

The date/time when the request was created in the system.

failureReasonstring or null
Reason for failure, if the request failed.
idlong or null
Unique identifier for the privacy request.
jurisdictionenum or null
The regulatory jurisdiction for this request.
Allowed values:
matchedPatientCountinteger or null

Number of patients matched (populated for ambiguous match failures).

metadatamap from strings to objects or null
Optional metadata associated with this request.
processingStartedAtstring or nullformat: "date-time"

The date/time when processing started.

receivedAtstring or nullformat: "date-time"

The date/time when the request was received from the data subject.

statusenum or null
The current status of the request.
subjectobject or null
The data subject and their identifiers.
typeenum or null
The type of privacy request.
Allowed values:
updatedAtstring or nullformat: "date-time"

The date/time when the request was last updated.

Errors