Sign in

v3

latestOpenAPI 3.1.02026-08-0797185285.8 KB

Post Removal

post/removals

Headers

x-client-secretstring required

A secret token identifying the client connecting to the API

Example:Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP

A secret token identifying the client connecting to the API

Request body

supplier_reference_idstring required

A string that must be unique for all resources created by a specific supplier. It can be used by a client to identify the correct objects in their system.

started_onstring date required

The date at which activities related to this removal started.

completed_onstring date required

The date by which activities related to this removal finished.

process_keystring nullable

Deprecated, please use the removal_template_id field instead.

The key of the process to be used. See the processes endpoint for the processes available.

project_idstring required

The ID of the project to associate this removal to.

feedstock_type_idstring nullable

The ID of the feedstock type that will be used for this removal.

removal_template_idstring nullable

This field will become required once the deprecated process_key field is removed.

ID of the removal template to instantiate the removal from.

Example request

{
  "steps": [
    {
      "components": [
        {
          "component_id": "cmp_1EP2SB7MZ1S036PY",
          "attribution_factor_datapoint_id": "dtp_1DVKHKS101S0Q61Q"
        }
      ]
    }
  ],
  "project_id": "prj_1CTWZQGKE1S0VAXA",
  "feedstock_type_id": "ftt_1D7KZ1P761S0G7BN",
  "removal_template_id": "rvt_1EVC8RZFE1S0BAT6",
  "removal_template_components": [
    {
      "removal_template_component_id": "rtc_1DAA58EDM1S0AMPN",
      "inputs": [
        {
          "datapoint_ids": [
            "dtp_1DVKHKS101S0Q61Q"
          ]
        }
      ]
    }
  ]
}

Response

Successful Response

idstring required
supplier_reference_idstring nullable required

A string that must be unique for all resources created by a specific supplier. It can be used by a client to identify the correct objects in their system.

started_onstring date required
completed_onstring date required
co2e_net_removed_kgnumber required

The CO₂e removed by this removal once uncertainty discounting has been applied

co2e_net_removed_without_discount_kgnumber required

The CO₂e removed by this removal before any uncertainty discounting has been applied

co2e_net_removed_standard_deviation_kgnumber nullable required

The standard deviation of the CO₂e net removed and therefore the uncertainty discount applied to the removal

ghg_statement_idstring nullable required

The GHG statement ID that this removal is associated with. If null, the removal is in draft and has not been submitted for verification.

feedstock_type_idstring nullable required

The feedstock type ID that this removal is associated with.

risk_of_reversal_percentagenumber nullable required

The percentage of credits contributed to the buffer pool due to risk of reversal.

Example response

{
  "id": "rmv_1EEM6NJXX1S0EXKD",
  "ghg_statement_id": "ggs_1GDQJ99Z51S0DYW9",
  "feedstock_type_id": "ftt_1D7KZ1P761S0G7BN"
}