clearbound 0.1.0__py3-none-any.whl

clearbound/__init__.py

@@ -0,0 +1,21 @@
+"""Official Python SDK for the clearbound business verification & KYB API.
+
+https://clearbound.xyz
+"""
+
+from clearbound._client import Client
+from clearbound._errors import (
+    AuthenticationError,
+    ClearboundError,
+    PlanRequiredError,
+)
+
+__version__ = "0.1.0"
+
+__all__ = [
+    "Client",
+    "ClearboundError",
+    "AuthenticationError",
+    "PlanRequiredError",
+    "__version__",
+]

clearbound/_account.py

@@ -0,0 +1,11 @@
+from clearbound._errors import PlanRequiredError
+
+# Mirror of the server-side paid-plan entitlement. While the API is in private
+# preview this is a hard gate: no account has SDK access until its paid flag
+# is live, so every API-touching call refuses before any request is made.
+PAID_FEATURES_ENABLED = False
+
+
+def require_active_plan(feature: str) -> None:
+    if not PAID_FEATURES_ENABLED:
+        raise PlanRequiredError(feature)

clearbound/_cli.py

@@ -0,0 +1,14 @@
+import sys
+
+import clearbound
+
+
+def main() -> int:
+    print(f"clearbound {clearbound.__version__}")
+    print("Python SDK for the clearbound business verification & KYB API.")
+    print("API access requires an active plan — https://clearbound.xyz")
+    return 0
+
+
+if __name__ == "__main__":
+    sys.exit(main())

clearbound/_client.py

@@ -0,0 +1,77 @@
+import os
+from typing import Optional, Sequence
+
+from clearbound import _account
+from clearbound._errors import AuthenticationError
+
+API_BASE = "https://api.clearbound.xyz/v1"
+
+_KEY_PREFIXES = ("sk_test_", "sk_live_")
+
+# Values accepted in Verifications.create(checks=...), per the API docs.
+CHECKS = ("registry", "ubo", "sanctions", "documents", "adverse_media")
+
+
+class Client:
+    """Client for the clearbound API (https://api.clearbound.xyz/v1).
+
+    Reads the API key from ``api_key`` or the ``CLEARBOUND_API_KEY``
+    environment variable. Keys are prefixed ``sk_test_`` (sandbox) or
+    ``sk_live_`` (billed).
+    """
+
+    def __init__(self, api_key: Optional[str] = None):
+        api_key = api_key or os.environ.get("CLEARBOUND_API_KEY")
+        if not api_key:
+            raise AuthenticationError(
+                "No API key provided. Pass api_key=... or set the "
+                "CLEARBOUND_API_KEY environment variable."
+            )
+        if not api_key.startswith(_KEY_PREFIXES):
+            raise AuthenticationError(
+                "Invalid API key: keys start with 'sk_test_' or 'sk_live_'."
+            )
+        self.api_key = api_key
+        self.verifications = Verifications(self)
+        self.monitoring = Monitoring(self)
+
+    @property
+    def is_live(self) -> bool:
+        return self.api_key.startswith("sk_live_")
+
+
+class Verifications:
+    """POST/GET /v1/verifications."""
+
+    def __init__(self, client: Client):
+        self._client = client
+
+    def create(
+        self,
+        legal_name: str,
+        registration_number: Optional[str] = None,
+        country: Optional[str] = None,
+        checks: Sequence[str] = ("registry",),
+        monitoring: bool = False,
+    ) -> dict:
+        _account.require_active_plan("Creating verifications")
+        raise NotImplementedError  # unreachable until the plan gate opens
+
+    def retrieve(self, verification_id: str) -> dict:
+        _account.require_active_plan("Retrieving verifications")
+        raise NotImplementedError
+
+
+class Monitoring:
+    """Continuous-monitoring enrolment and alerts."""
+
+    def __init__(self, client: Client):
+        self._client = client
+
+    def enroll(self, verification_id: str) -> dict:
+        _account.require_active_plan("Continuous monitoring")
+        raise NotImplementedError
+
+    def alerts(self) -> list:
+        _account.require_active_plan("Continuous monitoring")
+        raise NotImplementedError

