

<!DOCTYPE html>

<html lang="en-US">
<head>
  <meta charset="UTF-8">
  <meta http-equiv="X-UA-Compatible" content="IE=Edge">

  <script>
    if (localStorage.getItem('theme') === 'dark') {
      document.documentElement.classList.add('dark-mode');
    }
  </script>

  <link rel="stylesheet" href="/assets/css/just-the-docs-switchable.css">

  <link rel="stylesheet" href="/assets/css/just-the-docs-head-nav.css" id="jtd-head-nav-stylesheet">

  <style id="jtd-nav-activation">
  
    .site-nav ul li a {
      background-image: none;
    }

  </style>

  

  
    <script src="/assets/js/vendor/lunr.min.js"></script>
  

  <script src="/assets/js/just-the-docs.js"></script>
  <script src="/assets/js/theme-switch.js"></script>

  <meta name="viewport" content="width=device-width, initial-scale=1">

  

  <link rel="icon" href="/favicon.ico" type="image/x-icon">



  <!-- Begin Jekyll SEO tag v2.8.0 -->
<title>Pengine Docs | Official documentation for the PENGINE platform — API references, feature specs, service architecture, and team guides.</title>
<meta name="generator" content="Jekyll v4.4.1" />
<meta property="og:title" content="Pengine Docs" />
<meta property="og:locale" content="en_US" />
<meta name="description" content="Official documentation for the PENGINE platform — API references, feature specs, service architecture, and team guides." />
<meta property="og:description" content="Official documentation for the PENGINE platform — API references, feature specs, service architecture, and team guides." />
<link rel="canonical" href="https://urban-adventure-k5rg3k7.pages.github.io/assets/css/just-the-docs-head-nav.css" />
<meta property="og:url" content="https://urban-adventure-k5rg3k7.pages.github.io/assets/css/just-the-docs-head-nav.css" />
<meta property="og:site_name" content="Pengine Docs" />
<meta property="og:type" content="website" />
<meta name="twitter:card" content="summary" />
<meta property="twitter:title" content="Pengine Docs" />
<script type="application/ld+json">
{"@context":"https://schema.org","@type":"WebPage","description":"Official documentation for the PENGINE platform — API references, feature specs, service architecture, and team guides.","headline":"Pengine Docs","publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://urban-adventure-k5rg3k7.pages.github.io/assets/logo.png"}},"url":"https://urban-adventure-k5rg3k7.pages.github.io/assets/css/just-the-docs-head-nav.css"}</script>
<!-- End Jekyll SEO tag -->


  <!-- Inter — body and UI font -->
<link rel="preconnect" href="https://fonts.googleapis.com">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;700&display=swap" rel="stylesheet">

<!-- TOC sidebar scroll-spy -->
<script src="/assets/js/toc.js" defer></script>

<!-- Lucide icons — initialized after DOM is ready (defer scripts run before DOMContentLoaded) -->
<script src="https://unpkg.com/lucide@latest/dist/umd/lucide.min.js" defer></script>
<script>
  document.addEventListener('DOMContentLoaded', function () {
    if (window.lucide) lucide.createIcons();
  });
</script>


</head>

<body>
  <a class="skip-to-main" href="#main-content">Skip to main content</a>
  <svg xmlns="http://www.w3.org/2000/svg" class="d-none">
  <symbol id="svg-link" viewBox="0 0 24 24">
  <title>Link</title>
  <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-link">
    <path d="M10 13a5 5 0 0 0 7.54.54l3-3a5 5 0 0 0-7.07-7.07l-1.72 1.71"></path><path d="M14 11a5 5 0 0 0-7.54-.54l-3 3a5 5 0 0 0 7.07 7.07l1.71-1.71"></path>
  </svg>
</symbol>

  <symbol id="svg-menu" viewBox="0 0 24 24">
  <title>Menu</title>
  <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-menu">
    <line x1="3" y1="12" x2="21" y2="12"></line><line x1="3" y1="6" x2="21" y2="6"></line><line x1="3" y1="18" x2="21" y2="18"></line>
  </svg>
</symbol>

  <symbol id="svg-arrow-right" viewBox="0 0 24 24">
  <title>Expand</title>
  <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-chevron-right">
    <polyline points="9 18 15 12 9 6"></polyline>
  </svg>
</symbol>

  <!-- Feather. MIT License: https://github.com/feathericons/feather/blob/master/LICENSE -->
