Coolset Compliance API (1.0)
Download OpenAPI specification:Download
Regulation-neutral compliance: read the risk assessments Coolset runs for EUDR, PPWR and other regulations, and download their evidence.
Read the risk assessments Coolset runs on your orders and products, and inspect or download their evidence bundles. Assessments are asynchronous; results and metadata are untyped JSON that depends on assessment_type.
Base URL: https://developers-pulse.coolset.com/api
List risk assessments
Returns all EUDR risk assessments for the authenticated company. Each assessment includes its identifier, risk level, evidence status, and linked supply chain data. A full assessment can run to tens of KB, so pass compact=true to leave out results, analyzed_assessments, assessable_objects and pulse_params, then retrieve the assessments you need by ID.
Authorizations:
query Parameters
| assessment_date__gte | string <date-time> |
| assessment_date__lte | string <date-time> |
| assessment_run_id | string <uuid> |
| assessment_type | string |
| assessment_type__in | Array of strings Multiple values may be separated by commas. |
| compact | boolean When true, leaves out results, analyzed_assessments, assessable_objects and pulse_params. |
| identifier | string |
| identifier__icontains | string |
| identifier__in | Array of strings Multiple values may be separated by commas. |
| include_analyzed_assessments | string Enum: "false" "true" When true, includes assessments found in analyzed_assessments of current queryset (max 10 assessments for performance)
|
| latest_per_identifier | string Enum: "false" "true" When true, returns only the latest assessment for each identifier
|
| limit | integer Number of results to return per page. |
| metadata__commodity | string |
| metadata__commodity__icontains | string |
| metadata__harvest_date | string |
| metadata__harvest_date__gte | string |
| metadata__harvest_date__lte | string |
| offset | integer The initial index from which to return the results. |
Responses
Response samples
- 200
{- "count": 123,
- "results": [
- {
- "id": 0,
- "identifier": "string",
- "display_name": "string",
- "assessment_type": "string",
- "assessment_run_id": "37f2e5f0-9226-4862-9c63-e98406e7afc5",
- "results": null,
- "assessment_summary": {
- "property1": null,
- "property2": null
}, - "assessment_date": "2019-08-24T14:15:22Z",
- "analyzed_assessments": null,
- "assessable_objects": null,
- "company_id": 0,
- "metadata": null,
- "pulse_params": {
- "identifier": "string",
- "model_identifier": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}Retrieve a risk assessment
Returns a single EUDR risk assessment for the authenticated company by ID, including its results and assessed objects.
Authorizations:
path Parameters
| id required | integer A unique integer value identifying this Risk Assessment. |
Responses
Response samples
- 200
{- "id": 0,
- "identifier": "string",
- "display_name": "string",
- "assessment_type": "string",
- "assessment_run_id": "37f2e5f0-9226-4862-9c63-e98406e7afc5",
- "results": null,
- "assessment_summary": {
- "property1": null,
- "property2": null
}, - "assessment_date": "2019-08-24T14:15:22Z",
- "analyzed_assessments": null,
- "assessable_objects": null,
- "company_id": 0,
- "metadata": null,
- "pulse_params": {
- "identifier": "string",
- "model_identifier": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}List available evidence items
Returns the evidence bundle for a risk assessment as a tree of groups (one per analyzed assessment) and their selectable items (one per file). Use the item keys with the evidence download endpoint to download a subset.
Authorizations:
path Parameters
| risk_assessment_id required | integer |
Responses
Response samples
- 200
{- "groups": [
- {
- "assessment_run_id": "string",
- "identifier": "string",
- "assessment_type": "string",
- "display_name": "string",
- "items": [
- {
- "key": "string",
- "name": "string",
- "size_bytes": 0,
- "content_type": "string",
- "last_modified": "2019-08-24T14:15:22Z"
}
]
}
]
}Download evidence package
Generates and downloads a ZIP file of evidence for the specified risk assessment. By default the full bundle is returned. Pass a non-empty selected_items list of blob keys (from the evidence-bundle endpoint) to download only those items. The ZIP is named using the assessment's display name.
Authorizations:
path Parameters
| risk_assessment_id required | integer |
Request Body schema:
| selected_items | Array of strings[ items non-empty ] Blob keys to include. Empty/absent downloads the full bundle. |
Responses
Request samples
- Payload
{- "selected_items": [
- "string"
]
}