Sign in
latestOpenAPI 3.0.02026-08-10517386.6 KB

a9f1b102faca

Retirements

Finalize retirement certificate

This endpoint can be used by owners of an onchain retirement to finalize their retirement certificate - a certificate is only available for finalization if the retirement was made onchain and the beneficiary is missing.

post/retirements/finalize

Headers

x-icr-api-versionstring

API version

Request body

signerstring required

The signer address.

signaturestring required

The signature. This a standard signature created by signing the data as a string in the following format - with double ";;" between each field - "beneficiary;;comment;;reason;;projectAddress;;tokenId" for info on how to sign strings see -> https://docs.ethers.org/v6/cookbook/signing/#cookbook-signing-messages

Example request

{
  "signer": "0xA0022c05501007281acAE55B94AdE4Fc3dd59ec3",
  "signature": "0xf76145d74ff1a3e70ca51e44063b6a90cf5e5d82e11941d3691e9dee197d124f748b6fcd8d3ecc7a45e08fe698be6f9e24685b5d8e270612e727380ede19c3321c",
  "signedData": {
    "comment": "This retirement is for a sustainability project.",
    "reason": "Corsia",
    "tokenId": "47",
    "projectAddress": "0x49a88d0dd5f316556794877940d515d1a9b2c3c3",
    "beneficiary": "Jane Doe"
  }
}

Response

createdAtstring date-time required

The date of when this retirement was made

idstring required

The ID of the retirement

isClaimedboolean

Whether this retirement has been claimed - is false if the retirement happened permissionlessly on blockchain and owner has not claimed the retirement on ICR

reasonstring

The reason for the retirement

commentstring

A comment about the retirement

beneficiarystring

The name of the retiree

organizationIdstring required

The ID of the organization associated with the retirement

serializationstring

The serialization of the carbon credits associated with the retirement

vintagestring

The vintage year of the carbon credits associated with the retirement

amountnumber required

The amount of the retirement

Example response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "reason": "Reached retirement age",
  "comment": "Congratulations on your retirement!",
  "beneficiary": "John Doe",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "organizationOwner": {
    "total": 100,
    "currentPage": 1,
    "pageCount": 10,
    "nextPage": 2
  },
  "serialization": "ICR-ISL-354-78040-14-R-0-2021",
  "vintage": "2020",
  "amount": 1000,
  "project": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "fullName": "Project 1",
    "url": "https://api.carbonregistry.com/projects/47abd663-fb35-4b2e-ad08-c347e761649e",
    "publicUrl": "https://carbonregistry.com/explore/projects/47abd663-fb35-4b2e-ad08-c347e761649e"
  }
}