{ "openapi": "3.1.0", "info": { "title": "Plumbline", "version": "1", "description": "Plumbline screens a person or company name against the US Treasury OFAC SDN list and its aliases in seconds, returning each match with its score, entry number and programs and the list's publication date; a match is a lead for review, not a determination. Its company checks (LEI and SEC registration, SEC-reported XBRL figures and federal contract awards) answer from the public registries where they are running, and every answer names the record it came from." }, "servers": [ { "url": "https://plumbline.forevenza.com" } ], "tags": [ { "name": "Plumbline", "description": "Plumbline screens a person or company name against the US Treasury OFAC SDN list and its aliases in seconds, returning each match with its score, entry number and programs and the list's publication date; a match is a lead for review, not a determination. Its company checks (LEI and SEC registration, SEC-reported XBRL figures and federal contract awards) answer from the public registries where they are running, and every answer names the record it came from." } ], "paths": { "/sanctions-screening/requests": { "post": { "operationId": "sanctions_screening_request", "summary": "Send a requirement: Screen a name against the OFAC SDN list", "description": "Plumbline. The name is normalized and compared with the copy of the SDN list (primary names and aliases) that this service refreshes daily from OFAC. The answer lists matches above the similarity floor with their score, OFAC entry number, type and programs, and the publication the copy came from. A match is a lead to review, not a determination.", "tags": [ "Plumbline" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "need" ], "properties": { "action": { "type": "string", "enum": [ "buy", "source", "quote", "verify", "lease", "license", "hire", "retrieve", "convert", "other" ], "description": "What you want done" }, "need": { "type": "string", "maxLength": 2000, "description": "The requirement in your own words" }, "specifications": { "type": "object", "properties": { "party_name": { "type": "string", "description": "Name to screen", "maxLength": 200, "x-facet": "identifier" }, "party_type": { "type": "string", "enum": [ "individual", "organization", "vessel", "aircraft", "unknown" ], "description": "What the party is", "x-facet": "specification" }, "lists_required": { "type": "array", "items": { "type": "string", "maxLength": 60 }, "maxItems": 20, "description": "Which lists you must screen against, e.g. OFAC SDN, EU, UK HMT, UN", "x-facet": "specification" }, "batch_size": { "type": "integer", "minimum": 1, "description": "How many names per run", "x-facet": "quantity" } } }, "quantity": { "type": "object", "properties": { "amount": { "type": "number" }, "unit": { "type": "string" }, "per": { "type": "string" } } }, "timing": { "type": "object", "properties": { "earliest": { "type": "string" }, "latest": { "type": "string" }, "recurrence": { "type": "string" }, "text": { "type": "string" } } }, "geography": { "type": "object", "properties": { "text": { "type": "string" }, "country": { "type": "string" }, "from": { "type": "string" }, "to": { "type": "string" } } }, "budget": { "type": "object", "properties": { "amount": { "type": "number" }, "currency": { "type": "string", "description": "ISO 4217, default USD" }, "per": { "type": "string", "description": "total, unit, month, year, load, ..." } } }, "requested_fields": { "type": "array", "items": { "type": "string" }, "maxItems": 30, "description": "Result fields you need" }, "contact": { "type": "object", "description": "Optional; stored apart and deleted after 180 days", "properties": { "email": { "type": "string" }, "name": { "type": "string" }, "organization": { "type": "string" } } } } } } } }, "responses": { "201": { "description": "Kept on file; the receipt carries the reference number and what happens next" }, "400": { "description": "Not a valid request" } } } }, "/sanctions-screening/op/screen": { "get": { "operationId": "sanctions_screening_screen", "summary": "SDN entries and aliases whose normalized name is similar to the given name, with scores, programs and the list publication date.", "tags": [ "Plumbline" ], "parameters": [ { "name": "name", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Name to screen" }, { "name": "min_score", "in": "query", "required": false, "schema": { "type": "number" }, "description": "Similarity floor, default 0.82" } ], "responses": { "200": { "description": "Result", "content": { "application/json": { "example": { "query": "Banco Nacional de Cuba", "matches": [ { "ofac_uid": "306", "listed_name": "BANCO NACIONAL DE CUBA", "score": 1, "type": "organization", "programs": "CUBA", "list": "SDN" } ], "publication": "2026-10-27", "fetched_at": "2026-11-03T06:17:00Z", "note": "A match is a lead for review, not a sanctions determination." } } } }, "503": { "description": "Daily allowance reached or a source unavailable" } } } }, "/entity-verification/requests": { "post": { "operationId": "entity_verification_request", "summary": "Send a requirement: Legal entity verification by name, LEI or CIK", "description": "Plumbline. The lookup runs immediately against GLEIF's public LEI API and, when you give a CIK or ticker, SEC EDGAR's submissions API. The answer lists every matching LEI record with its registration status and the registry it came from. Nothing is inferred: a company with no LEI and no SEC filings returns no match, and the answer says so.", "tags": [ "Plumbline" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "need" ], "properties": { "action": { "type": "string", "enum": [ "buy", "source", "quote", "verify", "lease", "license", "hire", "retrieve", "convert", "other" ], "description": "What you want done" }, "need": { "type": "string", "maxLength": 2000, "description": "The requirement in your own words" }, "specifications": { "type": "object", "properties": { "legal_name": { "type": "string", "description": "The company's name as you have it", "maxLength": 200, "x-facet": "identifier" }, "lei": { "type": "string", "description": "Legal Entity Identifier, 20 characters", "maxLength": 20, "x-facet": "identifier" }, "cik": { "type": "string", "description": "SEC Central Index Key", "maxLength": 10, "x-facet": "identifier" }, "jurisdiction": { "type": "string", "description": "Country or ISO 3166 code where the company is registered", "maxLength": 60, "x-facet": "geography" }, "checks_needed": { "type": "array", "items": { "type": "string", "maxLength": 80 }, "maxItems": 20, "description": "What you need confirmed, e.g. registered address, status, ownership", "x-facet": "specification" }, "volume": { "type": "integer", "description": "How many entities you need verified", "minimum": 1, "x-facet": "quantity" } } }, "quantity": { "type": "object", "properties": { "amount": { "type": "number" }, "unit": { "type": "string" }, "per": { "type": "string" } } }, "timing": { "type": "object", "properties": { "earliest": { "type": "string" }, "latest": { "type": "string" }, "recurrence": { "type": "string" }, "text": { "type": "string" } } }, "geography": { "type": "object", "properties": { "text": { "type": "string" }, "country": { "type": "string" }, "from": { "type": "string" }, "to": { "type": "string" } } }, "budget": { "type": "object", "properties": { "amount": { "type": "number" }, "currency": { "type": "string", "description": "ISO 4217, default USD" }, "per": { "type": "string", "description": "total, unit, month, year, load, ..." } } }, "requested_fields": { "type": "array", "items": { "type": "string" }, "maxItems": 30, "description": "Result fields you need" }, "contact": { "type": "object", "description": "Optional; stored apart and deleted after 180 days", "properties": { "email": { "type": "string" }, "name": { "type": "string" }, "organization": { "type": "string" } } } } } } } }, "responses": { "201": { "description": "Kept on file; the receipt carries the reference number and what happens next" }, "400": { "description": "Not a valid request" } } } }, "/entity-verification/op/lookup": { "get": { "operationId": "entity_verification_lookup", "summary": "LEI records matching a name or an LEI, and the SEC EDGAR registration for a CIK or ticker, each with its registry source and retrieval time.", "tags": [ "Plumbline" ], "parameters": [ { "name": "name", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Legal name or part of it" }, { "name": "lei", "in": "query", "required": false, "schema": { "type": "string" }, "description": "A 20-character LEI" }, { "name": "cik", "in": "query", "required": false, "schema": { "type": "string" }, "description": "SEC CIK" }, { "name": "ticker", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Stock ticker of an SEC filer" }, { "name": "country", "in": "query", "required": false, "schema": { "type": "string" }, "description": "ISO 3166 alpha-2 code to narrow a name search" } ], "responses": { "200": { "description": "Result", "content": { "application/json": { "example": { "query": { "name": "Apple Inc.", "ticker": "AAPL" }, "lei_records": [ { "lei": "HWUPKR0MPOU8FGXBT394", "legal_name": "Apple Inc.", "jurisdiction": "US-CA", "entity_status": "ACTIVE", "registration_status": "ISSUED", "next_renewal": "2027-03-08", "legal_address": "C/O C T Corporation System, 330 N. Brand Blvd, Suite 700, Glendale, US-CA, 91203, US", "headquarters_address": "One Apple Park Way, Cupertino, US-CA, 95014, US", "registration_authority": "RA000598", "registration_authority_entity_id": "806592" } ], "edgar": { "cik": "0000320193", "name": "Apple Inc.", "sic": "3571", "sic_description": "Electronic Computers", "state_of_incorporation": "CA", "business_address": "ONE APPLE PARK WAY, CUPERTINO, CA, 95014", "recent_filings": [ { "form": "10-K", "filed": "2026-11-03", "accession": "0000320193-26-000026" } ] }, "sources": [ { "registry": "GLEIF", "url": "https://api.gleif.org/api/v1/lei-records/HWUPKR0MPOU8FGXBT394", "retrieved_at": "2026-11-03T19:05:00Z" }, { "registry": "SEC EDGAR", "url": "https://data.sec.gov/submissions/CIK0000320193.json", "retrieved_at": "2026-11-03T19:05:00Z" } ], "not_found": [] } } } }, "402": { "description": "Payment required: $0.02 via x402 (USDC on eip155:84532)" }, "503": { "description": "Daily allowance reached or a source unavailable" } } } }, "/company-financials/requests": { "post": { "operationId": "company_financials_request", "summary": "Send a requirement: Reported financial figures for US public companies", "description": "Plumbline. The call reads SEC EDGAR's XBRL companyconcept API for the CIK or ticker and concept you give, and returns every reported value with its period, form, fiscal year and accession number. Figures are as filed; restatements appear as separate rows.", "tags": [ "Plumbline" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "need" ], "properties": { "action": { "type": "string", "enum": [ "buy", "source", "quote", "verify", "lease", "license", "hire", "retrieve", "convert", "other" ], "description": "What you want done" }, "need": { "type": "string", "maxLength": 2000, "description": "The requirement in your own words" }, "specifications": { "type": "object", "properties": { "company": { "type": "string", "description": "Company name, ticker or CIK", "maxLength": 200, "x-facet": "identifier" }, "metrics": { "type": "array", "items": { "type": "string", "maxLength": 80 }, "maxItems": 20, "description": "Figures needed, e.g. revenue, operating margin, headcount", "x-facet": "specification" }, "periods": { "type": "string", "description": "Fiscal years or quarters", "maxLength": 80, "x-facet": "timing" }, "companies_count": { "type": "integer", "minimum": 1, "description": "How many companies", "x-facet": "quantity" } } }, "quantity": { "type": "object", "properties": { "amount": { "type": "number" }, "unit": { "type": "string" }, "per": { "type": "string" } } }, "timing": { "type": "object", "properties": { "earliest": { "type": "string" }, "latest": { "type": "string" }, "recurrence": { "type": "string" }, "text": { "type": "string" } } }, "geography": { "type": "object", "properties": { "text": { "type": "string" }, "country": { "type": "string" }, "from": { "type": "string" }, "to": { "type": "string" } } }, "budget": { "type": "object", "properties": { "amount": { "type": "number" }, "currency": { "type": "string", "description": "ISO 4217, default USD" }, "per": { "type": "string", "description": "total, unit, month, year, load, ..." } } }, "requested_fields": { "type": "array", "items": { "type": "string" }, "maxItems": 30, "description": "Result fields you need" }, "contact": { "type": "object", "description": "Optional; stored apart and deleted after 180 days", "properties": { "email": { "type": "string" }, "name": { "type": "string" }, "organization": { "type": "string" } } } } } } } }, "responses": { "201": { "description": "Kept on file; the receipt carries the reference number and what happens next" }, "400": { "description": "Not a valid request" } } } }, "/company-financials/op/facts": { "get": { "operationId": "company_financials_facts", "summary": "Every reported value of one XBRL concept for one SEC filer, with period, form and accession number.", "tags": [ "Plumbline" ], "parameters": [ { "name": "cik", "in": "query", "required": false, "schema": { "type": "string" }, "description": "SEC CIK" }, { "name": "ticker", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Ticker" }, { "name": "concept", "in": "query", "required": false, "schema": { "type": "string" }, "description": "XBRL concept name, default Revenues" }, { "name": "taxonomy", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Default us-gaap" } ], "responses": { "200": { "description": "Result", "content": { "application/json": { "example": { "cik": "0000320193", "entity": "Apple Inc.", "concept": "RevenueFromContractWithCustomerExcludingAssessedTax", "unit": "USD", "values": [ { "start": "2025-09-28", "end": "2026-09-26", "value": 478834000000, "form": "10-K", "fy": 2026, "fp": "FY", "filed": "2026-11-03", "accession": "0000320193-26-000026" } ], "source": "https://data.sec.gov/api/xbrl/companyconcept/CIK0000320193/us-gaap/RevenueFromContractWithCustomerExcludingAssessedTax.json" } } } }, "503": { "description": "Daily allowance reached or a source unavailable" } } } }, "/federal-awards/requests": { "post": { "operationId": "federal_awards_request", "summary": "Send a requirement: US federal contract awards by recipient, industry or place", "description": "Plumbline. The call sends your filters to the FPDS public ATOM feed and returns the matching contract actions ten at a time, in FPDS order: each award or modification with its contract number, signing date, vendor, agency, the amount it obligated, the contract's total obligated to date, the NAICS code, the place of performance and a link to the FPDS record. Without a fiscal year, it searches actions signed in the last twelve months. Nothing is estimated or summed.", "tags": [ "Plumbline" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "need" ], "properties": { "action": { "type": "string", "enum": [ "buy", "source", "quote", "verify", "lease", "license", "hire", "retrieve", "convert", "other" ], "description": "What you want done" }, "need": { "type": "string", "maxLength": 2000, "description": "The requirement in your own words" }, "specifications": { "type": "object", "properties": { "recipient": { "type": "string", "maxLength": 200, "description": "Company receiving awards", "x-facet": "identifier" }, "naics": { "type": "string", "maxLength": 6, "description": "NAICS industry code", "x-facet": "identifier" }, "agency": { "type": "string", "maxLength": 120, "description": "Awarding agency", "x-facet": "specification" }, "fiscal_years": { "type": "string", "maxLength": 40, "description": "Fiscal years of interest", "x-facet": "timing" }, "state": { "type": "string", "maxLength": 2, "description": "Place of performance state", "x-facet": "geography" } } }, "quantity": { "type": "object", "properties": { "amount": { "type": "number" }, "unit": { "type": "string" }, "per": { "type": "string" } } }, "timing": { "type": "object", "properties": { "earliest": { "type": "string" }, "latest": { "type": "string" }, "recurrence": { "type": "string" }, "text": { "type": "string" } } }, "geography": { "type": "object", "properties": { "text": { "type": "string" }, "country": { "type": "string" }, "from": { "type": "string" }, "to": { "type": "string" } } }, "budget": { "type": "object", "properties": { "amount": { "type": "number" }, "currency": { "type": "string", "description": "ISO 4217, default USD" }, "per": { "type": "string", "description": "total, unit, month, year, load, ..." } } }, "requested_fields": { "type": "array", "items": { "type": "string" }, "maxItems": 30, "description": "Result fields you need" }, "contact": { "type": "object", "description": "Optional; stored apart and deleted after 180 days", "properties": { "email": { "type": "string" }, "name": { "type": "string" }, "organization": { "type": "string" } } } } } } } }, "responses": { "201": { "description": "Kept on file; the receipt carries the reference number and what happens next" }, "400": { "description": "Not a valid request" } } } }, "/federal-awards/op/search": { "get": { "operationId": "federal_awards_search", "summary": "Up to ten federal contract actions matching vendor, NAICS, place-of-performance state and fiscal year, from FPDS, with the start of the next page.", "tags": [ "Plumbline" ], "parameters": [ { "name": "recipient", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Vendor name text, as reported to FPDS" }, { "name": "naics", "in": "query", "required": false, "schema": { "type": "string" }, "description": "NAICS code" }, { "name": "state", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Place-of-performance state, two letters" }, { "name": "fiscal_year", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Federal fiscal year" }, { "name": "start", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Where the page starts: 0, 10, 20 and so on" } ], "responses": { "200": { "description": "Result", "content": { "application/json": { "example": { "filters": { "recipient": "LOCKHEED MARTIN", "fiscal_year": 2025, "signed_between": [ "2024/10/01", "2025/09/30" ] }, "actions": [ { "piid": "0001", "modification": "10", "signed_date": "2025-01-28", "vendor": "LOCKHEED MARTIN CORPORATION (3632)", "department": "DEPT OF DEFENSE", "agency": "DEFENSE CONTRACT MANAGEMENT AGENCY (DCMA)", "obligated_amount": -466098.9, "total_obligated_amount": 1964384.2, "base_and_all_options_value": -466098.9, "naics": "334419", "naics_description": "OTHER ELECTRONIC COMPONENT MANUFACTURING", "place_of_performance_state": "NY", "description": "UNDEFINITIZED ORDER", "url": "https://www.fpds.gov/ezsearch/search.do?s=FPDS&indexName=awardfull&templateName=1.5.3&q=0001+9700+" } ], "next_start": 10, "note": "Each item is one contract action as reported to FPDS (an award or a modification): obligated_amount is that action's, total_obligated_amount the contract's to date. Results come in FPDS order, not by amount.", "source": "https://www.fpds.gov/ezsearch/FEEDS/ATOM?FEEDNAME=PUBLIC&q=VENDOR_NAME%3A%22LOCKHEED%20MARTIN%22%20SIGNED_DATE%3A%5B2024%2F10%2F01%2C2025%2F09%2F30%5D&start=0" } } } }, "503": { "description": "Daily allowance reached or a source unavailable" } } } } }, "externalDocs": { "description": "Plumbline: Know who you are dealing with.", "url": "https://plumbline.forevenza.com/" } }