knowfirm
v0.1.0
Published
TypeScript client for the KnowFirm KYB and firmographic data API (dependency-free).
Maintainers
Readme
knowfirm (TypeScript)
Dependency-free TypeScript client for the KnowFirm KYB and firmographic data API.
import { KnowFirm } from "knowfirm";
const kf = new KnowFirm({ apiKey: process.env.KNOWFIRM_KEY! });
// Resolve a business by name, EIN, LEI, CIK, FDIC cert, or ticker.
const biz = await kf.business({ name: "bank of america" });
// Ranked name search.
const candidates = await kf.search("bank of america");
// Sanctions screening (U.S. Consolidated Screening List).
const hits = await kf.screening({ name: "Example Trading Co" });
// Segment discovery: count + free 25-row sample.
const preview = await kf.segmentPreview({ source: "fdic_institutions", state: "TX" });
// Segment export: billed per returned row, pass limit explicitly.
const rows = await kf.segmentExport({ source: "fdic_institutions", state: "TX", limit: 500 });
// Batch enrich.
const { results } = await kf.enrich([{ name: "bank of america" }]);
// Watch an entity.
await kf.watchCreate({ name: "acme corp", kind: "screening" });Get an API key at knowfirm.com. Every lookup response carries a confidence score and per-field provenance naming the public source behind each fact.
KYB / firmographic data only. Not a consumer report (FCRA).
