Hero

API Docs

Not all APIs are created equal - transform your connectivity with Validis API

Deletion

The Delete API endpoint requests that DataShare deletes the upload for a given engagement, and makes the engagement inaccessible via the API. Uploads are deleted in an out of hours process.

DELETE v1/archive/clients/{clientId}/engagements/{engagementId}

Required Parameters

Parameter Description Location
clientId
UUID
The unique identifier of your organisation within the DataShare system, as provided by the Authentication endpoint Path
smeId
string
The unique identifier of your SME within the DataShare system. Path
authorization
string
Valid access token (JSON Web Token) Header
Ocp-Apim-Subscription-Key
string
API Key fetched from DataShare Admin Header


curl -X POST \ 
  https://api.{environment}.validis.com/v1/archive/clients/{clientId}/
  engagements/{engagementId} \
  -H 'Authorization: bearer {authorization}' \
  -H 'Ocp-Apim-Subscription-Key: {Ocp-Apim-Subscription-Key}' \