{ "info": { "_postman_id": "oilflow-compliance-api", "name": "OilFlow Compliance API", "description": "Generated from platform/public/openapi.yaml. Set `api_key` to your sandbox (https://oilflow.us/sandbox) or production key. `base_url` defaults to https://oilflow.us.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "item": [ { "name": "Regulatory Matrix API", "description": "SKU", "item": [ { "name": "List all 235 jurisdictions in the regulatory matrix", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/regulatory/countries", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "regulatory", "countries" ] }, "description": "List all 235 jurisdictions in the regulatory matrix" } }, { "name": "Get single jurisdiction by slug", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/regulatory/countries/:slug", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "regulatory", "countries", ":slug" ] }, "description": "Get single jurisdiction by slug" } }, { "name": "Check if a product is tradeable between counterparties", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/regulatory/check?country=Saudi%20Arabia&product=crude&listing_type=demand", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "regulatory", "check" ], "query": [ { "key": "country", "value": "Saudi Arabia" }, { "key": "product", "value": "crude" }, { "key": "listing_type", "value": "demand" } ] }, "description": "Check if a product is tradeable between counterparties" } }, { "name": "List product categories supported by the matrix", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/regulatory/products", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "regulatory", "products" ] }, "description": "List product categories supported by the matrix" } } ] }, { "name": "Counterparty KYC-as-API", "description": "SKU", "item": [ { "name": "Screen a counterparty for sanctions, scam-cluster, and regulatory risk", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{api_key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/kyc/screen", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "kyc", "screen" ] }, "description": "Screen a counterparty for sanctions, scam-cluster, and regulatory risk", "body": { "mode": "raw", "raw": "{\n \"company_name\": \"Acme Trading FZE\",\n \"country\": \"UAE\",\n \"directors\": [\n \"John Doe\"\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Queue an asynchronous re-screen of a previously registered entity", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{api_key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/kyc/rescreen", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "kyc", "rescreen" ] }, "description": "Triggers an out-of-band re-run of the 7-step KYC pipeline for a\npreviously registered `kyc_dossiers` row. Returns `202` with a\n`screening_run_id`. Subscribe to the `kyc.rescreen_completed`\nwebhook event (and `kyc.match_detected` on a hit) to receive the\noutcome asynchronously.\n", "body": { "mode": "raw", "raw": "{\n \"entity_id\": \"00000000-0000-0000-0000-000000000001\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Scam Cluster Intelligence Feed", "description": "SKU", "item": [ { "name": "List verified-fraudulent counterparty clusters", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/clusters?severity=confirmed", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "clusters" ], "query": [ { "key": "severity", "value": "confirmed" } ] }, "description": "List verified-fraudulent counterparty clusters" } }, { "name": "Check if a specific entity matches the cluster blocklist", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/clusters/check?entity=Simar%20Chahal", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "clusters", "check" ], "query": [ { "key": "entity", "value": "Simar Chahal" } ] }, "description": "Check if a specific entity matches the cluster blocklist" } } ] }, { "name": "Webhooks", "description": "Cross-SKU outbound webhook subscriptions, event queue, and DLQ replay.", "item": [ { "name": "List your active webhook subscriptions", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/webhooks", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "webhooks" ] }, "description": "List your active webhook subscriptions" } }, { "name": "Create a webhook subscription", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{api_key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/webhooks", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "webhooks" ] }, "description": "On success the response contains the HMAC signing secret \u2014 store it,\nit will not be shown again. Rotation requires DELETE + POST.\n", "body": { "mode": "raw", "raw": "{\n \"url\": \"https://hooks.example.com/oilflow\",\n \"events\": [\n \"kyc.match_detected\",\n \"cluster.entity_severity_changed\"\n ],\n \"description\": \"Compliance war-room channel\",\n \"delivery_format\": \"raw\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Deactivate a subscription", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/webhooks/:id", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "webhooks", ":id" ] }, "description": "Deactivate a subscription" } }, { "name": "Browse recent webhook delivery attempts", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/webhooks/events", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "webhooks", "events" ] }, "description": "Browse recent webhook delivery attempts" } }, { "name": "Replay a DLQ'd webhook event", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{api_key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/webhooks/events/:id/replay", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "webhooks", "events", ":id", "replay" ] }, "description": "Re-queues a `dlq` event back to `pending` with attempt count reset.\nOnly `dlq` rows are replayable.\n", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Regulator Reports", "description": "Six regulator-ready report templates (FinCEN SAR, FATF Rec 10, FCA SYSC 18, MAS Notice 626, OFSI Annual, FFIEC BSA).", "item": [ { "name": "List available regulator templates", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/reports", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reports" ] }, "description": "List available regulator templates" } }, { "name": "Generate a regulator-ready report", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{api_key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/reports", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reports" ] }, "description": "Pulls KYC dossier + sanctions screening + verification log evidence\nand renders an HTML artifact (PDF rendering happens out-of-band).\nThe response includes a 10-minute signed download URL.\n", "body": { "mode": "raw", "raw": "{\n \"entity_id\": \"00000000-0000-0000-0000-000000000001\",\n \"template_id\": \"fatf_rec10\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Fetch a generated report", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/reports/:id", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reports", ":id" ] }, "description": "Fetch a generated report" } }, { "name": "JSON evidence trail for a report", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/reports/:id/audit", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reports", ":id", "audit" ] }, "description": "Returns `evidence_json` \u2014 the map of report fields to underlying\n`verification_log`, `sanctions_screening_log`, and\n`compliance_checks` row IDs. Banks present this to regulators\nwhen asked to substantiate prefilled answers.\n" } } ] }, { "name": "Adverse Media", "description": "Multilingual adverse-media monitoring for registered entities (Arabic, Urdu, Mandarin, Russian, Spanish, French, Swahili, English).", "item": [ { "name": "List monitored entities", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/adverse-media/entities", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "adverse-media", "entities" ] }, "description": "List monitored entities" } }, { "name": "Register an entity for daily multilingual monitoring", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{api_key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/adverse-media/entities", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "adverse-media", "entities" ] }, "description": "Register an entity for daily multilingual monitoring", "body": { "mode": "raw", "raw": "{\n \"entity_name\": \"Acme Trading FZE\",\n \"aliases\": [\n \"Acme FZE\"\n ],\n \"languages\": [\n \"en\",\n \"ar\"\n ],\n \"jurisdictions\": [\n \"UAE\"\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Pause monitoring on an entity", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/adverse-media/entities/:id", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "adverse-media", "entities", ":id" ] }, "description": "Pause monitoring on an entity" } }, { "name": "List adverse media findings", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/adverse-media/findings", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "adverse-media", "findings" ] }, "description": "List adverse media findings" } } ] }, { "name": "UBO Graph", "description": "Beneficial-owner traversal + shell-detection across OpenCorporates and national registries.", "item": [ { "name": "Build (or fetch cached) beneficial-owner graph for an entity", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{api_key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/ubo/screen", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "ubo", "screen" ] }, "description": "Returns the cached graph immediately on hit (within 90-day TTL); on\ncache miss inserts a queued row and returns `202` with the\n`graph_id`. The Python worker drains queued rows asynchronously.\n", "body": { "mode": "raw", "raw": "{\n \"root_entity_name\": \"Acme Holdings Ltd\",\n \"root_jurisdiction\": \"BVI\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Fetch a UBO graph by id", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/ubo/graph/:id", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "ubo", "graph", ":id" ] }, "description": "Fetch a UBO graph by id" } } ] }, { "name": "LC Validation", "description": "UCP 600 discrepancy engine for Letter of Credit + invoice + Bill of Lading bundles.", "item": [ { "name": "Run UCP 600 rule engine against an LC + invoice + Bill of Lading", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{api_key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/lc/validate", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "lc", "validate" ] }, "description": "Pass structured extracted fields (the bank's OCR / MT700 parser is\nthe source). Returns a discrepancy report with aggregated severity\nand a `honor | inquiry | refuse` recommendation.\n", "body": { "mode": "raw", "raw": "{\n \"lc\": {\n \"amount\": 1000000,\n \"currency\": \"USD\",\n \"beneficiary\": \"Acme Trading FZE\",\n \"port_of_loading\": \"Fujairah\",\n \"expiry_date\": \"2026-07-15\"\n },\n \"invoice\": {\n \"total_amount\": 1000000,\n \"currency\": \"USD\",\n \"seller_name\": \"Acme Trading FZE\",\n \"presentation_date\": \"2026-06-15\"\n },\n \"bl\": {\n \"currency\": \"USD\",\n \"port_of_loading\": \"Fujairah\",\n \"issue_date\": \"2026-06-01\",\n \"shipped_on_board\": true\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Fetch a past LC validation run", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/lc/reports/:id", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "lc", "reports", ":id" ] }, "description": "Fetch a past LC validation run" } } ] }, { "name": "Audit", "description": "Cross-SKU append-only audit log export.", "item": [ { "name": "Export your append-only API audit trail", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/audit?format=summary&days=30", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "audit" ], "query": [ { "key": "format", "value": "summary" }, { "key": "days", "value": "30" } ] }, "description": "Returns the caller's own `api_request_log` rows for the requested\nwindow. JSON or CSV. Banks use this as compliance evidence during\ntheir own regulatory audits.\n" } } ] }, { "name": "Sandbox", "description": "Self-serve sandbox API keys for evaluation. Throwaway keys auto-expire after 7 days.", "item": [ { "name": "Issue a free 7-day evaluation API key", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/keys/sandbox", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "keys", "sandbox" ] }, "description": "Returns a sandbox API key valid for 7 days, capped at 100 calls/day,\nscoped to read-only public endpoints (`/api/v1/regulatory/*` and\n`/api/v1/clusters/check`). No signup required, but email is captured\nfor upgrade outreach. Rate limited to 3 keys per IP per hour and\n5 per email per day. Anonymous (no member binding) \u2014 promote to a\nproduction key at `/pricing`.\n", "body": { "mode": "raw", "raw": "{\n \"email\": \"compliance@example.bank\",\n \"company\": \"Example Bank Trade Finance\",\n \"use_case\": \"Evaluating /regulatory/check for Saudi Arabia crude\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Keys", "description": "", "item": [ { "name": "List your production API keys", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/keys", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "keys" ] }, "description": "Returns the caller's production API keys with metadata\n(last_used_at, scopes, environment, expires_at). Secret values\nare never returned after issuance.\n" } }, { "name": "Create a production API key", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{api_key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/keys", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "keys" ] }, "description": "Issues a new production API key. The raw key is shown once on\ncreation \u2014 store it immediately. Scopes default to the member's\nplan entitlements; pass `scopes` to narrow further.\n", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Revoke a production API key", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/keys", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "keys" ] }, "description": "Soft-deletes the key. In-flight requests using it begin failing immediately." } } ] }, { "name": "Watchlists", "description": "", "item": [ { "name": "Fetch a watchlist with sample entries and recent matches", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/watchlists/:id", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "watchlists", ":id" ] }, "description": "Returns the watchlist metadata, the first 25 entries (for\nverification), and the 50 most recent match-log entries.\n" } }, { "name": "Delete a watchlist", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/watchlists/:id", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "watchlists", ":id" ] }, "description": "Soft-deletes the watchlist. The daily sync agent skips it on next run." } } ] } ], "variable": [ { "key": "base_url", "value": "https://oilflow.us", "description": "OilFlow API base URL." }, { "key": "api_key", "value": "oilflow_REPLACE_WITH_YOUR_KEY", "description": "Get a sandbox key at https://oilflow.us/sandbox or a production key at https://oilflow.us/pricing." } ] }