{"_id":"@bizverify/sdk","_rev":"4-a29deb4263c9b790aec7cb4ad89e75e2","name":"@bizverify/sdk","dist-tags":{"latest":"0.2.2"},"versions":{"0.1.0":{"name":"@bizverify/sdk","version":"0.1.0","keywords":["bizverify","business-verification","entity-verification","kyb","know-your-business","secretary-of-state","companies-house","api-client","due-diligence","compliance","sdk"],"author":{"url":"https://bizverify.co","name":"BizVerify","email":"hello@bizverify.co"},"license":"MIT","_id":"@bizverify/sdk@0.1.0","maintainers":[{"name":"aadamyan","email":"alik.adamyan@gmail.com"}],"homepage":"https://bizverify.co","bugs":{"url":"https://github.com/BizVerify/bizverify-node/issues"},"dist":{"shasum":"7ace0a533123a705a550e118f37919ce76fe5a0c","tarball":"https://registry.npmjs.org/@bizverify/sdk/-/sdk-0.1.0.tgz","fileCount":9,"integrity":"sha512-7EhnPZgouiMPtXoQXL/jzHGPQ4eTYgAxnNhAqe38E6j/RkjqPD4zh0fptP4K7Zg6HuvNlQwtCVwlpJw7T73xiw==","signatures":[{"sig":"MEQCIFUoYCfZ44tU4xqKpp9W3yx6pgAFgTMs5n+Bydw/aUCGAiAgCM/s0tge//cMDpQ0CdBIKImrZqOyc25ABpGQJNQQbA==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@bizverify%2fsdk@0.1.0","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"unpackedSize":129478},"main":"./dist/index.cjs","type":"module","types":"./dist/index.d.ts","module":"./dist/index.js","engines":{"node":">=18"},"exports":{".":{"import":{"types":"./dist/index.d.ts","default":"./dist/index.js"},"require":{"types":"./dist/index.d.cts","default":"./dist/index.cjs"}}},"gitHead":"b1e95dad1a4a6a8a9b4e558401accc7c92e250e8","scripts":{"lint":"tsc --noEmit","test":"vitest run","build":"tsup","typecheck":"tsc --noEmit","test:watch":"vitest","prepublishOnly":"npm run build"},"_npmUser":{"name":"aadamyan","email":"alik.adamyan@gmail.com"},"repository":{"url":"git+https://github.com/BizVerify/bizverify-node.git","type":"git"},"_npmVersion":"10.9.4","description":"Official Node.js/TypeScript SDK for the BizVerify API — verify business entities against official government registries (Secretary of State, Companies House). Supports 61 jurisdictions across the US and Europe.","directories":{},"_nodeVersion":"22.22.1","_hasShrinkwrap":false,"devDependencies":{"tsup":"^8.0.0","vitest":"^3.0.0","typescript":"^5.7.0","@types/node":"^22.0.0"},"_npmOperationalInternal":{"tmp":"tmp/sdk_0.1.0_1774298033859_0.46400248461691307","host":"s3://npm-registry-packages-npm-production"}},"0.2.0":{"name":"@bizverify/sdk","version":"0.2.0","keywords":["bizverify","business-verification","entity-verification","kyb","know-your-business","secretary-of-state","companies-house","api-client","due-diligence","compliance","sdk"],"author":{"url":"https://bizverify.co","name":"BizVerify","email":"hello@bizverify.co"},"license":"MIT","_id":"@bizverify/sdk@0.2.0","maintainers":[{"name":"aadamyan","email":"alik.adamyan@gmail.com"}],"homepage":"https://bizverify.co","bugs":{"url":"https://github.com/BizVerify/bizverify-node/issues"},"dist":{"shasum":"2d19bab7984af3e87a65e137ed3bfaa8fda42922","tarball":"https://registry.npmjs.org/@bizverify/sdk/-/sdk-0.2.0.tgz","fileCount":9,"integrity":"sha512-V04uBvOrpT16etZolKplsex1CloFhaMIZh1kIKY9dzqqHjR5gL61lGBuZM2qrHE2JuH5aDET7CorDANJsF2yBg==","signatures":[{"sig":"MEUCICRETWInjOMsNOKPdZ1EfvdcXLfp7OTMJr+Z//BcsNoKAiEAp5im6fcGCOqnJIFlS60ASsyo9UZ/fpp0i2DBsChniY4=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@bizverify%2fsdk@0.2.0","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"unpackedSize":129466},"main":"./dist/index.cjs","type":"module","types":"./dist/index.d.ts","module":"./dist/index.js","engines":{"node":">=18"},"exports":{".":{"import":{"types":"./dist/index.d.ts","default":"./dist/index.js"},"require":{"types":"./dist/index.d.cts","default":"./dist/index.cjs"}}},"gitHead":"a530a1d9013389abdbc5ef2b95954bd3de304617","scripts":{"lint":"tsc --noEmit","test":"vitest run","build":"tsup","typecheck":"tsc --noEmit","test:watch":"vitest","prepublishOnly":"npm run build"},"_npmUser":{"name":"aadamyan","email":"alik.adamyan@gmail.com"},"repository":{"url":"git+https://github.com/BizVerify/bizverify-node.git","type":"git"},"_npmVersion":"10.9.7","description":"Official Node.js/TypeScript SDK for the BizVerify API — verify business entities against official government registries (Secretary of State, Companies House). Supports 61 jurisdictions across the US and Europe.","directories":{},"_nodeVersion":"22.22.2","_hasShrinkwrap":false,"devDependencies":{"tsup":"^8.0.0","vitest":"^3.0.0","typescript":"^5.7.0","@types/node":"^22.0.0"},"_npmOperationalInternal":{"tmp":"tmp/sdk_0.2.0_1776482774573_0.2534582705718056","host":"s3://npm-registry-packages-npm-production"}},"0.2.1":{"name":"@bizverify/sdk","version":"0.2.1","keywords":["bizverify","business-verification","entity-verification","kyb","know-your-business","secretary-of-state","companies-house","api-client","due-diligence","compliance","sdk"],"author":{"url":"https://bizverify.co","name":"BizVerify","email":"hello@bizverify.co"},"license":"MIT","_id":"@bizverify/sdk@0.2.1","maintainers":[{"name":"aadamyan","email":"alik.adamyan@gmail.com"}],"homepage":"https://bizverify.co","bugs":{"url":"https://github.com/BizVerify/bizverify-node/issues"},"dist":{"shasum":"f8df43c7a0c8ff094dca87f9e765d138767812f8","tarball":"https://registry.npmjs.org/@bizverify/sdk/-/sdk-0.2.1.tgz","fileCount":9,"integrity":"sha512-zSQQT8kuFpVGxT7YGWZOC4k8AZKGvGMrBWtWxqQP4x7MaubMPIW+il69vLg8kEy+u350dPuxKkKsTozu78oWGg==","signatures":[{"sig":"MEUCIQCgLEj5xPBPlNVkZgecZJNgQ5G8cSw7olYpoeYWJ//aRQIgB2kK7IoRbr/4OIBYPCxz6Pkr8kHkB2Axtubkg4YQvSU=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@bizverify%2fsdk@0.2.1","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"unpackedSize":129439},"main":"./dist/index.cjs","type":"module","types":"./dist/index.d.ts","module":"./dist/index.js","engines":{"node":">=18"},"exports":{".":{"import":{"types":"./dist/index.d.ts","default":"./dist/index.js"},"require":{"types":"./dist/index.d.cts","default":"./dist/index.cjs"}}},"gitHead":"9241da47b88119ad6f126f7f52e9cd284cc7c53d","scripts":{"lint":"tsc --noEmit","test":"vitest run","build":"tsup","typecheck":"tsc --noEmit","test:watch":"vitest","prepublishOnly":"npm run build"},"_npmUser":{"name":"GitHub Actions","email":"npm-oidc-no-reply@github.com","trustedPublisher":{"id":"github","oidcConfigId":"oidc:9ef89b9e-2fff-4873-9380-9b039ce68376"}},"repository":{"url":"git+https://github.com/BizVerify/bizverify-node.git","type":"git"},"_npmVersion":"11.13.0","description":"Official Node.js/TypeScript SDK for the BizVerify API — verify business entities against official government registries (Secretary of State, Companies House) across the US and Europe.","directories":{},"_nodeVersion":"24.16.0","_hasShrinkwrap":false,"devDependencies":{"tsup":"^8.0.0","vitest":"^3.0.0","typescript":"^5.7.0","@types/node":"^22.0.0"},"_npmOperationalInternal":{"tmp":"tmp/sdk_0.2.1_1780661365896_0.9940436869077804","host":"s3://npm-registry-packages-npm-production"}},"0.2.2":{"name":"@bizverify/sdk","version":"0.2.2","description":"Official Node.js/TypeScript SDK for the BizVerify API — verify business entities against official government registries (Secretary of State, Companies House) across the US and Europe.","type":"module","main":"./dist/index.cjs","module":"./dist/index.js","types":"./dist/index.d.ts","exports":{".":{"import":{"types":"./dist/index.d.ts","default":"./dist/index.js"},"require":{"types":"./dist/index.d.cts","default":"./dist/index.cjs"}}},"scripts":{"build":"tsup","typecheck":"tsc --noEmit","test":"vitest run","test:watch":"vitest","lint":"tsc --noEmit","prepublishOnly":"npm run build"},"keywords":["bizverify","business-verification","entity-verification","kyb","know-your-business","secretary-of-state","companies-house","api-client","due-diligence","compliance","sdk"],"homepage":"https://bizverify.co","repository":{"type":"git","url":"git+https://github.com/BizVerify/bizverify-node.git"},"bugs":{"url":"https://github.com/BizVerify/bizverify-node/issues"},"author":{"name":"BizVerify","email":"hello@bizverify.co","url":"https://bizverify.co"},"license":"MIT","engines":{"node":">=18"},"devDependencies":{"@types/node":"^22.0.0","tsup":"^8.0.0","typescript":"^5.7.0","vitest":"^3.0.0"},"gitHead":"96cb1ce11b3383f4ec8ad774c9086d2e7c7a29b5","_id":"@bizverify/sdk@0.2.2","_nodeVersion":"24.16.0","_npmVersion":"11.13.0","dist":{"integrity":"sha512-gTF+gHit5b84ZTTwriVOY6/zfExx7fmrz/BTf86t8UHm7B4DhilQtjUZ1xl4/8h9azDiyT6Hua8NkNKB5+i5YA==","shasum":"4024a640d332e2ca5d649f6105a2cb0c093b1068","tarball":"https://registry.npmjs.org/@bizverify/sdk/-/sdk-0.2.2.tgz","fileCount":9,"unpackedSize":130913,"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@bizverify%2fsdk@0.2.2","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEYCIQDlEV7kGtqaiPcZhz+rtNj10+GxkhzS4ydBHpFX9JQXKQIhAOA+81fqg/jyglAk2H+Ei3/fRWiIS1jjmmUte60RoKhR"}]},"_npmUser":{"name":"GitHub Actions","email":"npm-oidc-no-reply@github.com","trustedPublisher":{"id":"github","oidcConfigId":"oidc:9ef89b9e-2fff-4873-9380-9b039ce68376"}},"directories":{},"maintainers":[{"name":"aadamyan","email":"alik.adamyan@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/sdk_0.2.2_1781464687608_0.3985345774340796"},"_hasShrinkwrap":false}},"time":{"created":"2026-03-23T20:33:53.758Z","modified":"2026-06-14T19:18:08.013Z","0.1.0":"2026-03-23T20:33:54.007Z","0.2.0":"2026-04-18T03:26:14.700Z","0.2.1":"2026-06-05T12:09:26.041Z","0.2.2":"2026-06-14T19:18:07.748Z"},"bugs":{"url":"https://github.com/BizVerify/bizverify-node/issues"},"author":{"name":"BizVerify","email":"hello@bizverify.co","url":"https://bizverify.co"},"license":"MIT","homepage":"https://bizverify.co","keywords":["bizverify","business-verification","entity-verification","kyb","know-your-business","secretary-of-state","companies-house","api-client","due-diligence","compliance","sdk"],"repository":{"type":"git","url":"git+https://github.com/BizVerify/bizverify-node.git"},"description":"Official Node.js/TypeScript SDK for the BizVerify API — verify business entities against official government registries (Secretary of State, Companies House) across the US and Europe.","maintainers":[{"name":"aadamyan","email":"alik.adamyan@gmail.com"}],"readme":"# @bizverify/sdk\n\nOfficial TypeScript/Node.js SDK for the [BizVerify](https://bizverify.co) business verification API.\n\n## Installation\n\n```bash\nnpm install @bizverify/sdk\n```\n\nRequires Node.js 18+ (uses built-in `fetch`). Zero runtime dependencies.\n\n## Quick Start\n\n```typescript\nimport { BizVerify } from '@bizverify/sdk';\n\nconst biz = new BizVerify({ apiKey: 'bv_live_...' });\n\n// Quick check\nconst result = await biz.verification.verify({\n  entity_name: 'Acme Corporation',\n  jurisdiction: 'us-fl',\n});\n\n// Deep verification with polling\nconst full = await biz.verification.verifyAndWait({\n  entity_name: 'Acme Corporation',\n  jurisdiction: 'us-fl',\n  verification_level: 'deep',\n});\n```\n\n## Authentication\n\nBizVerify uses API key authentication. Get your key via the passwordless auth flow:\n\n```typescript\nconst biz = new BizVerify();\n\n// Step 1: Request access (sends OTP to email)\nawait biz.auth.requestAccess({ email: 'you@company.com', accept_terms: true });\n\n// Step 2: Verify with the code from your email\nconst { api_key } = await biz.auth.verifyAccess({\n  email: 'you@company.com',\n  code: '123456',\n  label: 'my-app',\n});\n\n// Client is now auto-configured with the new API key.\n// For future sessions, pass the key directly:\nconst biz2 = new BizVerify({ apiKey: api_key });\n```\n\n## Credit & Rate-Limit Tracking\n\nEvery API response captures credit and rate-limit headers:\n\n```typescript\nawait biz.verification.verify({ entity_name: 'Acme', jurisdiction: 'us-fl' });\n\nconst meta = biz.lastResponseMeta;\nconsole.log(meta?.creditsRemaining);    // 85\nconsole.log(meta?.creditsCharged);      // 15\nconsole.log(meta?.rateLimitRemaining);  // 59\n```\n\n## Resources\n\n### Auth\n\n```typescript\nawait biz.auth.requestAccess({ email, accept_terms: true });\nconst { api_key } = await biz.auth.verifyAccess({ email, code, label: 'my-agent' });\n```\n\n### Verification\n\n```typescript\n// Start verification\nconst job = await biz.verification.verify({\n  entity_name: 'Acme Inc',\n  jurisdiction: 'us-fl',\n  verification_level: 'deep',\n  webhook_url: 'https://example.com/hook', // optional\n});\n\n// Poll until complete\nconst result = await biz.verification.verifyAndWait(\n  { entity_name: 'Acme Inc', jurisdiction: 'us-fl', verification_level: 'deep' },\n  { timeoutMs: 120_000, onStatusChange: (s) => console.log(s.status) },\n);\n\n// Check job status manually\nconst status = await biz.verification.getStatus(jobId);\n```\n\n### Search\n\n```typescript\n// Single page\nconst page = await biz.search.find({ entity_name: 'Acme', jurisdiction: 'us-fl' });\n\n// Auto-paginate all results\nfor await (const entity of biz.search.findAll({ entity_name: 'Acme' })) {\n  console.log(entity.entity_name);\n}\n```\n\n### Entities\n\n```typescript\nconst entity = await biz.entities.get(entityId);\nconst history = await biz.entities.history(entityId, { limit: 10 });\n```\n\n### Account\n\n```typescript\nconst account = await biz.account.get();\nconst usage = await biz.account.usage({ days: 7 });\nconst data = await biz.account.dataExport();\nawait biz.account.updateEmail({ email: 'new@example.com' });\nconst key = await biz.account.createKey({ label: 'Production' });\nawait biz.account.revokeKey(keyId);\n```\n\n### Billing\n\n```typescript\nconst billing = await biz.billing.get();\nconst { url } = await biz.billing.purchase({ package_id: 'starter' });\n```\n\n### Config (no auth required)\n\n```typescript\nconst biz = new BizVerify();\nconst config = await biz.config.get();\nconsole.log(config.jurisdictions.supported.us); // ['us-fl', 'us-de', ...]\nconsole.log(config.pricing.creditCosts);        // { verify: 15, search: 2 }\n\nconst { jurisdictions } = await biz.config.jurisdictions();\n```\n\n### Checker (free, no auth)\n\n```typescript\nconst biz = new BizVerify();\nconst result = await biz.checker.check({ entity_name: 'Acme', jurisdiction: 'us-fl' });\n```\n\n## Error Handling\n\nAll API errors are thrown as typed exceptions:\n\n```typescript\nimport { BizVerify, InsufficientCreditsError, RateLimitError } from '@bizverify/sdk';\n\ntry {\n  await biz.verification.verify({ entity_name: 'Test', jurisdiction: 'us-fl' });\n} catch (err) {\n  if (err instanceof InsufficientCreditsError) {\n    console.log('Buy more credits');\n  } else if (err instanceof RateLimitError) {\n    console.log(`Retry after ${err.retryAfter}s`);\n  }\n}\n```\n\n| Exception | Status | When |\n|-----------|--------|------|\n| `ValidationError` | 400, 422 | Invalid request parameters |\n| `AuthenticationError` | 401 | Bad/missing API key |\n| `InsufficientCreditsError` | 402 | Not enough credits |\n| `AuthorizationError` | 403 | Forbidden (email not verified, account disabled) |\n| `NotFoundError` | 404 | Entity/job not found |\n| `ConflictError` | 409 | Duplicate email, already refunded |\n| `RateLimitError` | 429 | Too many requests |\n| `InternalError` | 5xx | Server error (auto-retried) |\n| `TimeoutError` | — | Polling timeout |\n| `JobFailedError` | — | Verification job failed |\n\n## Configuration\n\n```typescript\nconst biz = new BizVerify({\n  apiKey: 'bv_live_...',\n  baseUrl: 'https://api.bizverify.co', // default\n  maxRetries: 2,                        // retries on 5xx (default: 2)\n  timeout: 30_000,                      // per-request timeout ms (default: 30s)\n  fetch: customFetch,                   // custom fetch implementation\n});\n```\n\n## License\n\nMIT\n","readmeFilename":"README.md"}