POST
/
removals
curl --request POST \
  --url https://api.sandbox.isometric.com/mrv/v0/removals \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-client-secret: <x-client-secret>' \
  --data '{
  "completed_on": "2023-12-25",
  "feedstock_type_id": "ftt_1D7KZ1P761S0G7BN",
  "label_ids": [
    "lbl_1DDK2MJ2D1S0SR6H"
  ],
  "process_key": "<string>",
  "project_id": "prj_1CTWZQGKE1S0VAXA",
  "started_on": "2023-12-25",
  "steps": [
    {
      "components": [
        {
          "attribution_factor_datapoint_id": "dtp_1DVKHKS101S0Q61Q",
          "component_id": "cmp_1EP2SB7MZ1S036PY"
        }
      ],
      "process_step_key": "<string>"
    }
  ],
  "supplier_reference_id": "<string>"
}'
{
  "co2e_net_removed_kg": 123,
  "co2e_net_removed_standard_deviation_kg": 123,
  "co2e_net_removed_without_discount_kg": 123,
  "completed_on": "2023-12-25",
  "feedstock_type_id": "ftt_1D7KZ1P761S0G7BN",
  "ghg_statement_id": "ggs_1GDQJ99Z51S0DYW9",
  "id": "rmv_1EEM6NJXX1S0EXKD",
  "label_ids": [
    "lbl_1DDK2MJ2D1S0SR6H"
  ],
  "started_on": "2023-12-25",
  "supplier_reference_id": "<string>"
}

Authorizations

​
Authorization
string
header
required

A JWT Bearer token header for authentication and authorization, in the format Authorization: Bearer <token>

Headers

​
x-client-secret
string
required

A secret token identifying the client connecting to the API

Example:

"Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"

Body

application/json

Input to the POST /removals endpoint that creates a single removal

​
completed_on
string
required

The date by which activities related to this removal finished.

​
process_key
string
required

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

​
project_id
string
required

The ID of the project to associate this removal to.

Required string length: 20 - 36
Example:

"prj_1CTWZQGKE1S0VAXA"

​
started_on
string
required

The date at which activities related to this removal started.

​
steps
object[]
required

A list of steps to be included in the removal. The steps must match the steps defined in the process key. See the /processes endpoint to find which steps must be used.

Nested type for the POST /removals endpoint to create a step within a removal

​
supplier_reference_id
string
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.

Required string length: 1 - 100
​
feedstock_type_id
string | null

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

Required string length: 20 - 36
Example:

"ftt_1D7KZ1P761S0G7BN"

​
label_ids
string[] | null

IDs of the labels that will be associated with this removal.

Response

200
application/json
Successful Response
​
co2e_net_removed_kg
number
required

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

​
co2e_net_removed_standard_deviation_kg
number | null
required

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

​
co2e_net_removed_without_discount_kg
number
required

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

​
completed_on
string
required
​
feedstock_type_id
string | null
required

The feedstock type ID that this removal is associated with.

Required string length: 20 - 36
Example:

"ftt_1D7KZ1P761S0G7BN"

​
ghg_statement_id
string | null
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.

Required string length: 20 - 36
Example:

"ggs_1GDQJ99Z51S0DYW9"

​
id
string
required
Required string length: 20 - 36
Example:

"rmv_1EEM6NJXX1S0EXKD"

​
label_ids
string[]
required

The label IDs that this removal is associated with.

​
started_on
string
required
​
supplier_reference_id
string | null
required

Was this page helpful?

Get RemovalPatch Removal