OGCR Digital Carbon Registry

A carbon registry built on open APIs, anchored on chain.

The registry records carbon activities, land parcels, verifications and certificates. It turns verified facts into tokens on the OGCR blockchain. Every app, service and AI agent works through the same secure APIs.

Designed to be open

The registry is made of separate services that all work through one secure API. Each service has one job. You can replace or extend any of them without changing the others.

API first

Every registry operation is a REST call with OpenAPI documentation, used by every app and service. Role-based access control (RBAC) checks each call, and Role Groups make access easy to grant and review.

Easy to evolve data model

The data model lives in a spreadsheet and is built at runtime, with its endpoints, Roles and indexes. Changing it needs no code change or redeploy.

Backed by a blockchain

Verified records are minted as tokens on the OGCR blockchain. Each token holds a hash of its record, so anyone can check that the two still match.

Ready for AI agents

Opey and the OBP-MCP server let AI agents read and act on the registry, limited by the same Roles as the person they work for.

Easy to connect apps

The registry pages, the marketplace and the Operator and Certification Platforms are separate apps that call the API for the people using them. A service that works on its own, such as the chain cache, connects as a Platform App, with only the access it is given.

Open standards

OAuth2, OpenID Connect, OpenAPI, JSON and MCP, with EVM tokens: ERC-721, ERC-20 and ERC-6551.

Open source

OBP-API, the OBP-MCP server, Opey and every OGCR repository are open source under the AGPL-3.0.

Runs in containers

Each service is built as a Docker image and deployed on Kubernetes.

How it fits together

OBP-API is the gateway to the registry. Apps and AI agents call it on behalf of people. Two services connect it to the OGCR blockchain: one mints tokens, the other mirrors them back.

The same overview is in the OGCR Architecture Glossary Item, where AI agents can read it through the OBP-MCP server.

OGCR registry architecture A schema spreadsheet feeds OGCR-DynamicEntities, which builds the data model in OBP-API. OGCR-App, the Operator Platform (OGCR-GILAB), the Certification Platform (ogcr-certification-platform) and AI agents call OBP-API over OAuth2 and OpenID Connect. The ogcr-tokenizer reads verified records from OBP-API and mints tokens on the OGCR chain. OGCR-Chain-Cache reads the tokens from the chain and writes mirror records back into OBP-API. Schema spreadsheet data model and access OGCR-App registry and marketplace Operator Platform for activity operators Certification Platform for certification bodies Opey and OBP-MCP AI agents OGCR-DynamicEntities builds the data model OAUTH2 AND OPENID CONNECT · OBP-OIDC OR KEYCLOAK OBP-API THE REGISTRY GATEWAY · OGCR SPACE Dynamic Entities Generated REST APIs Roles and Role Groups Indexes and Queries reads verified records writes mirror records mints reads ogcr-tokenizer turns verified facts into tokens OGCR chain OGCR-Smart-Contracts · chain 20253 OGCR-Chain-Cache mirrors tokens into the registry
Every app, service and agent reaches the registry through OBP-API. The tokenizer only reads from the registry, and the chain cache only reads from the chain.

The components

Each part of the registry is its own open source repository.

Gateway

OBP-API

OpenBankProject/OBP-API

The Open Bank Project API is the single gateway to the registry. It stores the registry's records as Dynamic Entities and generates a full set of REST endpoints for each one, with OpenAPI documentation.

  • Every call is authenticated with OAuth2 or OpenID Connect and checked against the caller's Roles, such as CanCreateDynamicEntityRecord_activity.
  • The registry lives in its own Space, ogcr, kept apart from anything else on the same instance.
  • Indexes and Dynamic Queries serve filtered and joined views, such as the public registry.
  • Records can link to each other, so an activity knows its parcels, operator and certificates.
Certification bodies

Certification Platform

OGCR-project/ogcr-certification-platform
README

Certification bodies verify and certify carbon activities. The Certification Platform, built by MultiOne, is their application, and a client of OBP-API.

  • It is registered as a Consumer of OBP-API, and reads and writes registry records through the endpoints generated from the Dynamic Entities.
  • What each person may see and do is set by their Roles in the registry, not by the app.
Operators

Operator Platform

OGCR-GILAB/operator-platform
README
OGCR-GILAB/operator-platform-api
README

Operators run carbon activities. The Operator Platform, built by OGCR-GILAB, is their application, and a client of OBP-API.

  • A React app with its own API service. Operators prepare their projects there, then submit them to the registry through OBP-API.
  • People's accounts live in the registry, and what each person may see and do is set by their Roles there.
  • Any other app can join the registry the same way: register a Consumer, log people in, and call the API.
Data model

OGCR-DynamicEntities

OpenBankProject/OGCR-DynamicEntities

The registry's data model is written in a spreadsheet: every entity, field, type, reference and index, and who may read or change each one. OGCR-DynamicEntities turns that spreadsheet into a live registry.

  • Creates and updates the Dynamic Entities in OBP-API, with their fields, references and indexes.
  • Creates the Role Groups that give each kind of user the access they need.
  • Creates the Dynamic Queries behind the registry's joined views.
  • Checks that OBP-API matches the spreadsheet, so the model never drifts. Existing records are kept when the model changes.
Registry and marketplace

OGCR-App

OpenBankProject/OGCR-App

The public face of the registry: its pages and the carbon credit marketplace, built with SvelteKit and the OGCR Design System.

  • People log in with OpenID Connect. The app then reads and writes through OBP-API with their token, and never writes directly to the chain.
  • The marketplace lists activities that already exist in the registry. Operators prove who they are, then add only their own marketing and commercial details.
  • Registry facts, such as the activity type, location, dates and methodologies, are always shown read-only, straight from the registry.
Minter

