Skip to content
EUDR Compliance API/
/
ViewSet for documents pro...

Coolset EUDR Compliance API (1.0)

EUDR compliance tools including due diligence statements, risk assessments, traceability, and evidence management.

Download OpenAPI description
eudr-api.json
eudr-api.yaml
Overview
URL
https://coolset.com
E-mail
support@coolset.com
Languages
Servers
Mock server
https://api.coolset.com/_mock/eudr-api/
Production server
https://developers-pulse.coolset.com/api/

Order Tracing

Operations

compliance

Operations

documents

Operations

ViewSet for documents providing list, retrieve, create and upload operations.

Request

  • list: Get all documents for the company
  • retrieve: Get a specific document
  • create: Create new document and get upload URL
  • confirm_upload: Confirm file upload completion
  • download: Generate download URL for private document
Security
Bearer
Query
limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return the results.

curl -i -X GET \
  'https://api.coolset.com/_mock/eudr-api/documents?limit=0&offset=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
countintegerrequired
nextstring or null(uri)
previousstring or null(uri)
resultsArray of objects(DocumentGCP)required
results[].​idinteger(ID)read-only
results[].​namestring(Name)[ 1 .. 510 ] charactersrequired
results[].​descriptionstring or null(Description)
results[].​sourcestring(Source)[ 1 .. 20 ] charactersrequired
results[].​file_pathstring(File path)[ 1 .. 1024 ] charactersrequired

GCS path: gs://bucket/path

results[].​file_sizeinteger or null(File size)read-only

File size in bytes

results[].​content_typestring or null(Content type)<= 255 characters
results[].​upload_statusstring(Upload status)read-only
Enum"pending""uploading""completed""failed"
results[].​uploaded_atstring or null(date-time)(Uploaded at)read-only
results[].​created_atstring(date-time)(Created at)read-only
results[].​updated_atstring(date-time)(Updated at)read-only
results[].​company_idinteger(Company id)read-only
results[].​user_company_idinteger(User company id)read-only
Response
application/json
{
  "count": 0,
  "next": "http://example.com",
  "previous": "http://example.com",
  "results": [
    { … }
  ]
}

Documents Create

Request

Create a new document and return upload URL.

Security
Bearer
Bodyapplication/jsonrequired
namestring(Name)[ 1 .. 510 ] charactersrequired
content_typestring(Content type)required
Enum"application/pdf""application/msword""application/vnd.openxmlformats-officedocument.wordprocessingml.document""application/vnd.ms-excel""application/vnd.openxmlformats-officedocument.spreadsheetml.sheet""application/vnd.ms-powerpoint""application/vnd.openxmlformats-officedocument.presentationml.presentation""image/jpeg""image/png""image/gif"
descriptionstring(Description)
curl -i -X POST \
  https://api.coolset.com/_mock/eudr-api/documents \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "content_type": "application/pdf",
    "description": "string"
  }'

Responses

Bodyapplication/json
namestring(Name)[ 1 .. 510 ] charactersrequired
content_typestring(Content type)required
Enum"application/pdf""application/msword""application/vnd.openxmlformats-officedocument.wordprocessingml.document""application/vnd.ms-excel""application/vnd.openxmlformats-officedocument.spreadsheetml.sheet""application/vnd.ms-powerpoint""application/vnd.openxmlformats-officedocument.presentationml.presentation""image/jpeg""image/png""image/gif"
descriptionstring(Description)
Response
application/json
{
  "name": "string",
  "content_type": "application/pdf",
  "description": "string"
}

ViewSet for documents providing list, retrieve, create and upload operations.

Request

  • list: Get all documents for the company
  • retrieve: Get a specific document
  • create: Create new document and get upload URL
  • confirm_upload: Confirm file upload completion
  • download: Generate download URL for private document
Security
Bearer
Path
idstringrequired
curl -i -X GET \
  'https://api.coolset.com/_mock/eudr-api/documents/{id}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
