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
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.
- 🌐 Website: www.idanalyzer.com
- 📚 Developer docs & API reference: developer.idanalyzer.com
- 🔑 Get your API key: portal2.idanalyzer.com
- 💬 Support: support@idanalyzer.com
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
# 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) |
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
- Python SDK guide
- Dashboard — get your API key
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file idanalyzer2-1.1.2.tar.gz.
File metadata
- Download URL: idanalyzer2-1.1.2.tar.gz
- Upload date:
- Size: 16.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
83f7d3b6fff90f1bdb18f7c576ae52b45a7b83b6b69195e62ea2d28cceefc2cc
|
|
| MD5 |
6e824fd0feea717d22a3a0d89d830a1a
|
|
| BLAKE2b-256 |
cf914466c1565d5cd37641ca88da4f179463c2d579e7ce9e1887cf93c14129a5
|
Provenance
The following attestation bundles were made for idanalyzer2-1.1.2.tar.gz:
Publisher:
publish.yml on idanalyzer/id-analyzer-v2-python
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
idanalyzer2-1.1.2.tar.gz -
Subject digest:
83f7d3b6fff90f1bdb18f7c576ae52b45a7b83b6b69195e62ea2d28cceefc2cc - Sigstore transparency entry: 1708989051
- Sigstore integration time:
-
Permalink:
idanalyzer/id-analyzer-v2-python@ccb7db790c2dd2dddbac970fd1bbb228513e8c55 -
Branch / Tag:
refs/tags/v1.1.2 - Owner: https://github.com/idanalyzer
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@ccb7db790c2dd2dddbac970fd1bbb228513e8c55 -
Trigger Event:
push
-
Statement type:
File details
Details for the file idanalyzer2-1.1.2-py3-none-any.whl.
File metadata
- Download URL: idanalyzer2-1.1.2-py3-none-any.whl
- Upload date:
- Size: 14.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
dc7b6e48998d7bc527b03131a6bc24b3c86b1f28906f59c07416fc9c02ff791f
|
|
| MD5 |
8261c6cda74b41c923e7ab3145003e09
|
|
| BLAKE2b-256 |
cd1f95804a454dd01ddeb4a20c67aa93c82e13e6d42359dcfdd20aae04c31c79
|
Provenance
The following attestation bundles were made for idanalyzer2-1.1.2-py3-none-any.whl:
Publisher:
publish.yml on idanalyzer/id-analyzer-v2-python
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
idanalyzer2-1.1.2-py3-none-any.whl -
Subject digest:
dc7b6e48998d7bc527b03131a6bc24b3c86b1f28906f59c07416fc9c02ff791f - Sigstore transparency entry: 1708989068
- Sigstore integration time:
-
Permalink:
idanalyzer/id-analyzer-v2-python@ccb7db790c2dd2dddbac970fd1bbb228513e8c55 -
Branch / Tag:
refs/tags/v1.1.2 - Owner: https://github.com/idanalyzer
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@ccb7db790c2dd2dddbac970fd1bbb228513e8c55 -
Trigger Event:
push
-
Statement type: