POST
/
removals

Authorizations

Authorization
string
headerrequired

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

Body

application/json

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

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
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.

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
completed_at
string | null

This field is deprecated, please use completed instead. The date by which activities related to this removal finished.

completed_on
string | null

The date by which activities related to this removal finished.

feedstock_type_id
string | null

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

Required string length: 20 - 36
started_at
string | null

This field is deprecated, please use started instead. The date at which activities related to this removal started.

started_on
string | null

The date at which activities related to this removal started.

Response

200 - application/json
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.

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.

id
string
required
Required string length: 20 - 36
started_on
string
required
supplier_reference_id
string | null
required

Was this page helpful?

Get RemovalPatch Removal