Applying Frameworks
What is a Framework?
A Framework is a structured list of requirements a project must meet to demonstrate compliance with Puro.earth Methodologies. Frameworks define what evidence and documentation must be submitted for a monitoring period.
Types of Frameworks
There are several types of frameworks you can apply to a monitoring period:
- Preliminary Assessment - Initial assessment before Facility Audit
- Facility Audit - Requirements for auditing the facility itself
- Output Audit - Requirements for auditing the output/production
Always use the latest version of each framework unless told otherwise by your account manager.
Listing Available Frameworks
To view all available frameworks, use the GET /v0/frameworks endpoint:
curl -X 'GET' "/v0/frameworks" \
-H "Accept: application/json" \
-H "Authorization: Bearer $BEARER"
Response Schema
Getting Framework Details
To get details about a specific framework:
curl -X 'GET' "/v0/frameworks/{id}" \
-H "Accept: application/json" \
-H "Authorization: Bearer $BEARER"
Framework Instances
Applying a Framework to a Monitoring Period
To apply a framework to a monitoring period, you create a Framework Instance. Use the POST /v0/monitoring-periods/{id}/framework-instances endpoint:
curl -X 'POST' "/v0/monitoring-periods/{id}/framework-instances" \
-H "Accept: application/json" \
-H "Authorization: Bearer $BEARER" \
-d '{ \
"frameworkId": "framework-uuid-here" \
}'
Which Frameworks to Apply
Choose frameworks based on your audit type:
| Audit Type | Frameworks to Apply |
|---|---|
| Facility audit only | Facility Audit framework |
| Output audit only | Output Audit framework |
| Combined Facility and Output Audit | Apply both Facility & Output Audit Frameworks |
| Preliminary assessment | Preliminary Assessment framework |
Listing Framework Instances
To see which Frameworks have been applied to a monitoring period through Framework Instances, use GET /v0/framework-instances:
curl -X 'GET' "/v0/framework-instances" \
-H "Accept: application/json" \
-H "Authorization: Bearer $BEARER"
You can also get details about a specific framework instance:
curl -X 'GET' "/v0/framework-instances/{id}" \
-H "Accept: application/json" \
-H "Authorization: Bearer $BEARER"
Removing a Framework
If you need to remove a framework from a monitoring period, use DELETE /v0/framework-instances/{id}:
curl -X 'DELETE' "/v0/framework-instances/{id}" \
-H "Accept: application/json" \
-H "Authorization: Bearer $BEARER"
Deleting a framework instance will remove all associated requirements and evidence submissions. Only delete if you're certain you don't need this framework.
On Preliminary Assessment and Facility Audit
Preliminary Assessments share the same Documents with Facility Audits. Documents are mapped between the Preliminary Assessment and the Facility Audit, so completing it for the Preliminary Assessment automatically applies it to the Facility Audit if they are in the same Monitoring Period.
Always ensure you submit the correct Framework type in your Audit Package, even though documents may be shared between Preliminary Assessment and Facility Audit.
Next Steps
Once you've applied the appropriate frameworks, you'll need to set up models (like LCA & CORC Report) to perform calculations on the data you'll collect.