Skip to main content

Documents

Documents in the Registry API represent files associated with production facilities or issuances, such as audit reports and project documentation. These documents provide supporting evidence and additional information about the carbon removal activities.

Data schema​

A document object contains the following information:

  • sequence: An internal value used for ordering documents of the same type.
  • type: The type of document.
  • url: The URL where the document can be accessed.
  • title: The title of the document.
  • createdOn: The date and time when the document was created.
  • link: A reference to the associated entity (e.g., Issuance, ProductionFacility).

Document References and Types​

The link object in each document connects it to related entities through:

  • referenceType: Entity type (e.g., 'Issuance', 'ProductionFacility')
  • referenceId: Unique identifier of the entity

Common document types include:

  • ALL_DOCUMENTS: Uncategorized Production Facility documents

Listing Documents​

To retrieve a list of documents, you can use the /registry/documents endpoint with a GET request. This endpoint supports pagination parameters:

  • limit: The maximum number of items to return (default: 100, max: 100)
  • offset: The number of items to skip (default: 0)

Example Requests​

Basic example:​

List documents
curl -X 'GET' "/registry/documents" \
  -H "Accept: application/json" \
  -H "Authorization: Basic $BASIC"

Example with pagination:​

List documents
curl -X 'GET' "/registry/documents?limit=10&offset=0" \
  -H "Accept: application/json" \
  -H "Authorization: Basic $BASIC"

Response Structure​

The response includes a pagination object with information about the total number of items, the current offset, and the limit applied. The data array contains the list of document objects.

{
  "pagination": {
    "total": 50,
    "offset": 0,
    "limit": 10
  },
  "data": [
    {
      "sequence": 1,
      "type": "ALL_DOCUMENTS",
      "url": "https://.../report-123.pdf",
      "title": "Biochar Facility Audit Report 2024",
      "createdOn": "2024-01-15T10:30:00Z",
      "link": {
        "referenceType": "ProductionFacility",
        "referenceId": "P51023"
      }
    },
    {
      "sequence": 1,
      "type": "ISSUANCE",
      "url": "https://.../cert-456.pdf",
      "title": "Issuance Audit 2024-01",
      "createdOn": "2024-01-20T14:45:00Z",
      "link": {
        "referenceType": "Issuance",
        "referenceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      }
    }
    // Additional documents...
  ]
}

Next Steps​

Now that you understand how to retrieve information about documents, you can proceed to learn about Labels in the Registry API.