Download OpenAPI specification:Download
The Puro.earth's registry API uses role-based access control (RBAC) to assign and manage rights for users. If a request is made by a user who lacks the needed authorization, the request will instead return either an HTTP 403 Forbidden or HTTP 404 Not Found response.
Not Found responses are reserved for cases where the application cannot determine whether the resource exists or whether the user is not able to interact with it. In endpoints that list multiple resources, only those the user is authorized to view will be returned.
limit | integer [ 1 .. 100 ] How many items to return at one time (max 100) |
offset | integer >= 0 How many items to skip |
{- "pagination": {
- "total": 1,
- "offset": 0,
- "limit": 100
}, - "data": [
- {
- "code": "P51023",
- "gsrn": "643002406801000400",
- "name": "Production facility 1",
- "methodologyCode": "C010000000",
- "supplierName": "string",
- "sdgs": [
- {
- "goal": "13",
- "name": "Climate Action"
}
], - "country": "US",
- "certificationStatus": "NOT_AVAILABLE",
- "creditingPeriod": {
- "start": "2024-01-01",
- "end": "2024-01-31"
}, - "geographicalLocation": {
- "latitude": "60.192059",
- "longitude": "24.945831"
}
}
]
}
productionFacilityCode required | string The code of the production facility to retrieve |
{- "code": "P51023",
- "gsrn": "643002406801000400",
- "name": "Production facility 1",
- "methodologyCode": "C010000000",
- "supplierName": "string",
- "sdgs": [
- {
- "goal": "13",
- "name": "Climate Action"
}
], - "country": "US",
- "certificationStatus": "NOT_AVAILABLE",
- "creditingPeriod": {
- "start": "2024-01-01",
- "end": "2024-01-31"
}, - "geographicalLocation": {
- "latitude": "60.192059",
- "longitude": "24.945831"
}
}
transactionId required | string <uuid> The id of the transaction to retrieve |
{- "transactionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
- "volume": 100,
- "completedOn": "2019-08-24T14:15:22Z",
- "accountHolderName": "Biochar Inc",
- "type": "Issuance",
- "bundles": [
- {
- "certificates": "PURO_PR_CORC100+_FI_148003_2024_0052850a-1263-4d3f-af6f-a91288df04e3_1-100",
- "volume": 100,
- "methodologyCode": "C03000000",
- "productionFacilityCode": "OC4C00",
- "vintage": 2022,
- "productionStartDate": "2022-01-01T00:00:00.000Z",
- "productionEndDate": "2022-12-12T00:00:00.000Z",
- "creditType": "CORC_100",
- "issuanceId": "string",
- "issuanceDate": "2019-08-24T14:15:22Z"
}
], - "labels": [
- {
- "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
- "name": "CCP-Approved"
}
], - "issuanceDetails": {
- "issuanceDate": "2019-08-24T14:15:22Z",
- "issuanceId": "string",
- "auditBody": "Auditor Ltd."
}, - "retirementDetails": {
- "usageType": "GENERIC_COMPENSATION",
- "beneficiaryName": "Tech Company Inc.",
- "beneficiaryLocation": "San Francisco",
- "beneficiaryType": "END_CONSUMER",
- "countryOfConsumption": "US",
- "consumptionPeriodStartDate": null,
- "consumptionPeriodEndDate": null,
- "beneficiaryHiddenUntil": "2025-12-31",
- "retirementPurpose": "Retired on behalf of X to offset emissions resulting from activities in 2023.",
- "publicStatementUrl": null
}, - "withdrawalDetails": {
- "reason": "Withdrawal reason"
}
}
transactionType | string Enum: "Issuance" "Transfer" "InternalTransfer" "Retirement" "Withdrawal" Select the transaction type to retrieve transaction |
productionFacilityCode | string The code of the production facility to retrieve Transaction |
limit | integer [ 1 .. 100 ] How many items to return at one time (max 100) |
offset | integer >= 0 How many items to skip |
{- "pagination": {
- "total": 1,
- "offset": 0,
- "limit": 100
}, - "data": [
- {
- "transactionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
- "volume": 100,
- "completedOn": "2019-08-24T14:15:22Z",
- "accountHolderName": "Biochar Inc",
- "type": "Issuance",
- "bundles": [
- {
- "certificates": "PURO_PR_CORC100+_FI_148003_2024_0052850a-1263-4d3f-af6f-a91288df04e3_1-100",
- "volume": 100,
- "methodologyCode": "C03000000",
- "productionFacilityCode": "OC4C00",
- "vintage": 2022,
- "productionStartDate": "2022-01-01T00:00:00.000Z",
- "productionEndDate": "2022-12-12T00:00:00.000Z",
- "creditType": "CORC_100",
- "issuanceId": "string",
- "issuanceDate": "2019-08-24T14:15:22Z"
}
], - "labels": [
- {
- "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
- "name": "CCP-Approved"
}
], - "issuanceDetails": {
- "issuanceDate": "2019-08-24T14:15:22Z",
- "issuanceId": "string",
- "auditBody": "Auditor Ltd."
}, - "retirementDetails": {
- "usageType": "GENERIC_COMPENSATION",
- "beneficiaryName": "Tech Company Inc.",
- "beneficiaryLocation": "San Francisco",
- "beneficiaryType": "END_CONSUMER",
- "countryOfConsumption": "US",
- "consumptionPeriodStartDate": null,
- "consumptionPeriodEndDate": null,
- "beneficiaryHiddenUntil": "2025-12-31",
- "retirementPurpose": "Retired on behalf of X to offset emissions resulting from activities in 2023.",
- "publicStatementUrl": null
}, - "withdrawalDetails": {
- "reason": "Withdrawal reason"
}
}
]
}
limit | integer [ 1 .. 100 ] How many items to return at one time (max 100) |
offset | integer >= 0 How many items to skip |
{- "pagination": {
- "total": 1,
- "offset": 0,
- "limit": 100
}, - "data": [
- {
- "certificates": "PURO_PR_CORC100+_FI_148003_2024_0052850a-1263-4d3f-af6f-a91288df04e3_1-100",
- "volume": 100,
- "accountHolderName": "Biochar Inc.",
- "methodologyCode": "C03000000",
- "productionFacilityCode": "OC4C00",
- "vintage": 2024,
- "productionStartDate": "2024-01-01T00:00:00.000Z",
- "productionEndDate": "2024-12-12T00:00:00.000Z",
- "creditType": "CORC100+",
- "issuanceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
- "issuanceDate": "2024-01-01T00:00:00.000Z"
}
]
}
limit | integer [ 1 .. 100 ] How many items to return at one time (max 100) |
offset | integer >= 0 How many items to skip |
{- "pagination": {
- "total": 1,
- "offset": 0,
- "limit": 100
}, - "data": [
- {
- "name": "Biochar",
- "code": "C03000000",
- "edition": "Edition 2022 V3",
}
]
}
limit | integer [ 1 .. 100 ] How many items to return at one time (max 100) |
offset | integer >= 0 How many items to skip |
{- "pagination": {
- "total": 1,
- "offset": 0,
- "limit": 100
}, - "data": [
- {
- "sequence": 0,
- "type": "string",
- "title": "string",
- "createdOn": "2019-08-24T14:15:22Z",
- "link": {
- "referenceType": "Issuance",
- "referenceId": "123e4567-e89b-12d3-a456-426614174000"
}
}
]
}
limit | integer [ 1 .. 100 ] How many items to return at one time (max 100) |
offset | integer >= 0 How many items to skip |
{- "pagination": {
- "total": 1,
- "offset": 0,
- "limit": 100
}, - "data": [
- {
- "id": "123e4567-e89b-12d3-a456-426614174000",
- "parentId": "3ka82f69-5717-4932-b3fc-2c963f88afa6",
- "name": "CCP-Approved",
- "createdOn": "2025-01-01T00:00:00.000Z"
}
]
}