Hero

API Docs

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

Working Papers

Overview

The Working Papers API endpoint allows an API user to request that DataShare generates and delivers the Working Papers report collection for a given Financial Period.

Obtaining Working Extracts

After the initial call to an endpoint, a 202 response will be given, and after subsequent call to the same endpoint, you will recieve the zipped(.zip) data files. Best practice is to implement 30 second retries, majority of data is available within 90seconds.

Required Parameters

Parameter Description Location
clientId
UUID
The unique identifier of your organisation within the DataShare system. Path
smeId
string
The unique identifier of your SME within the DataShare system. Path
Ocp-Apim-Subscription-Key
string
API Key fetched from DataShare Admin Query string parameter
startPeriodId
integer
The ID of the Start Period you wish to generate working papers FROM (this can be obtained from calling the GetPeriods endpoint) Query string parameter
endPeriodId
integer
The ID of the end period you wish to generate working papers TO. (this can be obtained from calling the GetPeriods endpoint) Query string parameter
GET /v1/{clientId}/{smeId}/working-papers/generate
     curl -X GET \ 
     https://api.{environment}.validis.com//v1/{clientId}/{smeId}
     /working-papers/generate \ 
     -H 'Authorization: bearer {Your_Auth_Token} \ 
     -H 'Ocp-Apim-Subscription-Key: {Your_API_Key}' \ 
     -H 'startPeriodId: {startPeriodId} \ 
     -H 'endPeriodId: {endPeriodId}' \