Metadata-Version: 2.4
Name: easyid-python
Version: 1.0.4
Summary: Official Python SDK for the EasyID identity verification API.
Project-URL: Homepage, https://github.com/easyid-com-cn/easyid-python
Project-URL: Repository, https://github.com/easyid-com-cn/easyid-python
Project-URL: Documentation, https://www.easyid.com.cn
Author: EasyID Team
License: MIT
License-File: LICENSE
Keywords: easyid,identity,kyc,risk,verification
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.9
Requires-Dist: requests<3,>=2.31.0
Provides-Extra: test
Requires-Dist: pytest<9,>=8; extra == 'test'
Description-Content-Type: text/markdown

# EasyID Python SDK

Official Python SDK for the EasyID identity verification API.

EasyID 易验云 focuses on identity verification and security risk control APIs, including real-name verification, liveness detection, face recognition, phone verification, and fraud-risk related capabilities.

中文文档： [README.zh-CN.md](README.zh-CN.md)

## Install

```bash
pip install easyid-python
```

## Quick Start

```python
from easyid import EasyID

client = EasyID("ak_xxx", "sk_xxx")
result = client.idcard.verify2(name="张三", id_number="110101199001011234")

print(result.match)
```

## Supported APIs

- IDCard: `verify2`, `verify3`, `ocr`
- Phone: `status`, `verify3`
- Face: `liveness`, `compare`, `verify`
- Bank: `verify4`
- Risk: `score`, `store_fingerprint`
- Billing: `balance`, `records`

## Configuration

- `base_url`
- `timeout`
- `session`

## Error Handling

Service-side business errors raise `APIError`.

```python
from easyid import APIError

try:
    client.phone.status(phone="13800138000")
except APIError as exc:
    print(exc.code, exc.message, exc.request_id)
```

## Security Notice

This is a server-side SDK. Never expose `secret` in browsers, mobile apps, or other untrusted clients.

## Official Resources

- Official website: `https://www.easyid.com.cn/`
- GitHub organization: `https://github.com/easyid-com-cn/`
