Skip to content

Repository files navigation

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

NuGet version NuGet downloads license

Official .NET / C# 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.

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.

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

Installation

The v2 SDK ships as IDAnalyzerV2 (the legacy IDAnalyzer package id remains the API v1 SDK):

dotnet add package IDAnalyzerV2

Targets .NET Standard 2.1 (works with .NET Core 3.x, .NET 5/6/8+).

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.

Quick start

using IDAnalyzer;

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

// Scan a document + selfie for biometric verification
var result = scanner.scan("id_front.jpg", "", "selfie.jpg");
Console.WriteLine(result["decision"]);   // accept / review / reject

Examples

using IDAnalyzer;

// AML / PEP / sanctions screening
var aml = new AML("YOUR_API_KEY");
aml.search("John Smith", "", 0, "US");        // POST /aml
aml.searchV3("John Smith", "", 10, 1);        // POST /amlv3

// KYB — business verification
// Verify a business from its registration/incorporation document: extract
// details, check official company registries, screen against sanctions/PEP,
// and return directors/owners to verify.
var kyb = new KYB("YOUR_API_KEY");
kyb.verify("registration.jpg");                                       // from a document
kyb.verify("", "ACME CORPORATION", "", "12345678", "", "", "US");     // from known details

// DocuPass — hosted remote verification link
var docupass = new Docupass("YOUR_API_KEY");
var link = docupass.createDocupass("YOUR_PROFILE_ID");
Console.WriteLine(link["url"]);

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)
KYB verify (/kyb)
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

Other ID Analyzer SDKs

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

License

MIT © ID Analyzer — see LICENSE.

About

.Net Client Library for ID Analyzer API v2

Resources

Stars

1 star

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages