WYRM platform API

For MEP, use the engineering workflow guides above and discuss the project integration during your pilot. The API reference below covers the existing WYRM business products, including procurement, tenders, security, contracts and data.

API reference OpenAPI spec

REST API

Standard REST endpoints with JSON responses. Fully documented OpenAPI specification.

API Key Auth

API key authentication with per-organisation scoping. Rate limits aligned to subscription tier.

Webhooks

Receive decision updates and basket re-scores via webhook POST to your endpoint. Signed payloads.

SDKs

Official Python and TypeScript SDKs. Community libraries for Go, Rust, and Java.

Preview

Example API responses

Representative responses from the Procure decision engine — the first module API to go live. Equivalent endpoints across Ledger (tender match, bid draft), Cyber (sweep, OSINT lookup), Legal (clause review, regulator digest), and Data (entity lookup, cross-module fusion) ship to the same versioned shape under /api/v1/{module}/.

POST/api/v1/jormungandr/decide

Submit a procurement requirement and receive a ranked decision across origins, suppliers, and total landed cost.

Response

{
  "decision_id": "dec_2026041500042",
  "intent": "source",
  "query": "15kg raw aluminium, UK buyer, CBAM exposure",
  "resolved": {
    "hs_code": "760110",
    "commodity": "Aluminium, unwrought, not alloyed",
    "quantity_kg": 15,
    "buyer_jurisdiction": "GB"
  },
  "ranking": [
    {
      "rank": 1,
      "origin": "CA",
      "confidence": 0.84,
      "landed_cost_gbp": 1178.42,
      "co2_grade": "A",
      "sanctions_status": "clear",
      "suppliers_verified": 3
    },
    {
      "rank": 2,
      "origin": "AE",
      "confidence": 0.72,
      "landed_cost_gbp": 1204.18,
      "co2_grade": "B",
      "sanctions_status": "clear",
      "suppliers_verified": 5
    },
    {
      "rank": 3,
      "origin": "RU",
      "confidence": 0.31,
      "landed_cost_gbp": 1042.77,
      "co2_grade": "C",
      "sanctions_status": "advisory",
      "compliance_note": "UK OFSI import restrictions — decision blocked for GB buyers"
    }
  ],
  "confidence_ensemble": 0.78,
  "audit_trail_uri": "/api/v1/decisions/dec_2026041500042/evidence"
}

GET/api/v1/suppliers/:id/history

Retrieve supplier verification history: registry filings, sanctions-status transitions, and prior-decision inclusions.

Response

{
  "supplier": {
    "id": "sup_opencorp_12038471",
    "legal_name": "Nordic Aluminium Refineries Ltd",
    "registry": "OpenCorporates",
    "registry_id": "ca/1038471",
    "jurisdiction": "CA-ON",
    "first_verified": "2025-11-02T09:14:00Z",
    "last_verified": "2026-04-14T06:00:00Z"
  },
  "history": [
    {
      "timestamp": "2026-04-14T06:00:00Z",
      "event": "ownership_confirmed",
      "source": "OpenCorporates diff",
      "parent_entity": "Nordic Metals Holdings PLC",
      "sanctions_status": "clear"
    },
    {
      "timestamp": "2026-03-01T00:00:00Z",
      "event": "capacity_recomputed",
      "annual_output_tonnes": 48000,
      "lead_time_days": 28
    }
  ]
}

POST/api/v1/baskets

Create a procurement basket. Procure monitors each item against sanctions, FX, commodity, and supplier changes and pushes re-scored decisions on material change.

Response

{
  "basket": {
    "id": "bkt_00123",
    "name": "Q3 2026 Aluminium Programme",
    "jurisdiction": "GB",
    "compliance_regimes": ["CBAM", "UK_OFSI", "EU_SANCTIONS"],
    "items": [
      { "hs_code": "760110", "quantity_kg": 15000, "target_origin": "CA" },
      { "hs_code": "760421", "quantity_kg": 8000, "target_origin": "AE" }
    ],
    "sort_preference": "landed_cost_then_co2",
    "alerts": {
      "channels": ["email", "webhook"],
      "triggers": ["sanctions_change", "co2_delta_gt_5pct", "fx_delta_gt_3pct"]
    },
    "created_at": "2026-04-15T10:00:00Z",
    "status": "active"
  }
}

Request API credentials

API access is available on Pro and Enterprise tiers. Register your organisational email to be contacted when credentials are issued for your cohort.