Skip to main content
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, and verified_net_co2e_removal_in_kg from integer to number.
  • Added nullable verified_at field to sink responses, containing the day the removal was verified by the registry.
  • Added a coordinates and address field on site responses, deprecated the previous location field.
  • Added an organisation field on site responses, deprecated the previous organisation_id field.
2026-03-05

v0.3.0

  • Breaking Return only verified sinks from the /sinks endpoints.
  • Breaking Removed the sink.created event.
  • Breaking Moved from asymmetric to symmetric signatures for webhook deliveries (see Receiving Event Updates):
    • The webhook secret was renamed from public_key to secret.
    • The signature format changed from ed25519/v1a to HMAC-SHA256/v1.
  • Breaking Moved the confirmation_document_id field 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 /sinks endpoint (only the /sinks/{id} endpoint includes them).
  • Breaking Replaced the application_matrix field in the material_application tracking step type with an application_description field.
  • Breaking Marked id of registry_reference as nullable.
  • Added rainbow as a possible registry type.
  • Breaking Removed the pyrolysis tracking step type in favor of the more general material_processing step type.
  • Breaking Marked confirmation_document_id of the material_application tracking step type as nullable.
  • Breaking Removed the transport_mode field of the delivery tracking step type.
  • Breaking Marked verified_net_co2e_removal_in_kg as nullable.
  • Breaking Renamed the /document/{id} endpoint to /documents/{id} to conform with the naming scheme.
  • Breaking Removed the legal_address field on the response organisation in favor of a nullable full_address.
  • Breaking Renamed legal_name on the response organisation to name and marked it nullable.
  • Breaking Removed the contact_info field from the response organisation and site.
  • Breaking Marked name of the response site as nullable.
2026-01-27

v0.1.2

  • Removed nullable flags of the response array fields previous_step_ids and document_ids of sinks.
2026-01-26

v0.1.1

  • Marked all response fields as required; optional fields return explicitly null.
  • Breaking Added maxLength constraints to the webhook endpoint fields url and description.
2026-01-23

v0.1.0

  • Initial release.