Skip to main content

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="user@example.com",
        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.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

signupcheck_sdk-0.1.5.tar.gz (65.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

signupcheck_sdk-0.1.5-py3-none-any.whl (177.7 kB view details)

Uploaded Python 3

File details

Details for the file signupcheck_sdk-0.1.5.tar.gz.

File metadata

  • Download URL: signupcheck_sdk-0.1.5.tar.gz
  • Upload date:
  • Size: 65.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.6

File hashes

Hashes for signupcheck_sdk-0.1.5.tar.gz
Algorithm Hash digest
SHA256 999ce36594e07425eb532b3b8975e4ee4c7d74eb448d9436499f74deadb846b9
MD5 50d18c015b37d6eb1ceb4514d14e8e83
BLAKE2b-256 1ea6fb390a6b532a2c81ce51ce609b43808d40be14b99359c3f36da9c9779365

See more details on using hashes here.

File details

Details for the file signupcheck_sdk-0.1.5-py3-none-any.whl.

File metadata

File hashes

Hashes for signupcheck_sdk-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 28c76f466cb1adfe17b63a15b0db8c396d1bab63fe5b1b2eda75e55543fe00c3
MD5 d82a6597e3ea33d3f1d1d276486e139e
BLAKE2b-256 3292c31aa897c0464d1d6e881a067f3c9d8f5284c6b0c0b94c42ea7ba69f02ee

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.1.5 This release

2 files

0.1.4

2 files

0.1.3

2 files

0.1.2

2 files

0.1.1

2 files

0.1.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page