<symbol id="svg-external-link" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-external-link">
  <title id="svg-external-link-title">(external link)</title>
  <path d="M18 13v6a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2V8a2 2 0 0 1 2-2h6"></path><polyline points="15 3 21 3 21 9"></polyline><line x1="10" y1="14" x2="21" y2="3"></line>
</symbol>

  
    <symbol id="svg-doc" viewBox="0 0 24 24">
  <title>Document</title>
  <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-file">
    <path d="M13 2H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h12a2 2 0 0 0 2-2V9z"></path><polyline points="13 2 13 9 20 9"></polyline>
  </svg>
</symbol>

    <symbol id="svg-search" viewBox="0 0 24 24">
  <title>Search</title>
  <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-search">
    <circle cx="11" cy="11" r="8"></circle><line x1="21" y1="21" x2="16.65" y2="16.65"></line>
  </svg>
</symbol>

  
  
    <!-- Bootstrap Icons. MIT License: https://github.com/twbs/icons/blob/main/LICENSE.md -->
<symbol id="svg-copy" viewBox="0 0 16 16">
  <title>Copy</title>
  <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-clipboard" viewBox="0 0 16 16">
    <path d="M4 1.5H3a2 2 0 0 0-2 2V14a2 2 0 0 0 2 2h10a2 2 0 0 0 2-2V3.5a2 2 0 0 0-2-2h-1v1h1a1 1 0 0 1 1 1V14a1 1 0 0 1-1 1H3a1 1 0 0 1-1-1V3.5a1 1 0 0 1 1-1h1v-1z"/>
    <path d="M9.5 1a.5.5 0 0 1 .5.5v1a.5.5 0 0 1-.5.5h-3a.5.5 0 0 1-.5-.5v-1a.5.5 0 0 1 .5-.5h3zm-3-1A1.5 1.5 0 0 0 5 1.5v1A1.5 1.5 0 0 0 6.5 4h3A1.5 1.5 0 0 0 11 2.5v-1A1.5 1.5 0 0 0 9.5 0h-3z"/>
  </svg>
</symbol>
<symbol id="svg-copied" viewBox="0 0 16 16">
  <title>Copied</title>
  <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-clipboard-check-fill" viewBox="0 0 16 16">
    <path d="M6.5 0A1.5 1.5 0 0 0 5 1.5v1A1.5 1.5 0 0 0 6.5 4h3A1.5 1.5 0 0 0 11 2.5v-1A1.5 1.5 0 0 0 9.5 0h-3Zm3 1a.5.5 0 0 1 .5.5v1a.5.5 0 0 1-.5.5h-3a.5.5 0 0 1-.5-.5v-1a.5.5 0 0 1 .5-.5h3Z"/>
    <path d="M4 1.5H3a2 2 0 0 0-2 2V14a2 2 0 0 0 2 2h10a2 2 0 0 0 2-2V3.5a2 2 0 0 0-2-2h-1v1A2.5 2.5 0 0 1 9.5 5h-3A2.5 2.5 0 0 1 4 2.5v-1Zm6.854 7.354-3 3a.5.5 0 0 1-.708 0l-1.5-1.5a.5.5 0 0 1 .708-.708L7.5 10.793l2.646-2.647a.5.5 0 0 1 .708.708Z"/>
  </svg>
</symbol>

  
</svg>

  
    <header class="side-bar">
  <div class="site-header">
    <a href="/" class="site-title lh-tight"><div class="site-logo" role="img" aria-label="Pengine"></div><span class="site-title-text">Pengine Documentation</span>
