signupcheck-sdk 0.1.4

Python client for the SignupCheck anti-abuse API

signupcheck-sdk

Python client for the SignupCheck anti-abuse API — block disposable emails, VPNs, proxies, bots, and malicious IPs at signup.

Install

pip install signupcheck-sdk

Requires Python 3.9+.

Quick start

import os
import signupcheck
from signupcheck.models.evaluate_signup_request import EvaluateSignupRequest

cfg = signupcheck.Configuration()  # defaults to https://signupcheck.com
# or explicitly: cfg = signupcheck.Configuration(host="https://signupcheck.com")
cfg.api_key["API Key"] = os.environ["SIGNUPCHECK_API_KEY"]

with signupcheck.ApiClient(cfg) as client:
    api = signupcheck.DecisionEngineApi(client)
    resp = api.evaluate_signup(EvaluateSignupRequest(
        email="[e-mail]",
        ip="1.2.3.4",
    ))
    print(resp.decision, resp.risk_score)

The client reads the API key via the X-API-Key header. To use Bearer auth instead:

cfg.api_key["Bearer"] = os.environ["SIGNUPCHECK_API_KEY"]
cfg.api_key_prefix["Bearer"] = "Bearer"

Available APIs

Class	Endpoint prefix	Purpose
DecisionEngineApi	/v1/evaluate/signup	ALLOW / CHALLENGE / BLOCK decision
ChecksApi	/v1/evaluate/{email,ip}	Standalone email / IP risk checks
ListsApi	/v1/lists	Manage allow / block lists
RulesApi	/v1/rules	Manage custom rules
FeedbackApi	/v1/feedback/signup	Submit outcome feedback
ObservabilityApi	/v1/events, /v1/metrics/signup	Query events and metrics
AccountApi	/v1/me	Validate API key (no credit charge)

Development

This package is generated from the OpenAPI spec in the signupcheck API repo. To regenerate after a schema change, run make sdk-python in the API repo.

Important for generation: Ensure the OpenAPI spec declares the production server as https://signupcheck.com (the SDK default). The generator templates default to http://localhost:8000 when no servers are defined in the spec. After generation, verify that py/signupcheck/configuration.py and ts/src/runtime.ts contain the correct default.

Local build and test from this directory:

make build      # python -m build → dist/
make check      # twine check dist/*

License

Proprietary. See the repository for terms.