ogcr-tokenizer

TESOBE/ogcr-tokenizer

The tokenizer watches the registry and mints a token on the OGCR chain when a record reaches a verified state. A token carries a snapshot of the record, a link back to it and a hash of it, so anyone can check that the two still match.

  • Reads from OBP-API and never writes to it.
  • Will move to Platform App mode, so it reads the registry as itself, with only the access it is given.
  • Mints each token exactly once. A token waits until the tokens it depends on exist.
  • Reports its health at /healthz.
Tokens

OGCR-Smart-Contracts

OpenBankProject/OGCR-Smart-Contracts

Solidity contracts for the OGCR chain, chain id 20253. They define a family of tokens that follows an activity from its land parcels to its carbon credits.

  • ParcelNFT, ActivityNFT and CertificationNFT are ERC-721 tokens. Each attests to one registry record.
  • Each CarbonCreditBatchNFT owns an ERC-6551 account that holds its CarbonCredit ERC-20 balance.
  • Every token contract has one minter, the tokenizer's key, and an owner who can change it.
Mirror

OGCR-Chain-Cache

TESOBE/OGCR-chain-cache

The chain cache reads every OGCR token back from the chain and writes one mirror record per token into the registry, such as activity_on_chain. Apps and reports can then join on-chain state with off-chain records through the normal APIs, without talking to a node.

  • Reads the chain with no private key, and writes to OBP-API as its own Platform App.
  • Never changes the source records: the mirrors sit beside them and link to them.
  • Writes chain_sync_status after each run, so everyone can see how fresh the mirror is.
Login

OBP-OIDC and Keycloak

OpenBankProject/OBP-OIDC
OpenBankProject/OBP-Keycloak-Provider

People log in to the registry with OpenID Connect, through either OBP-OIDC or Keycloak. Apps get the tokens they use to call OBP-API from the same place.

  • OBP-OIDC is OBP's own OpenID Connect provider.
  • The OBP Keycloak Provider lets Keycloak check people's passwords against OBP-API, and take its clients from the Consumers registered there.
  • Either way, there is one list of people and one list of apps, both kept in OBP-API.
  • Apps that act for a person use the authorisation code grant. Services that act as themselves use the client credentials grant.
AI agents

Opey and OBP-MCP

OpenBankProject/OBP-MCP
OpenBankProject/OBP-Opey-II

The OBP-MCP server lets AI agents find and call the registry's endpoints and read its Glossary. Opey, OBP's AI assistant, uses it to answer questions about the registry and to help build pages.

  • Claude Code, Claude Desktop and IDE agents connect with the user's own token.
  • Opey connects with a consent the user approves, so it can see and do only what that user's Roles allow.
Administration

OBP Portal and API Manager

OpenBankProject/OBP-Frontend

Two web apps for the people who run the registry and the developers who build on it.

  • In the Portal, developers register their apps as Consumers and get the credentials to call OBP-API.
  • In API Manager, administrators manage users, Roles, Consumers and Dynamic Entities.
Documentation

API Explorer II

OpenBankProject/API-Explorer-II

API Explorer II lists every endpoint of OBP-API, with its documentation, and lets you try it.

  • It includes the endpoints generated for the registry's Dynamic Entities. Browse the registry's endpoints.
  • You log in to try an endpoint, and it runs with your own Roles.
Security and performance

OBP Senti

OpenBankProject/OBP-Sentinel

OBP Senti is an AI agent that keeps watch over the registry. It reads the logs, metrics and telemetry of the running services, reviews the source code behind every endpoint that can be reached, and reports the few security and performance fixes that matter most.

  • Looks for security problems, such as missing authorisation checks or SQL injection, even where the logs show nothing wrong.
  • Spots errors that are new or growing, and calls that are getting slower.
  • Sends one short briefing, with each finding ranked by impact, confidence and effort.
  • Calls the registry as its own Platform App, with read-only access.

From verified record to token

A token is minted only when the registry says a fact has been verified. Each token links back to the record it attests to.

ParcelNFT

ERC-721

Minted when a parcel owner verification is verified.

ActivityNFT

ERC-721

Minted when an activity verification is verified and the activity has a certificate of compliance.

CertificationNFT

ERC-721

Minted for each certificate of compliance, including every re-certification.

CarbonCreditBatchNFT

ERC-721 + ERC-6551 · CarbonCredit ERC-20

Minted when a monitoring period verification is verified. Its own account receives the batch's carbon credits.

Simple rules, strong guarantees

Install OGCR DCR

You can run the whole OGCR platform yourself, to evaluate it or to run your own registry: on your own servers, or on Kubernetes.

Bare metal

Build from source

Every repository is listed under Components

Each part has its own repository, and its README explains how to build and run it. Set them up in this order, following the README each step links to:

  1. Run OBP-API, with PostgreSQL and Redis.
  2. Run a login provider: OBP-OIDC, or Keycloak with the OBP Keycloak Provider.
  3. Create the registry in OBP-API with OGCR-DynamicEntities. Its setup script creates the space, the Dynamic Entities, the Role Groups, the Dynamic Queries and the Glossary Items.
  4. Register OGCR-App as a Consumer and run it. Add the Operator Platform (with its API service) and the Certification Platform the same way.
  5. To anchor records on chain, deploy OGCR-Smart-Contracts to an EVM chain, then run ogcr-tokenizer and OGCR-Chain-Cache.
Kubernetes

Install with Helm

TESOBE/OGCR-Charts

Each service is built as a Docker image. The Helm charts in OGCR-Charts install them on your own Kubernetes cluster.

Contact

Funded by
the European Union

The OGCR Project has received funding from the European Union's Horizon Europe programme under grant agreement 101218854. Find out more about the project at ogcr.eu, or see the OGCR App.