Skip to main content

ID Analyzer API V2 client library, scan and verify global passport, driver license and identification card.

Project description

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

PyPI version Python versions license

Official Python 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

pip install idanalyzer2

Requires Python 3.8+. The requests and validators dependencies install automatically.

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 raises InvalidArgumentException.

Quick start

from idanalyzer2 import *

scanner = Scanner("YOUR_API_KEY")
scanner.throwApiException(True)
scanner.setProfile(Profile(Profile.SECURITY_MEDIUM))

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

Examples

from idanalyzer2 import *

# AML / PEP / sanctions screening
aml = AML("YOUR_API_KEY")
aml.search(name="John Smith", country="US")          # POST /aml
aml.searchV3(text="John Smith", limit=10, page=1)    # POST /amlv3

# KYB — business verification
# Verify a business from its registration/incorporation document. A document
# is required; an optional profile selects the KYC profile. The service
# extracts the company details, checks official company registries, screens
# against sanctions/PEP, and returns directors/owners to verify.
kyb = KYB("YOUR_API_KEY")
kyb.verify(document="registration.jpg")                       # document required
kyb.verify(document="registration.jpg", profile="YOUR_PROFILE_ID")  # with a KYC profile

# DocuPass — hosted remote verification link
docupass = Docupass("YOUR_API_KEY")
link = docupass.createDocupass("YOUR_PROFILE_ID")
print(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)
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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

idanalyzer2-1.3.0.tar.gz (23.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

idanalyzer2-1.3.0-py3-none-any.whl (22.4 kB view details)

Uploaded Python 3

File details

Details for the file idanalyzer2-1.3.0.tar.gz.

File metadata

  • Download URL: idanalyzer2-1.3.0.tar.gz
  • Upload date:
  • Size: 23.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for idanalyzer2-1.3.0.tar.gz
Algorithm Hash digest
SHA256 6877bdaf9a17615106e0888f530890ed55fa0a6220b4127e1bf71f31e4cae264
MD5 6833376e28dab064af94f5e65b4c861b
BLAKE2b-256 83d19f4f5c0fdb46e0da1671502f6f8782b56d37bb5f67a31ad3cbddb934a76c

See more details on using hashes here.

Provenance

The following attestation bundles were made for idanalyzer2-1.3.0.tar.gz:

Publisher: publish.yml on idanalyzer/id-analyzer-v2-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file idanalyzer2-1.3.0-py3-none-any.whl.

File metadata

  • Download URL: idanalyzer2-1.3.0-py3-none-any.whl
  • Upload date:
  • Size: 22.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for idanalyzer2-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a3fa3e1a6d9eb03c31ab2d6c978742ad43587ca204157fe5862118fb411fde48
MD5 d3380ea0f95e097db7f5d579cd8932c3
BLAKE2b-256 caa70276ee1b6ffea13e3fb6fe1fd99e153b5ff4383683cf28902290b3264cea

See more details on using hashes here.

Provenance

The following attestation bundles were made for idanalyzer2-1.3.0-py3-none-any.whl:

Publisher: publish.yml on idanalyzer/id-analyzer-v2-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page