idinteger(ID)read-only
namestring(Name)[ 1 .. 510 ] charactersrequired
descriptionstring or null(Description)
sourcestring(Source)[ 1 .. 20 ] charactersrequired
file_pathstring(File path)[ 1 .. 1024 ] charactersrequired

GCS path: gs://bucket/path

file_sizeinteger or null(File size)read-only

File size in bytes

content_typestring or null(Content type)<= 255 characters
upload_statusstring(Upload status)read-only
Enum"pending""uploading""completed""failed"
uploaded_atstring or null(date-time)(Uploaded at)read-only
created_atstring(date-time)(Created at)read-only
updated_atstring(date-time)(Updated at)read-only
company_idinteger(Company id)read-only
user_company_idinteger(User company id)read-only
Response
application/json
{
  "id": 0,
  "name": "string",
  "description": "string",
  "source": "string",
  "file_path": "string",
  "file_size": 0,
  "content_type": "string",
  "upload_status": "pending",
  "uploaded_at": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "company_id": 0,
  "user_company_id": 0
}

Documents Confirm Upload

Request

Confirm that file upload was completed.

Security
Bearer
Path
idstringrequired
Bodyapplication/jsonrequired
namestring(Name)[ 1 .. 510 ] charactersrequired
descriptionstring or null(Description)
sourcestring(Source)[ 1 .. 20 ] charactersrequired
file_pathstring(File path)[ 1 .. 1024 ] charactersrequired

GCS path: gs://bucket/path

content_typestring or null(Content type)<= 255 characters
curl -i -X POST \
  'https://api.coolset.com/_mock/eudr-api/documents/{id}/confirm_upload' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "description": "string",
    "source": "string",
    "file_path": "string",
    "content_type": "string"
  }'

Responses

Bodyapplication/json
idinteger(ID)read-only
namestring(Name)[ 1 .. 510 ] charactersrequired
descriptionstring or null(Description)
sourcestring(Source)[ 1 .. 20 ] charactersrequired
file_pathstring(File path)[ 1 .. 1024 ] charactersrequired

GCS path: gs://bucket/path

file_sizeinteger or null(File size)read-only

File size in bytes

content_typestring or null(Content type)<= 255 characters
upload_statusstring(Upload status)read-only
Enum"pending""uploading""completed""failed"
uploaded_atstring or null(date-time)(Uploaded at)read-only
created_atstring(date-time)(Created at)read-only
updated_atstring(date-time)(Updated at)read-only
company_idinteger(Company id)read-only
user_company_idinteger(User company id)read-only
Response
application/json
{
  "id": 0,
  "name": "string",
  "description": "string",
  "source": "string",
  "file_path": "string",
  "file_size": 0,
  "content_type": "string",
  "upload_status": "pending",
  "uploaded_at": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "company_id": 0,
  "user_company_id": 0
}

Documents Download

Request

Generate a signed URL for downloading a private document.

Security
Bearer
Path
idstringrequired
curl -i -X GET \
  'https://api.coolset.com/_mock/eudr-api/documents/{id}/download' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
idinteger(ID)read-only
namestring(Name)[ 1 .. 510 ] charactersrequired
descriptionstring or null(Description)
sourcestring(Source)[ 1 .. 20 ] charactersrequired
file_pathstring(File path)[ 1 .. 1024 ] charactersrequired

GCS path: gs://bucket/path

file_sizeinteger or null(File size)read-only

File size in bytes

content_typestring or null(Content type)<= 255 characters
upload_statusstring(Upload status)read-only
Enum"pending""uploading""completed""failed"
uploaded_atstring or null(date-time)(Uploaded at)read-only
created_atstring(date-time)(Created at)read-only
updated_atstring(date-time)(Updated at)read-only
company_idinteger(Company id)read-only
user_company_idinteger(User company id)read-only
Response
application/json
{
  "id": 0,
  "name": "string",
  "description": "string",
  "source": "string",
  "file_path": "string",
  "file_size": 0,
  "content_type": "string",
  "upload_status": "pending",
  "uploaded_at": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "company_id": 0,
  "user_company_id": 0
}

eudr

Operations

imports

Operations

traces

Operations