MethodologiesBOLD Recycling CreditBOLD Recycling Credit - MvFApplication
BOLD Recycling — MassID Event Reference
Canonical per-event JSON payloads for BOLD Recycling integrations.
Last updated on
Methodology version 1.0.1
Last synced: 2026-04-14
Reference MassID: View on Carrot Registry
How to read this page
Each event below shows the canonical JSON payload integrators send to the Documents API.
The isPublic flags inside each example are Carrot's recommended visibility — see
Privacy & Masking for the model.
Each payload references its participant and address by participantId and addressId. Resolve each one
first — retrieve it by key or create it — via the Participants API;
sending full participant and address objects inline is deprecated.
Per-event attribute dictionaries (definitions, types, sensitive flags, conditional rules) are the planned next addition to this page.
Create MassID document
The initial POST /documents call that creates a MassID. Not an event on the document's
timeline — included here as the starting point for integrator flows. The
Waste Generator is the creator; events are added to this
document afterward.
{ "addressId": "00000000-0000-4000-9000-00000000000a", "category": "MassID", "externalCreatedAt": "2024-12-05T11:02:47Z", "isPublic": true, "isPubliclySearchable": true, "participantId": "00000000-0000-4000-8000-00000000000a", "subtype": "Food, Food Waste and Beverages", "title": "MassID", "type": "Organic"}ACTOR — Waste Generator
{ "externalCreatedAt": "2024-12-05T11:02:47Z", "isPublic": false, "addressId": "00000000-0000-4000-9000-00000000000a", "label": "Waste Generator", "name": "ACTOR", "participantId": "00000000-0000-4000-8000-00000000000a"}ACTOR — Recycler
{ "externalCreatedAt": "2024-12-05T11:02:47Z", "isPublic": true, "addressId": "00000000-0000-4000-9000-00000000000d", "label": "Recycler", "name": "ACTOR", "participantId": "00000000-0000-4000-8000-00000000000d"}ACTOR — Processor
{ "externalCreatedAt": "2024-12-05T11:02:47Z", "isPublic": true, "addressId": "00000000-0000-4000-9000-00000000000c", "label": "Processor", "name": "ACTOR", "participantId": "00000000-0000-4000-8000-00000000000c"}ACTOR — Hauler
{ "externalCreatedAt": "2024-12-05T11:02:47Z", "isPublic": false, "addressId": "00000000-0000-4000-9000-00000000000b", "label": "Hauler", "name": "ACTOR", "participantId": "00000000-0000-4000-8000-00000000000b"}ACTOR — Integrator
{ "externalCreatedAt": "2024-12-05T11:02:47Z", "isPublic": true, "addressId": "00000000-0000-4000-9000-00000000000e", "label": "Integrator", "name": "ACTOR", "participantId": "00000000-0000-4000-8000-00000000000e"}Pick-up
{ "externalCreatedAt": "2024-12-05T11:02:47Z", "isPublic": false, "addressId": "00000000-0000-4000-9000-00000000000a", "name": "Pick-up", "participantId": "00000000-0000-4000-8000-00000000000a", "metadata": { "attributes": [ { "isPublic": true, "name": "Description", "value": "Waste picked up by hauler Acme Example Hauler at Acme Example Waste Generator" }, { "isPublic": true, "name": "Local Waste Classification ID", "value": "04 02 20" }, { "isPublic": true, "name": "Local Waste Classification Description", "value": "Lodos do tratamento local de efluentes não abrangidas em 04 02 19" }, { "sensitive": true, "isPublic": false, "name": "Vehicle License Plate", "value": "ABC1D23" }, { "isPublic": true, "name": "Vehicle Type", "value": "Truck" }, { "isPublic": false, "name": "Driver Identifier", "value": "00000000-0000-4000-8000-00000000d21f" } ] }}Transport Manifest
{ "externalCreatedAt": "2024-12-05T11:02:47Z", "isPublic": true, "addressId": "00000000-0000-4000-9000-00000000000a", "name": "Transport Manifest", "participantId": "00000000-0000-4000-8000-00000000000a", "value": 1201.925, "metadata": { "attributes": [ { "isPublic": true, "name": "Document Type", "value": "MTR" }, { "isPublic": true, "name": "Document Number", "value": "DOC-EXAMPLE-0001" }, { "format": "DATE", "isPublic": true, "name": "Issue Date", "value": "2024-02-10" } ] }, "attachments": [ { "fileName": "transport-manifest.pdf", "isPublic": false, "label": "Transport Manifest" } ]}Weighing
{ "externalCreatedAt": "2024-12-05T11:02:47Z", "isPublic": true, "addressId": "00000000-0000-4000-9000-00000000000a", "name": "Weighing", "participantId": "00000000-0000-4000-8000-00000000000a", "value": 1201.925, "metadata": { "attributes": [ { "isPublic": true, "name": "Description", "value": "Weighing captured at waste generator site" }, { "isPublic": true, "name": "Weigh Capture Method", "value": "Average Weight by Volume" }, { "isPublic": true, "name": "Scale Type", "value": "Floor Scale" }, { "isPublic": true, "name": "Container Type", "value": "Drum" }, { "isPublic": true, "name": "Container Quantity", "value": 1 }, { "format": "KILOGRAM", "isPublic": true, "name": "Container Capacity", "value": 100 }, { "format": "KILOGRAM", "isPublic": true, "name": "Gross Weight", "value": 1211.925 }, { "format": "KILOGRAM", "isPublic": true, "name": "Tare", "value": 10 } ] }}Drop-off
{ "externalCreatedAt": "2024-12-05T11:02:47Z", "isPublic": true, "addressId": "00000000-0000-4000-9000-00000000000d", "name": "Drop-off", "participantId": "00000000-0000-4000-8000-00000000000d", "metadata": { "attributes": [ { "isPublic": true, "name": "Description", "value": "Waste deposited in Windrow number 1" }, { "isPublic": true, "name": "Receiving Operator Identifier", "value": "00000000-0000-4000-8000-00000000000c" } ] }}Sorting
{ "externalCreatedAt": "2024-12-05T11:02:47Z", "isPublic": true, "addressId": "00000000-0000-4000-9000-00000000000c", "name": "Sorting", "participantId": "00000000-0000-4000-8000-00000000000c", "value": 1189.906, "metadata": { "attributes": [ { "isPublic": true, "name": "Description", "value": "Sorting factor determined by a third-party audit" }, { "format": "KILOGRAM", "isPublic": true, "name": "Gross Weight", "value": 1201.925 }, { "format": "KILOGRAM", "isPublic": true, "name": "Deducted Weight", "value": 12.019 } ] }}Recycled
{ "externalCreatedAt": "2025-02-22T10:35:12.000Z", "isPublic": true, "addressId": "00000000-0000-4000-9000-00000000000d", "name": "Recycled", "participantId": "00000000-0000-4000-8000-00000000000d", "metadata": { "attributes": [ { "isPublic": true, "name": "Description", "value": "Composting process completed. The recycling completion date is recorded by a conservative estimate determined and verified by a third-party audit for the recycler" } ] }}Recycling Manifest
{ "externalCreatedAt": "2024-12-05T11:02:47Z", "isPublic": true, "addressId": "00000000-0000-4000-9000-00000000000d", "name": "Recycling Manifest", "participantId": "00000000-0000-4000-8000-00000000000d", "value": 1201.925, "metadata": { "attributes": [ { "isPublic": true, "name": "Document Type", "value": "CDF" }, { "isPublic": true, "name": "Document Number", "value": "DOC-EXAMPLE-0002" }, { "format": "DATE", "isPublic": true, "name": "Issue Date", "value": "2024-03-10" } ] }, "attachments": [ { "fileName": "recycling-manifest.pdf", "isPublic": false, "label": "Recycling Manifest" } ]}