Documentation

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

Path Parameters

string

required

Response

200 - application/json

nodes

object[]

required

nodes.beneficiary

object | null

required

nodes.carbon_removal_data

object | null

required

Carbon removal data for this credit batch

nodes.ccp_approved

boolean

required

Whether this credit batch has been issued as part of a ICVCM Core Carbon Principles (CCP) approved project

nodes.country_of_issue

string

required

Required string length: 3

nodes.id

string

required

Required string length: 20 - 36

nodes.issuance_id

string

required

Required string length: 20 - 36

nodes.issued_at

string

required

nodes.left_child_id

string | null

required

If this credit batch has status SPLIT, it will have two child batches representing the two halves of this split.

Required string length: 20 - 36

nodes.owner

object

required

nodes.parent_id

string | null

required

If this credit batch was created from splitting a larger batch in two, this will be set to the id of the parent credit batch.

Required string length: 20 - 36

nodes.project_id

string

required

Required string length: 20 - 36

nodes.removal_id

string

required

Required string length: 20 - 36

nodes.removal_location

object | null

required

The location of the facility where this carbon removal took place, if available

nodes.retired_at

string | null

required

nodes.retirement_id

string | null

required

Required string length: 20 - 36

nodes.right_child_id

string | null

required

If this credit batch has status SPLIT, it will have two child batches representing the two halves of this split.

Required string length: 20 - 36

nodes.sequestered_on

string

required

nodes.serial_number

string

required

nodes.size

object

required

nodes.status

enum<string>

required

Available options:

active,

split,

retired

nodes.supplier_id

string

required

Required string length: 20 - 36

total_count

integer

required

Getting Started

Public Registry Data

Buyer Account Management

Supplier Account Management

Delivery Credit Batches

Authorizations

Headers

Path Parameters

Response