ID Analyzer Node.js SDK — Identity Verification, KYC, Document & Biometric API

Official Node.js / TypeScript client library for the ID Analyzer API v2 — automate identity document verification, KYC onboarding and biometric checks in minutes.

Scan and authenticate passports, driver's licenses, ID cards, visas and residence permits from 190+ countries, run 1:1 face match and liveness detection, screen against AML / PEP / sanctions watchlists, and onboard users remotely with DocuPass hosted verification & e-signature.

• 🌐 Website: www.idanalyzer.com
• 📚 Developer docs & API reference: developer.idanalyzer.com
• 📖 Full SDK class reference (auto-generated): https://idanalyzer.github.io/id-analyzer-v2-nodejs/
• 🔑 Get your API key: portal2.idanalyzer.com
• 💬 Support: [email protected]

Features

• Document OCR & authentication — passport, driver's license, ID card, visa & residence-permit recognition from 190+ countries, including MRZ and PDF417 / AAMVA barcode parsing.
• Biometric verification — 1:1 face match and liveness / presentation-attack detection.
• AML screening — PEP, sanctions, watchlist and adverse-media checks.
• DocuPass — hosted, no-code remote identity verification, KYC/AML onboarding and legally-binding e-signature.
• KYC profiles, transaction vault, contract generation and webhooks.
• US & EU data-residency regions.
• Bundled TypeScript type definitions.

⚠️ Never embed your API key in client-side apps (mobile, browser JS). Call the API from your server.

Installation

npm install idanalyzer2

TypeScript definitions are bundled (index.d.ts) — no @types package needed.

Authentication & region

Pass your API key to each client, or set the IDANALYZER_KEY environment variable. The SDK targets the US endpoint (https://api2.idanalyzer.com) by default; set IDANALYZER_REGION=eu for the EU endpoint (https://api2-eu.idanalyzer.com). An unrecognized region throws InvalidArgumentException. For on-premise ID Fort deployments, call SetEndpoint('https://your-host/').

Quick start

import IdAnalyzer from "idanalyzer2"
const { Profile, Scanner, APIError, InvalidArgumentException } = IdAnalyzer

const scanner = new Scanner("YOUR_API_KEY")
scanner.throwApiException(true)
scanner.setProfile(new Profile(Profile.SECURITY_MEDIUM))

// Scan a document + selfie for biometric verification
const result = await scanner.scan("id_front.jpg", "", "selfie.jpg")
console.log(result.decision)   // accept / review / reject

Examples

// AML / PEP / sanctions screening
const { AML } = IdAnalyzer
const aml = new AML("YOUR_API_KEY")
await aml.search("John Smith", "", 0, "US")      // POST /aml
await aml.searchV3("John Smith", "", 10, 1)      // POST /amlv3

// DocuPass — hosted remote verification link
const { Docupass } = IdAnalyzer
const docupass = new Docupass("YOUR_API_KEY")
const link = await docupass.createDocupass("YOUR_PROFILE_ID")
console.log(link.url)

More demos in the /demo folder.

API coverage

The SDK wraps the complete ID Analyzer API v2 surface:

| Class | Methods | |---|---| | Scanner | scan, quickScan, veryQuickScan | | Biometric | verifyFace, verifyLiveness | | AML | search (/aml), searchV3 (/amlv3) | | Contract | generate + template CRUD | | Transaction | getTransaction, listTransaction, updateTransaction, deleteTransaction, exportTransaction, saveImage, saveFile | | Docupass | createDocupass, listDocupass, getDocupass, deleteDocupass | | ProfileAPI | KYC profile create / list / get / update / delete / export | | Webhook | listWebhook, resendWebhook, deleteWebhook | | Account | getAccount | | Profile | client-side KYC profile-override builder |

Resources

• ID Analyzer website
• Developer documentation & API reference
• Node.js SDK guide
• Dashboard — get your API key

Other ID Analyzer SDKs

PHP · Python · Node.js · .NET · Java · Go

License

MIT © ID Analyzer — see LICENSE.