Metadata-Version: 2.4
Name: verifiquemos
Version: 0.1.1
Summary: Official Python SDK for the Verifiquemos compliance API
Project-URL: Homepage, https://verifiquemos.gt/developers
Project-URL: Documentation, https://api.verifiquemos.gt/scalar
Project-URL: Repository, https://dev.azure.com/verifiquemos/Verifiquemos/_git/verifiquemos-sdk-python
Project-URL: Changelog, https://dev.azure.com/verifiquemos/Verifiquemos/_git/verifiquemos-sdk-python?path=/CHANGELOG.md
Author-email: Verifiquemos <soporte@verifiquemos.gt>
License-Expression: MIT
License-File: LICENSE
Keywords: api,compliance,guatemala,kyc,ofac,renap,sdk,verifiquemos
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
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.10
Requires-Dist: httpx>=0.27
Requires-Dist: pydantic[email]>=2.7
Requires-Dist: python-ulid>=3.0
Provides-Extra: dev
Requires-Dist: datamodel-code-generator>=0.26; extra == 'dev'
Requires-Dist: mypy>=1.13; extra == 'dev'
Requires-Dist: pytest-asyncio>=0.24; extra == 'dev'
Requires-Dist: pytest>=8.0; extra == 'dev'
Requires-Dist: respx>=0.21; extra == 'dev'
Requires-Dist: ruff>=0.7; extra == 'dev'
Description-Content-Type: text/markdown

# verifiquemos

Official Python SDK for the [Verifiquemos](https://verifiquemos.gt) compliance API.

> KYC, RENAP, OFAC, ONU, Lista Engel, PEP, CPE — Guatemala-specific compliance in one API call.

## Install

```bash
pip install verifiquemos
```

## Quickstart (sync)

```python
from verifiquemos import VerifiquemosClient

with VerifiquemosClient(api_key="vfq_...") as client:
    me = client.auth.me()
    print(me["tenant"]["name"])

    # cui is NOT a parameter — it is extracted from the DPI via OCR.
    with open("dpi.jpg", "rb") as f:
        validation = client.validations.create(
            naturaleza_cliente="individual",
            dpi_file=f.read(),
            pais_origen_fondos="GTM",
        )
    print(f"Validation submitted: {validation['id']}")
```

## Quickstart (async)

```python
import asyncio
from verifiquemos import AsyncVerifiquemosClient

async def main():
    async with AsyncVerifiquemosClient(api_key="vfq_...") as client:
        me = await client.auth.me()
        print(me)

asyncio.run(main())
```

## Error handling

```python
from verifiquemos import ApiError, RateLimitError, NetworkError, VerifiquemosClient

with VerifiquemosClient(api_key="vfq_...") as client:
    try:
        client.validations.create(...)
    except RateLimitError as e:
        print(f"Retry after {e.retry_after_seconds}s")
    except ApiError as e:
        if e.is_payment_required:
            print("Buy more credits")
        else:
            raise
    except NetworkError:
        print("Connection failed")
```

## Configuration

| Argument | Default | Description |
|---|---|---|
| `api_key` | (required) | Server-issued API key. Starts with `vfq_`. |
| `base_url` | `https://api.verifiquemos.gt` | Override for staging/dev. |
| `timeout` | 30.0 | httpx timeout in seconds. |

## Documentation

- API reference: <https://api.verifiquemos.gt/scalar>
- Developer portal: <https://verifiquemos.gt/developers>

## License

MIT
