2026-06-12
v0.3.1
- Added support for authenticating with OAuth 2.0 client credentials.
- Added new endpoints to create organisations and sites.
- Added new endpoints to query delivery configs.
- Added new delivery endpoints to query and create deliveries.
-
Corrected the documented type of the sink fields
tracked_gross_co2e_removal_in_kg,tracked_net_co2e_removal_in_kg, andverified_net_co2e_removal_in_kgfromintegertonumber. -
Added nullable
verified_atfield to sink responses, containing the day the removal was verified by the registry. -
Added a
coordinatesandaddressfield on site responses, deprecated the previouslocationfield. -
Added an
organisationfield on site responses, deprecated the previousorganisation_idfield.
2026-03-05
v0.3.0
- Breaking Return only verified sinks
from the
/sinksendpoints. - Breaking Removed the
sink.createdevent. - Breaking Moved from asymmetric to
symmetric signatures for webhook deliveries (see
Receiving Event Updates):
- The webhook secret was renamed from
public_keytosecret. - The signature format changed from
ed25519/v1atoHMAC-SHA256/v1.
- The webhook secret was renamed from
- Breaking Moved the
confirmation_document_idfield from the material application tracking step to the sink, since the document is sink-specific.
2026-01-28
v0.2.0
- Breaking Removed tracking step
information from the
/sinksendpoint (only the/sinks/{id}endpoint includes them). - Breaking Replaced the
application_matrixfield in thematerial_applicationtracking step type with anapplication_descriptionfield. - Breaking Marked
idofregistry_referenceas nullable. - Added
rainbowas a possible registry type. - Breaking Removed the
pyrolysistracking step type in favor of the more generalmaterial_processingstep type. - Breaking Marked
confirmation_document_idof thematerial_applicationtracking step type as nullable. - Breaking Removed the
transport_modefield of thedeliverytracking step type. - Breaking Marked
verified_net_co2e_removal_in_kgas nullable. - Breaking Renamed the
/document/{id}endpoint to/documents/{id}to conform with the naming scheme. - Breaking Removed the
legal_addressfield on the response organisation in favor of a nullablefull_address. - Breaking Renamed
legal_nameon the response organisation tonameand marked it nullable. - Breaking Removed the
contact_infofield from the response organisation and site. - Breaking Marked
nameof the response site as nullable.
2026-01-27
v0.1.2
- Removed
nullableflags of the response array fieldsprevious_step_idsanddocument_idsof sinks.
2026-01-26
v0.1.1
- Marked all response fields as required; optional fields return explicitly
null. - Breaking Added
maxLengthconstraints to the webhook endpoint fieldsurlanddescription.