</a>
    <button id="menu-button" class="site-button btn-reset" aria-label="Menu" aria-expanded="false">
      <svg viewBox="0 0 24 24" class="icon" aria-hidden="true"><use xlink:href="#svg-menu"></use></svg>
    </button>
  </div>

  <nav aria-label="Main" id="site-nav" class="site-nav">
  
  
    <ul class="nav-list"><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="Epics submenu" aria-expanded="false">
        <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg>
      </button><a href="/Epics/" class="nav-list-link"><span class="nav-icon" aria-hidden="true"><i data-lucide="sparkles"></i> </span>Epics</a><ul class="nav-list"><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="Investment Obligations submenu" aria-expanded="false">
        <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg>
      </button><a href="/Epics/Investment%20Obligations/" class="nav-list-link">Investment Obligations</a><ul class="nav-list"><li class="nav-list-item"><a href="/Epics/Investment%20Obligations/brd.html" class="nav-list-link">Business Requirements</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="OOP submenu" aria-expanded="false">
        <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg>
      </button><a href="/Epics/OOP/" class="nav-list-link">OOP</a><ul class="nav-list"><li class="nav-list-item"><a href="/Epics/OOP/Collective%20Switch/" class="nav-list-link">Collective Switch</a></li></ul></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="APIs submenu" aria-expanded="false">
        <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg>
      </button><a href="/API/" class="nav-list-link"><span class="nav-icon" aria-hidden="true"><i data-lucide="code-2"></i> </span>APIs</a><ul class="nav-list"><li class="nav-list-item"><a href="/API/BFF/" class="nav-list-link">BFF</a></li><li class="nav-list-item"><a href="/API/IdentityServer%20API/" class="nav-list-link">IdentityServer API</a></li></ul></li><li class="nav-list-item"><a href="/Releases/" class="nav-list-link"><span class="nav-icon" aria-hidden="true"><i data-lucide="tag"></i> </span>Changelog</a></li></ul>
  
</nav>


<div class="d-md-block d-none site-footer">
  
  
    <script>
(function () {
  var items = document.querySelectorAll(".nav-list > .nav-list-item");
  var inside = false;
  items.forEach(function (li) {
    var link = li.querySelector(":scope > .nav-list-link");
    var href = link ? link.getAttribute("href") || "" : "";
    if (href === "/API/") {
      inside = true;
    } else if (inside && href && !href.startsWith("/API/")) {
      inside = false;
    }
    if (inside) li.setAttribute("data-nav-visible", "");
  });
})();
</script>

  
  </div>
</header>

  
  <div class="main" id="top">
    <div id="main-header" class="main-header">
  
    

<div class="search" role="search">
  <div class="search-input-wrap">
    <input type="text" id="search-input" class="search-input" tabindex="0" placeholder="Search Pengine | Docs" autocomplete="off">
    <label for="search-input" class="search-label">
      <span class="sr-only">Search Pengine | Docs</span>
      <svg viewBox="0 0 24 24" class="search-icon" aria-hidden="true"><use xlink:href="#svg-search"></use></svg>
    </label>
  </div>
  <div id="search-results" class="search-results"></div>
</div>

  
  <button id="theme-toggle" aria-label="Switch to dark theme">
  <i data-lucide="moon" aria-hidden="true"></i>
</button>

  
</div>

    <div class="main-content-wrap">
      
      <div class="page-wrap">
        <div id="main-content" class="main-content">
          <main>
            
              <h.site-nav ul li a {
  background-image: linear-gradient(-90deg, rgb(247.35, 247.35, 247.35) 0%, rgba(247.35, 247.35, 247.35, 0.8) 80%, rgba(247.35, 247.35, 247.35, 0) 100%);
}

            

            
              
            
          </main>
          
<hr>
<footer>
  
    <p><a href="#top" id="back-to-top">Back to top</a></p>
  

  <p class="text-small mb-0">&copy; 2026 <a href="https://urban-adventure-k5rg3k7.pages.github.io">Pengine</a>.</p>

  <div class="d-md-none mt-4 fs-2">
    
    
      <script>
(function () {
  var items = document.querySelectorAll(".nav-list > .nav-list-item");
  var inside = false;
  items.forEach(function (li) {
    var link = li.querySelector(":scope > .nav-list-link");
    var href = link ? link.getAttribute("href") || "" : "";
    if (href === "/API/") {
      inside = true;
    } else if (inside && href && !href.startsWith("/API/")) {
      inside = false;
    }
    if (inside) li.setAttribute("data-nav-visible", "");
  });
})();
</script>

    
  </div>
</footer>

        </div>
        <aside id="toc-sidebar" class="toc-sidebar" aria-label="Table of contents">
          <div class="toc-nav">
            <span class="toc-label">On this page</span>
            <ul id="toc-list" class="toc-list"></ul>
          </div>
        </aside>
      </div>
    </div>
    
      

<div class="search-overlay"></div>

    
  </div>

  
    





<script type="module">
  
  import mermaid from 'https://cdn.jsdelivr.net/npm/mermaid@10/dist/mermaid.esm.min.mjs';
  

  var config = {}
;
  mermaid.initialize(config);
  mermaid.run({
    querySelector: '.language-mermaid',
  });
</script>



  
</body>
</html>

