{
  "info": {
    "name": "regulation-control",
    "description": "Detect regulatory changes and map them to obligations, policies, controls, products and evidence requirements.\n\n## Getting started\n\n1. Run **Create a free sandbox API key** — it needs no auth.\n2. Copy the returned `apiKey` into the collection's `apiKey` variable.\n3. Every authenticated request then works as-is.\n\nGenerated from the deployed OpenAPI contract — it cannot drift from the live API.",
    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
  },
  "auth": {
    "type": "bearer",
    "bearer": [
      {
        "key": "token",
        "value": "{{apiKey}}",
        "type": "string"
      }
    ]
  },
  "variable": [
    {
      "key": "baseUrl",
      "value": "https://controlgraph-api.com",
      "type": "string"
    },
    {
      "key": "apiKey",
      "value": "",
      "type": "string",
      "description": "Paste the key returned by POST /v1/keys."
    }
  ],
  "item": [
    {
      "name": "Liveness and deployed version",
      "request": {
        "method": "GET",
        "header": [],
        "url": {
          "raw": "{{baseUrl}}/health",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "health"
          ]
        }
      }
    },
    {
      "name": "Service index — endpoints, auth and error format",
      "request": {
        "method": "GET",
        "header": [],
        "url": {
          "raw": "{{baseUrl}}/",
          "host": [
            "{{baseUrl}}"
          ],
          "path": []
        }
      }
    },
    {
      "name": "Map regulatory changes onto your obligations, controls, evidence and deadlines",
      "request": {
        "method": "POST",
        "header": [
          {
            "key": "content-type",
            "value": "application/json"
          },
          {
            "key": "authorization",
            "value": "Bearer {{apiKey}}"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/v1/changes",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v1",
            "changes"
          ]
        },
        "description": "Takes a regulatory change you have already read — citation, dates, and the obligations it creates — plus your own control inventory, and returns the impact graph: which controls each obligation touches, which obligations have no control at all, what evidence is now required, and the dated deadlines. Coverage is deny-by-default: an obligation with no matching control is a GAP, never assumed covered. Matching is a stated set rule over tags, not a similarity score, and every graph edge carries the reason it exists. Send one \"change\" or up to 50 in \"changes\"; the \"controls\" inventory is shared across the batch. Billed one unit per change mapped. Nothing is stored. This is arithmetic and graph mapping over inputs you supply. It does not read, interpret or apply law, and it is not legal advice.",
        "body": {
          "mode": "raw",
          "raw": "{\n  \"controls\": [\n    {\n      \"controlId\": \"CTL-014\",\n      \"name\": \"Consumer disclosure template review\",\n      \"owner\": \"Payments Compliance\",\n      \"status\": \"implemented\",\n      \"tags\": [\n        \"payments\",\n        \"disclosure\",\n        \"us\"\n      ],\n      \"lastTestedAt\": \"2026-07-01\",\n      \"testFrequencyDays\": 180,\n      \"evidence\": [\n        {\n          \"kind\": \"policy_document\",\n          \"artifactId\": \"POL-221\",\n          \"collectedAt\": \"2026-07-02\"\n        },\n        {\n          \"kind\": \"notification_record\",\n          \"artifactId\": \"NR-9930\",\n          \"collectedAt\": \"2026-07-14\"\n        }\n      ]\n    },\n    {\n      \"controlId\": \"CTL-027\",\n      \"name\": \"Fee change customer notification job\",\n      \"owner\": \"Payments Engineering\",\n      \"status\": \"planned\",\n      \"tags\": [\n        \"payments\",\n        \"notification\",\n        \"us\"\n      ],\n      \"testFrequencyDays\": 90\n    },\n    {\n      \"controlId\": \"CTL-101\",\n      \"name\": \"Account record retention schedule\",\n      \"owner\": \"Records Management\",\n      \"status\": \"implemented\",\n      \"tags\": [\n        \"recordkeeping\",\n        \"us\"\n      ],\n      \"lastTestedAt\": \"2024-02-01\",\n      \"evidence\": [\n        {\n          \"kind\": \"retention_schedule\",\n          \"artifactId\": \"RS-04\",\n          \"collectedAt\": \"2024-02-01\"\n        }\n      ]\n    }\n  ],\n  \"change\": {\n    \"changeId\": \"REG-2026-0117\",\n    \"citation\": \"12 CFR 1026.19(e)\",\n    \"title\": \"Revised timing and content of cost-of-credit disclosures\",\n    \"jurisdiction\": \"US\",\n    \"regulator\": \"CFPB\",\n    \"changeType\": \"amendment\",\n    \"publishedAt\": \"2026-03-02\",\n    \"effectiveAt\": \"2026-09-01\",\n    \"transitionEndsAt\": \"2026-12-01\",\n    \"currency\": \"USD\",\n    \"obligations\": [\n      {\n        \"obligationId\": \"OB-1\",\n        \"type\": \"disclosure\",\n        \"text\": \"Provide the revised cost-of-credit disclosure within three business days of application.\",\n        \"appliesTo\": [\n          \"payments\",\n          \"disclosure\"\n        ],\n        \"enforcement\": \"penalty\",\n        \"maxPenaltyMinor\": 500000000\n      },\n      {\n        \"obligationId\": \"OB-2\",\n        \"type\": \"notification\",\n        \"text\": \"Notify existing customers of the fee schedule change at least 45 days before it applies.\",\n        \"appliesTo\": [\n          \"payments\",\n          \"notification\"\n        ],\n        \"enforcement\": \"penalty\",\n        \"maxPenaltyMinor\": 250000000\n      },\n      {\n        \"obligationId\": \"OB-3\",\n        \"type\": \"recordkeeping\",\n        \"text\": \"Retain each issued disclosure for five years and produce it on request.\",\n        \"appliesTo\": [\n          \"recordkeeping\",\n          \"disclosure\"\n        ],\n        \"enforcement\": \"supervisory\"\n      }\n    ]\n  }\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        }
      }
    },
    {
      "name": "Public demo — map one change with no API key",
      "request": {
        "method": "POST",
        "header": [
          {
            "key": "content-type",
            "value": "application/json"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/v1/demo/map",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v1",
            "demo",
            "map"
          ]
        },
        "description": "The real engine, capped at one change, 5 obligations and 20 controls. Nothing is stored, nothing is metered, no key is required. This is arithmetic and graph mapping over inputs you supply. It does not read, interpret or apply law, and it is not legal advice.",
        "body": {
          "mode": "raw",
          "raw": "{\n  \"controls\": [\n    {\n      \"controlId\": \"CTL-014\",\n      \"name\": \"Consumer disclosure template review\",\n      \"owner\": \"Payments Compliance\",\n      \"status\": \"implemented\",\n      \"tags\": [\n        \"payments\",\n        \"disclosure\",\n        \"us\"\n      ],\n      \"lastTestedAt\": \"2026-07-01\",\n      \"testFrequencyDays\": 180,\n      \"evidence\": [\n        {\n          \"kind\": \"policy_document\",\n          \"artifactId\": \"POL-221\",\n          \"collectedAt\": \"2026-07-02\"\n        },\n        {\n          \"kind\": \"notification_record\",\n          \"artifactId\": \"NR-9930\",\n          \"collectedAt\": \"2026-07-14\"\n        }\n      ]\n    },\n    {\n      \"controlId\": \"CTL-027\",\n      \"name\": \"Fee change customer notification job\",\n      \"owner\": \"Payments Engineering\",\n      \"status\": \"planned\",\n      \"tags\": [\n        \"payments\",\n        \"notification\",\n        \"us\"\n      ],\n      \"testFrequencyDays\": 90\n    },\n    {\n      \"controlId\": \"CTL-101\",\n      \"name\": \"Account record retention schedule\",\n      \"owner\": \"Records Management\",\n      \"status\": \"implemented\",\n      \"tags\": [\n        \"recordkeeping\",\n        \"us\"\n      ],\n      \"lastTestedAt\": \"2024-02-01\",\n      \"evidence\": [\n        {\n          \"kind\": \"retention_schedule\",\n          \"artifactId\": \"RS-04\",\n          \"collectedAt\": \"2024-02-01\"\n        }\n      ]\n    }\n  ],\n  \"change\": {\n    \"changeId\": \"REG-2026-0117\",\n    \"citation\": \"12 CFR 1026.19(e)\",\n    \"title\": \"Revised timing and content of cost-of-credit disclosures\",\n    \"jurisdiction\": \"US\",\n    \"regulator\": \"CFPB\",\n    \"changeType\": \"amendment\",\n    \"publishedAt\": \"2026-03-02\",\n    \"effectiveAt\": \"2026-09-01\",\n    \"transitionEndsAt\": \"2026-12-01\",\n    \"currency\": \"USD\",\n    \"obligations\": [\n      {\n        \"obligationId\": \"OB-1\",\n        \"type\": \"disclosure\",\n        \"text\": \"Provide the revised cost-of-credit disclosure within three business days of application.\",\n        \"appliesTo\": [\n          \"payments\",\n          \"disclosure\"\n        ],\n        \"enforcement\": \"penalty\",\n        \"maxPenaltyMinor\": 500000000\n      },\n      {\n        \"obligationId\": \"OB-2\",\n        \"type\": \"notification\",\n        \"text\": \"Notify existing customers of the fee schedule change at least 45 days before it applies.\",\n        \"appliesTo\": [\n          \"payments\",\n          \"notification\"\n        ],\n        \"enforcement\": \"penalty\",\n        \"maxPenaltyMinor\": 250000000\n      },\n      {\n        \"obligationId\": \"OB-3\",\n        \"type\": \"recordkeeping\",\n        \"text\": \"Retain each issued disclosure for five years and produce it on request.\",\n        \"appliesTo\": [\n          \"recordkeeping\",\n          \"disclosure\"\n        ],\n        \"enforcement\": \"supervisory\"\n      }\n    ]\n  }\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        }
      }
    },
    {
      "name": "The code catalogue: obligation types, evidence kinds, findings and the priority weights",
      "request": {
        "method": "GET",
        "header": [],
        "url": {
          "raw": "{{baseUrl}}/v1/obligation-types",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v1",
            "obligation-types"
          ]
        },
        "description": "Every enum the engine emits, with its meaning, plus the exact constants used to derive a priority score. Branch on these codes rather than on the human-readable prose, which may change. The weights are published here because a score you cannot recompute on paper is a score you cannot defend in an audit — and the engine reads these same numbers."
      }
    },
    {
      "name": "Start a hosted Square checkout for a paid tier",
      "request": {
        "method": "POST",
        "header": [
          {
            "key": "content-type",
            "value": "application/json"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/v1/checkout",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v1",
            "checkout"
          ]
        },
        "description": "Returns a Square-hosted payment URL for the requested tier. No API key is needed — a prospect has not got one yet. The email Square collects becomes the account, so a key issued later for the same address inherits the paid quota. Enterprise returns a contact route rather than a payment link.",
        "body": {
          "mode": "raw",
          "raw": "{\n  \"tier\": \"developer\"\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        }
      }
    },
    {
      "name": "Square billing events, forwarded by the shared hub",
      "request": {
        "method": "POST",
        "header": [],
        "url": {
          "raw": "{{baseUrl}}/api/billing/webhook",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "billing",
            "webhook"
          ]
        },
        "description": "Machine-to-machine only. The shared Square billing hub POSTs signed events here; the signature is verified over the exact request bytes. Not callable by API consumers — documented so the integration is auditable."
      }
    },
    {
      "name": "Request a free sandbox API key (sends a verification email)",
      "request": {
        "method": "POST",
        "header": [
          {
            "key": "content-type",
            "value": "application/json"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/v1/keys",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v1",
            "keys"
          ]
        },
        "description": "Starts self-serve key issuance. A one-time claim token is emailed to the address you supply; POST it to /v1/keys/claim to receive the key. No key is returned here, and the response is the same whether or not that address already has an account — so this endpoint cannot be used to find out who has one. The email is verified because your account, your usage and your invoice are all keyed to it: issuing on an unverified address would let anyone mint a working key on your account and spend your allowance. Keep using the same address and a paid plan bought with it raises the keys you already hold rather than issuing new ones.",
        "body": {
          "mode": "raw",
          "raw": "{\n  \"email\": \"you@example.com\",\n  \"name\": \"staging\"\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        }
      }
    },
    {
      "name": "List your API keys for this API",
      "request": {
        "method": "GET",
        "header": [
          {
            "key": "authorization",
            "value": "Bearer {{apiKey}}"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/v1/keys",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v1",
            "keys"
          ]
        },
        "description": "Every key on YOUR account for this API — label, non-secret prefix, status, when it was created, when it was last used, and what it has consumed this period. Authenticate with any active key on the account; the account is taken from that key, never from a parameter, so this can only ever return your own keys. Keys you hold for other APIs in the portfolio are not listed here. Secrets are not returned and cannot be: only a peppered hash is stored. Free, and consumes no quota."
      }
    },
    {
      "name": "Exchange an emailed claim token for the API key",
      "request": {
        "method": "POST",
        "header": [
          {
            "key": "content-type",
            "value": "application/json"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/v1/keys/claim",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v1",
            "keys",
            "claim"
          ]
        },
        "description": "Spends the token emailed by POST /v1/keys and returns the key. The key is shown ONCE — only a peppered hash is stored, so it can never be read back; if you lose it, rotate. The key works only on this API, and the allowance it is issued with reflects your account: your paid plan when you have one, the free sandbox allowance when you do not.",
        "body": {
          "mode": "raw",
          "raw": "{\n  \"token\": \"eyJ2IjoxLCJlIjoieW91QGV4YW1wbGUuY29tIn0.ZXhhbXBsZQ\"\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        }
      }
    },
    {
      "name": "Revoke one of your API keys",
      "request": {
        "method": "POST",
        "header": [
          {
            "key": "authorization",
            "value": "Bearer {{apiKey}}"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/v1/keys/{id}/revoke",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v1",
            "keys",
            "{id}",
            "revoke"
          ]
        },
        "description": "Kills a key immediately: the very next request made with it is refused with 401 invalid_api_key. There is no propagation delay and no cache to wait out. You may revoke the key you are authenticating with — that is the correct move when it has leaked, though you will then need another key, or the email flow, to get back in; rotate does both in one call. A key belonging to another account, or to another API, answers 404 exactly as an unknown id does, so this cannot be used to probe for keys you do not own. Idempotent, and free."
      }
    },
    {
      "name": "Replace one of your API keys with a new secret",
      "request": {
        "method": "POST",
        "header": [
          {
            "key": "content-type",
            "value": "application/json"
          },
          {
            "key": "authorization",
            "value": "Bearer {{apiKey}}"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/v1/keys/{id}/rotate",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v1",
            "keys",
            "{id}",
            "rotate"
          ]
        },
        "description": "Issues a replacement key and revokes the old one. This is the answer to a leaked or lost key: the new secret is returned once, the old secret stops working immediately, and the label carries over unless you supply a new one. The replacement is issued at your account's current allowance — your paid plan if you have one — not at the old key's. Rotating does not count against the active-key limit, because it replaces rather than adds. Free, and it works while you are out of quota.",
        "body": {
          "mode": "raw",
          "raw": "{\n  \"name\": \"production (rotated)\"\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        }
      }
    },
    {
      "name": "Your consumption and remaining allowance for this period",
      "request": {
        "method": "GET",
        "header": [
          {
            "key": "authorization",
            "value": "Bearer {{apiKey}}"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/v1/usage",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v1",
            "usage"
          ]
        },
        "description": "Reports what this API key has consumed in the current quota period, the ceiling being enforced against it, and when that ceiling resets. Free, and it consumes no quota, so it still answers once you are getting 429 quota_exceeded — which is the point: compare \"used\" against \"ceiling\" and read \"period.resetsAt\" to tell a period you have simply exhausted from a plan that is no longer active, which shows as a \"status\" of canceled and a ceiling of 0. \"used\" counts billing units (see \"unit\"), not HTTP requests: a single request can consume several. All money is in integer minor units (cents), never a decimal. The period reported here is the quota period — the calendar month in UTC, resetting at 00:00 UTC on the 1st. Your invoice window is anchored to the date you subscribed and is a different window; the amounts here are what this period’s usage has accrued so far, not a bill."
      }
    }
  ]
}
