Jira progress: loading…

API-RE

Core Resources & Endpoints

Tenants & Clients

• POST /v1/tenants
• GET /v1/tenants/{tenant_id}
• POST /v1/tenants/{tenant_id}/clients
• GET /v1/tenants/{tenant_id}/clients/{client_id}

Docs content:

• Object schema: IDs, names, region, industry/NACE, size.
• Permission notes (who can create/manage these).

Forms & Form Templates (FOGE)

• GET /v1/forms/templates — list templates (e.g. “ESRS E1”, “Supply Chain Scope 3”).
• GET /v1/forms/templates/{template_id} — schema & metadata.
• POST /v1/forms — instantiate a form for a client (FOGE-driven).
• GET /v1/forms/{form_id} — structure + status.

Docs content:

• Relationship between template, instance, and submission.
• Fields: types, units, AI guidance, NACE relevance.

Submissions & Data Input

• POST /v1/forms/{form_id}/submissions
• GET /v1/submissions/{submission_id}
• PATCH /v1/submissions/{submission_id} (partial updates)
• File upload endpoints if needed (/attachments).

Docs content:

• How to send structured data.
• How to handle multi-period submissions.
• Idempotency keys.

Validation & Trust (DaVE / VTE)

• POST /v1/submissions/{submission_id}/validate
• GET /v1/submissions/{submission_id}/validation
• GET /v1/submissions/{submission_id}/trust-summary

Docs content:

• DaVE score, completeness, consistency metrics.
• VTE: provenance, source types, evidence.
• Trust thresholds and how to configure them (e.g. in /trust-policies).

Metrics & KPIs

• GET /v1/clients/{client_id}/metrics
  • Filters: period, framework segment, NACE, topic (E/S/G).
• GET /v1/clients/{client_id}/metrics/{metric_code}
• GET /v1/kpis/{kpi_code}

Docs content:

• Metric identifiers (ESRS codes, internal codes).
• Units, scopes (Scope 1/2/3), formula references.
• How recalculation works when new data arrives.

Carbon Passport & E-C-O Number

• GET /v1/eco-numbers/{eco_number}
• GET /v1/carbon-passports/{cpi_id}
• POST /v1/carbon-passports/verify (for customs/border systems).

Docs content:

• Structure of eco_number and cpi_id.
• What tiers (1/2/3) mean.
• How CPI verification and expiry works.

Telemetry & IoT Integration (Z-Edge / Matter)

• POST /v1/devices/register
• GET /v1/devices/{device_id}
• POST /v1/devices/{device_id}/telemetry e.g. energy, flows, other signals.
• GET /v1/devices/{device_id}/metrics

Docs content:

• Linking devices to facilities and E-C-O Numbers.
• Recommended payload schema.
• Security & token model for devices.

Verifier & Workflow APIs

• POST /v1/verifiers — register a verifier profile.
• GET /v1/verifiers/{verifier_id}
• POST /v1/verification-requests — supplier → verifier.
• GET /v1/verification-requests/{request_id}
• POST /v1/verification-requests/{request_id}/decision

Docs content:

• inking outputs to Z-Verified trust level.
• Attaching verification results to submissions / metrics.