---
title: "Claim an unclaimed retirement certificate"
method: POST
path: "/retirements/claim"
tags: ["Retirements"]
---

# Claim an unclaimed retirement certificate

`POST /retirements/claim`

This endpoint can be used by owners of an onchain retirement to claim the retirement certificate on their ICR organization - claiming an onchain retirement certificate is only possible once.

## Headers

- `x-icr-api-version` string

## Request body

- ClaimRetirementMutationParams
  - `signer` string, required — The signer address.
  - `signature` string, required — The signature.
  - `signedData` SignedClaimRetirementData, required
    - `tokenId` string, required — The token Id of the retirement nft.
    - `projectAddress` string, required — The contract address of the project where the retirement certificate was issued from.
    - `organizationId` string, required — The ICR organization id that is claiming this retirement certificate
    - `userId` string, required — The ICR user id that is claiming this retirement certificate

## Response `200`

- ApiRetirementDto
  - `createdAt` string, date-time, required — The date of when this retirement was made
  - `id` string, required — The ID of the retirement
  - `isClaimed` boolean — Whether this retirement has been claimed - is false if the retirement happened permissionlessly on blockchain and owner has not claimed the retirement on ICR
  - `reason` string — The reason for the retirement
  - `comment` string — A comment about the retirement
  - `beneficiary` string — The name of the retiree
  - `organizationId` string, required — The ID of the organization associated with the retirement
  - `organizationOwner` ApiPaginationDto
    - `total` number, required — Total number of items
    - `currentPage` number, required — Current page number
    - `pageCount` number, required — Total number of pages
    - `nextPage` number — Next page number
    - `prevPage` number — Previous page number
  - `serialization` string — The serialization of the carbon credits associated with the retirement
  - `vintage` string — The vintage year of the carbon credits associated with the retirement
  - `amount` number, required — The amount of the retirement
  - `project` ApiProject, required
    - `id` string, required — The ID of the project
    - `fullName` string, required — The full name of the project
    - `url` string, required — The URL of the project
    - `publicUrl` string, required — The public URL of the project
    - `num` number, required — Project number. This is a unique identifier for the project

---

[API](https://skmtc.net/carbonregistry/apis/carbon-registry-rest-api.md) · [All operations](https://skmtc.net/carbonregistry/apis/carbon-registry-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/carbonregistry/carbon-registry-rest-api/revisions/a9f1b102faca/schema)
