openapi: 3.1.0
info:
title: Isometric Certify Data Ingestion Beneficiaries Production Batches API
description: "# Standards\n\n## Versioning\n\nThis API will be safely versioned using root path versioning, in the format `/v{major}`. For example, `/registry/v0/supplier`.\n\n### Compatibility\n\nWe won't make breaking changes to existing API services or endpoints for API versions higher than `v0`. If breaking changes are necessary, we'll release a new major version.\nWe may deprecate APIs that have been replaced by a newer version. When doing so, we will expect\nintegrated partners to manage a transition to new resources within the deprecation timeline of old ones.\n\nWe will make the following sort of changes we do not consider to be breaking:\n\n- Adding new endpoints\n- Adding optional query parameters to API endpoints\n- Adding new properties to existing API responses\n- Reordering properties in existing API responses\n\nIt is important that clients are built to be robust to these changes.\n\n## Pagination\n\nOur API is based on the [Relay](https://relay.dev/docs/tutorial/connections-pagination/) pagination spec. Paginated endpoints\nwill return a `PaginatedListResource` which contains:\n\n- `page_info` - Containing information regarding pagination cursors and the total number of entities.\n- `nodes` - Each node is a paginated entity.\n- `total_count` - The total size of the list across all pages.\n\n### Pagination Parameters\n\nPaginated endpoints also accepted a standard set of query parameters:\n\n- `last` - An integer number of items to retrieve **before** the item represented by the cursor passed in the `before` parameter. Defaults to 10 with a maximum value of 50.\n- `before` - An opaque cursor representing the first item in the previously requested page to select items ordered before it. Submit the previously requested page's `start_cursor` here when paginated backwards.\n- `first` - An integer number of items to retrieve **after** the item represented by the cursor passed in the `after` parameter. Defaults to 10 with a maximum value of 50.\n- `after` - An opaque cursor representing the last item in the previously requested page to select items ordered after it. Submit the previously requested page's `end_cursor` here when paginated forwards.\n\nFor example, querying `/registry/v0/beneficiaries` will return a `PaginatedListResource` of the first page of 10 items:\n\n```json\n{\n \"page_info\": {\n \"has_previous_page\": false,\n \"start_cursor\": ...,\n \"has_next_page\": true,\n \"end_cursor\": \"mpG5kcuoFBYtlH\",\n },\n \"nodes\": [{\n \"id\": \"org_12345iso678\",\n \"name\": \"My Org\",\n ...\n }],\n \"total_count\": 100\n}\n```\n\nThen querying `/registry/v0/beneficiaries?first=15&after=mpG5kcuoFBYtlH` will return a `PaginatedListResource` of the next 15 items.\n\n## Dates\n\nDatetime fields in the APIs conform to the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format in UTC. For example: `2024-01-22T11:56:48.520641Z`.\n\n## Country Codes\n\nCountries are identified in the APIs via [ISO 3166-1 Alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) codes. For example: `GBR` and `USA`.\n# Authentication\n\nMost API requests will need to authenticate against the Isometric API in two ways simultaneously:\n\n- By passing a **client secret** in the `X-Client-Secret` header to identify the system integrating with the API.\n- By passing an **access token** in the `Authorization` header to authenticate as a specific organization, in order to gain access to its private data.\n\n### Client Authentication\n\nEvery API call to Isometric must include a **client secret** identifying the client application.\n\nThis client secret is tied to a particular environment - sandbox or production.\n\nThe client secret should be submitted on every API request via the `X-Client-Secret` header. For example `X-Client-Secret: uPrO...wxAh`.\n\n### Organization Authentication\n\nIn addition, a large number of API requests will require an **access token** in order for the caller to identify themselves and act as a specific Organization.\n\nTo authenticate as an Organization you will need to submit a JWT bearer access token via the `Authorization` header. For example: `Authorization: Bearer eyJh...sw5c`.\nIf you are going to be acting on behalf of other Organizations, they will need to generate the access token and pass it securely to you.\nAccess tokens should be treated as highly sensitive, kept secret and stored accordingly.\n\nAccess tokens are scoped to a single Organization - so if you are acting on behalf of multiple particular organizations, you will need to submit the appropriate access token on each request.\n\n### Managing Credentials\n\nCredentials can be managed through Certify UI in the [Team settings](https://registry.isometric.com/account/team-settings) section. Access tokens will expire after 1 year from generation. When you are approaching expiry, a new token will need to be generated.\n\nBoth client secrets and access tokens can be created and invalidated through UI.\nClient secrets do not expire and do not need to be rotated.\nIf either secret becomes compromised, it should be invalidated through the UI.\n# Key Certify Concepts\n\nThis page defines concepts used in Certify, and the [Certify API](/api-reference/certify/certify-introduction), which are helpful to understand when submitting information for verification via Certify. For a broader understanding of Isometric's verification processes on the Isometric Registry, please refer to the [Isometric Standard](https://isometric.com/standard).\n\n## Resource visibility\n\n- Until resources are submitted as part of a GHG statement, they are visible only to members of your organization.\n- After statement submission, they are visible to the verifier assigned to the GHG statement.\n- Once credits have been issued, removals are added to the [public registry](https://registry.isometric.com), and associated resources are visible publicly, with the exception of source documents.\n- Sources uploaded in the Certify platform are kept private by default once published on the Isometric registry (file names will be displayed). Contact Isometric to update public source visibility. Sources [added via the API](/api-reference/certify/post-source) can be set `public` on submission.\n\n## Resources\n\nThe main resources used in Certify are sources, datapoints, components and removals.\n\n### Sources\n\n- Sources represent a piece of evidence for a particular datapoint used in carbon accounting calculations.\n- Source documents are private, and only shared with the verifier assigned to a related removal.\n- Other information associated with a source, such as its display name, is visible publicly once the removal is on the public registry.\n- Verifiers are not notified when new sources are added to datapoints in a submitted removal, but they will immediately have access to the source documentation. Please notify the Isometric Registry Operations team when sources are added on a verifier's request so that we can ensure that the verifier is aware.\n\n### Datapoints\n\n- Datapoints represent any value used in carbon accounting calculations.\n- When creating datapoints, sources should be referenced to provide evidence for the value used.\n- A standard deviation should be provided if the datapoint is to be included in the variance propagation method of uncertainty analysis.\n- All datapoints are considered statistically independent for the purpose of variance propagation, although if a datapoint is used twice within a removal calculation, this dependence is captured.\n\n### Components\n\n- Components represent physical activities whose CO₂e flux needs to be accounted for.\n- Components are created from [component blueprints](/user-guides/certify/component-blueprint-library) that contain sets of equations used to calculate a transfer of CO₂e into or out of the atmosphere.\n- A blueprint defines a set of inputs that are the datapoints to be used in the calculation. For instance, a transport emissions blueprints would ask for datapoints representing a distance, mass and carbon intensity.\n- When creating a component from a blueprint, the blueprint must be specified, as well as a list of datapoints for the expected blueprint inputs. Learn more about components in [Identifying Components](/user-guides/certify/identifying-components).\n\n### Removals\n\n- Removals represent a series of activities that result in CO₂e being removed from the atmosphere.\n- The carbon accounting of a removal typically contains sequestrations, counterfactuals and activities (emissions).\n- Removals are structured using a template, [defined in your LCA](/user-guides/certify/lca).\n- Templates are divided into component groups. For instance, a biochar template may contain a `Feedstock sourcing` group.\n- Groups can contain multiple components.\n- Components can also be partially attributed to removals, if the activity the component represents contributed to multiple removals.\n- The final uncertainty discounting is done on the removal level - the API will return the CO₂e removed with and without discounting.\n- See the [Create a removal](/user-guides/certify/removal) guide for more details.\n\n### Feedstock types\n\n- Many carbon removal methods involve a feedstock, for instance biomass feedstock in BiCRS or silicate rock in enhanced weathering.\n- Feedstock types are used to describe the feedstock used in a removal.\n- When creating a removal, a feedstock type can be optionally specified so that Isometric and verifiers can see which removals use which feedstocks.\n- This is important if different feedstocks are used in a single GHG statement.\n- See the [Add feedstock](/user-guides/certify/add-feedstock) guide for more details.\n"
version: v0
servers:
- url: /mrv/v0
- url: https://api.sandbox.isometric.com/mrv/v0
description: Sandbox Isometric MRV API
- url: https://api.isometric.com/mrv/v0
description: Production Isometric MRV API
tags:
- name: Production Batches
paths:
/production_batches:
post:
summary: Post Production Batch
description: Creates a production batch in the Isometric system
operationId: post_production_batch_production_batches_post
security:
- HTTPBearer: []
parameters:
- name: x-client-secret
in: header
required: true
schema:
type: string
title: Client secret
description: A secret token identifying the client connecting to the API
examples:
- Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP
description: A secret token identifying the client connecting to the API
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateProductionBatchRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ProductionBatch'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Production Batches
get:
summary: Get Production Batches
description: Lists production batches in the Isometric system.
operationId: get_production_batches_production_batches_get
security:
- HTTPBearer: []
parameters:
- name: last
in: query
required: false
schema:
type: integer
maximum: 50
exclusiveMinimum: 0
description: An integer number of items to retrieve before the item represented by the cursor passed in the before parameter. Defaults to 10 with a maximum value of 50.
default: 10
title: Last
- name: before
in: query
required: false
schema:
anyOf:
- type: string
minLength: 1
- type: 'null'
description: An opaque cursor representing the first item in the previously requested page to select items ordered before it. Submit the previously requested page’s start_cursor here when paginated backwards.
title: Before
- name: first
in: query
required: false
schema:
type: integer
maximum: 50
exclusiveMinimum: 0
description: An integer number of items to retrieve after the item represented by the cursor passed in the after parameter. Defaults to 10 with a maximum value of 50.
default: 10
title: First
- name: after
in: query
required: false
schema:
anyOf:
- type: string
minLength: 1
- type: 'null'
description: An opaque cursor representing the last item in the previously requested page to select items ordered after it. Submit the previously requested page’s end_cursor here when paginated forwards.
title: After
- name: x-client-secret
in: header
required: true
schema:
type: string
title: Client secret
description: A secret token identifying the client connecting to the API
examples:
- Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP
description: A secret token identifying the client connecting to the API
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedListResource_ProductionBatch_'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Production Batches
/production_batches/{id}:
get:
summary: Get Production Batch
description: Get a single production batch in the Isometric system
operationId: get_production_batch_production_batches__id__get
security:
- HTTPBearer: []
parameters:
- name: id
in: path
required: true
schema:
$ref: '#/components/schemas/IsometricIDPathParam_ProductionBatch_'
- name: x-client-secret
in: header
required: true
schema:
type: string
title: Client secret
description: A secret token identifying the client connecting to the API
examples:
- Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP
description: A secret token identifying the client connecting to the API
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ProductionBatch'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Production Batches
delete:
summary: Delete Production Batch
description: Deletes a production batch in the Isometric system
operationId: delete_production_batch_production_batches__id__delete
security:
- HTTPBearer: []
parameters:
- name: id
in: path
required: true
schema:
$ref: '#/components/schemas/IsometricIDPathParam_ProductionBatch_'
- name: x-client-secret
in: header
required: true
schema:
type: string
title: Client secret
description: A secret token identifying the client connecting to the API
examples:
- Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP
description: A secret token identifying the client connecting to the API
responses:
'204':
description: Successful Response
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Production Batches
components:
schemas:
IsometricIDPathParam_ProductionBatch_:
$ref: '#/components/schemas/IsometricIDRequestParam_ProductionBatch_'
ProductionBatch:
properties:
id:
type: string
maxLength: 37
minLength: 20
title: Id
examples:
- ptb_1GAFJ4C051S06E0Z
- ptb_1FQVMJYTASBXSZT8
example: ptb_1GAFJ4C051S06E0Z
facility_id:
type: string
maxLength: 37
minLength: 20
title: Facility Id
examples:
- fcl_1G8QT5ZAB1S0XSDW
- fcl_1E384BDCGSBXNNZZ
example: fcl_1G8QT5ZAB1S0XSDW
feedstock_type_ids:
items:
type: string
maxLength: 37
minLength: 20
examples:
- ftt_1D7KZ1P761S0G7BN
- ftt_1CSRJN4HHSBXZ3TK
example: ftt_1D7KZ1P761S0G7BN
type: array
title: Feedstock Type Ids
supplier_reference_id:
anyOf:
- type: string
maxLength: 100
minLength: 1
description: 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.
- type: 'null'
title: Supplier Reference Id
kind:
$ref: '#/components/schemas/ProductionBatchKind'
started_at:
type: string
format: date-time
title: Started At
ended_at:
type: string
format: date-time
title: Ended At
uploaded_at:
type: string
format: date-time
title: Uploaded At
display_name:
type: string
title: Display Name
mass:
$ref: '#/components/schemas/ScalarQuantity'
type: object
required:
- id
- facility_id
- feedstock_type_ids
- supplier_reference_id
- kind
- started_at
- ended_at
- uploaded_at
- display_name
- mass
title: ProductionBatch
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
input:
title: Input
ctx:
type: object
title: Context
type: object
required:
- loc
- msg
- type
title: ValidationError
PageInfo:
properties:
has_previous_page:
type: boolean
title: Has Previous Page
start_cursor:
anyOf:
- type: string
- type: 'null'
title: Start Cursor
has_next_page:
type: boolean
title: Has Next Page
end_cursor:
anyOf:
- type: string
- type: 'null'
title: End Cursor
type: object
required:
- has_previous_page
- start_cursor
- has_next_page
- end_cursor
title: PageInfo
ScalarQuantity:
properties:
magnitude:
type: number
title: Magnitude
unit:
type: string
minLength: 1
title: Unit
standard_deviation:
anyOf:
- type: number
- type: 'null'
title: Standard Deviation
type: object
required:
- magnitude
- unit
title: ScalarQuantity
PaginatedListResource_ProductionBatch_:
properties:
nodes:
items:
$ref: '#/components/schemas/ProductionBatch'
type: array
title: Nodes
total_count:
type: integer
title: Total Count
page_info:
$ref: '#/components/schemas/PageInfo'
type: object
required:
- nodes
- total_count
- page_info
title: PaginatedListResource[ProductionBatch]
CreateProductionBatchRequest:
properties:
facility_id:
type: string
maxLength: 37
minLength: 20
title: Facility Id
description: The facility where the production batch was created
examples:
- fcl_1G8QT5ZAB1S0XSDW
- fcl_1E384BDCGSBXNNZZ
example: fcl_1G8QT5ZAB1S0XSDW
feedstock_type_ids:
items:
type: string
maxLength: 37
minLength: 20
examples:
- ftt_1D7KZ1P761S0G7BN
- ftt_1CSRJN4HHSBXZ3TK
example: ftt_1D7KZ1P761S0G7BN
type: array
title: Feedstock Type Ids
description: The kinds of feedstock used to create this production batch
supplier_reference_id:
type: string
maxLength: 100
minLength: 1
title: Supplier Reference Id
description: 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.
kind:
$ref: '#/components/schemas/ProductionBatchKind'
description: The kind of production batch
started_at:
type: string
format: date-time
title: Started At
description: The date and time at which production of this production batch was started
ended_at:
type: string
format: date-time
title: Ended At
description: The date and time at which production of this production batch was completed
mass:
$ref: '#/components/schemas/ScalarQuantity'
display_name:
anyOf:
- type: string
maxLength: 100
minLength: 1
- type: 'null'
title: Display Name
description: The display name for this production batch. If not provided, one will be auto-generated from the facility name
type: object
required:
- facility_id
- feedstock_type_ids
- supplier_reference_id
- kind
- started_at
- ended_at
- mass
title: CreateProductionBatchRequest
IsometricIDRequestParam_ProductionBatch_:
type: string
maxLength: 37
minLength: 20
examples:
- ptb_1GAFJ4C051S06E0Z
- ptb_1FQVMJYTASBXSZT8
example: ptb_1GAFJ4C051S06E0Z
ProductionBatchKind:
type: string
enum:
- biochar
title: ProductionBatchKind
securitySchemes:
HTTPBearer:
type: http
description: 'A JWT Bearer token header for authentication and authorization, in the format `Authorization: Bearer <token>`'
scheme: bearer
bearerFormat: JWT