clearbound/_errors.py

@@ -0,0 +1,17 @@
+class ClearboundError(Exception):
+    """Base class for all clearbound SDK errors."""
+
+
+class AuthenticationError(ClearboundError):
+    """The API key is missing or malformed."""
+
+
+class PlanRequiredError(ClearboundError):
+    """The account does not have a plan with API access enabled."""
+
+    def __init__(self, feature: str):
+        super().__init__(
+            f"{feature} requires an active clearbound plan. API access is not "
+            "enabled for this account yet — visit https://clearbound.xyz to "
+            "activate a plan."
+        )

clearbound-0.1.0.dist-info/METADATA

@@ -0,0 +1,62 @@
+Metadata-Version: 2.4
+Name: clearbound
+Version: 0.1.0
+Summary: Official Python SDK for the clearbound business verification & KYB API.
+Author: clearbound
+License: Proprietary
+Project-URL: Homepage, https://clearbound.xyz
+Project-URL: Documentation, https://clearbound.xyz/documentation.html
+Keywords: kyb,business verification,beneficial ownership,sanctions screening,compliance
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: Other/Proprietary License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Office/Business :: Financial
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+
+# clearbound
+
+Official Python SDK for the [clearbound](https://clearbound.xyz) business
+verification & KYB API: registry checks, beneficial ownership (UBO), sanctions
+and PEP screening, document review, and continuous monitoring — one API, one
+auditable decision.
+
+## Installation
+
+```bash
+pip install clearbound
+```
+
+Requires Python 3.9+. No third-party dependencies.
+
+## Usage
+
+```python
+import clearbound
+
+client = clearbound.Client(api_key="sk_test_...")  # or set CLEARBOUND_API_KEY
+
+verification = client.verifications.create(
+    legal_name="Northwind Ventures LLC",
+    registration_number="DE-7421199",
+    country="US",
+    checks=["registry", "ubo", "sanctions", "documents"],
+)
+```
+
+## Plan required
+
+API access is available on paid clearbound plans. Until a plan is active on
+your account, every API call raises `clearbound.PlanRequiredError`:
+
+```python
+try:
+    client.verifications.create(legal_name="Northwind Ventures LLC")
+except clearbound.PlanRequiredError as err:
+    print(err)  # Creating verifications requires an active clearbound plan...
+```
+
+Visit [clearbound.xyz](https://clearbound.xyz) to activate a plan, or see the
+[API documentation](https://clearbound.xyz/documentation.html).

clearbound-0.1.0.dist-info/RECORD

@@ -0,0 +1,10 @@
+clearbound/__init__.py,sha256=uu3kXxrvi71o25mmJTUjBqrwWV8ecb64sut73U453y4,392
+clearbound/_account.py,sha256=6sPI3_K0m1EHHCCmHvbj6lpWa7Wa359bENyR9-CcZBE,434
+clearbound/_cli.py,sha256=j2fgzGv2IVuKFebNWpEQuZ26eHqBmUr6NkDqr0hydi4,315
+clearbound/_client.py,sha256=c0sZY6AeXsjXuwj4NHL4P5esIqO4IJVrXMmetKN9Pi0,2438
+clearbound/_errors.py,sha256=ox2U0M0f6xXEtdDehrTl3fklTce-4OJFCyXzIwmxOdQ,557
+clearbound-0.1.0.dist-info/METADATA,sha256=ukzC7OBJ4bP3W8Sj_PnYXr3Sn5kgTd9djwrmR982AuE,1948
+clearbound-0.1.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+clearbound-0.1.0.dist-info/entry_points.txt,sha256=kZmzKPEFHaIDeCODh9PAITYq9RbqiEZOjFD45DE0K94,52
+clearbound-0.1.0.dist-info/top_level.txt,sha256=rNxDWdDSPbKnJn94htrPKq6ScRY4DhNUb_XuM6zhuwI,11
+clearbound-0.1.0.dist-info/RECORD,,

clearbound-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

clearbound-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+clearbound = clearbound._cli:main

clearbound-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+clearbound