Skip to main content

issyx-sign

Official Python client for the Issyx Sign e-signature API.

pip install issyx-sign

Requires Python 3.10+.

Authentication

Create an API key from Organization → API keys in the Issyx Sign dashboard (org admin only). API keys are scoped to one organization and bypass per-user permission checks — treat them like a full-access credential for that org.

from issyx_sign import IssyxSignClient

client = IssyxSignClient(
    api_key="issyx_...",
    # base_url defaults to https://app.issyx.com/sign/api -- override for a self-hosted instance
    base_url="https://your-instance.example.com/api",
)

Webhook management (list_webhooks/create_webhook/update_webhook/delete_webhook) runs on session authentication rather than an API key — pass session_cookie= (the value of an issyx_sign_session cookie) instead of api_key= if you need those.

Send a document for signature

with open("contract.pdf", "rb") as f:
    doc = client.upload_document(file=f, filename="contract.pdf", title="Master Services Agreement")

client.add_recipients(doc["id"], [
    {"email": "alice@example.com", "name": "Alice", "recipient_role": "signer", "signing_order": 0},
    {"email": "bob@example.com", "name": "Bob", "recipient_role": "approver", "signing_order": 1},
])

client.send_document(
    doc["id"],
    sender_name="Jordan Sales",  # attributes invite emails to a real person instead of the API caller
    sender_email="jordan@example.com",
)

Check status / download the signed PDF

result = client.get_document(doc["id"])
print(result["document"]["status"], [(r["email"], r["status"]) for r in result["recipients"]])

if result["document"]["status"] == "completed":
    pdf_bytes = client.download_signed_pdf(doc["id"])

Verify a webhook

Every delivery is a POST with body {"event": ..., "payload": ..., "timestamp": ...} (the shape of payload depends on event — e.g. document.completed sends {"documentId": ...}) and an X-Issyx-Signature: sha256=<hex> header.

from issyx_sign import verify_webhook_signature

@app.route("/issyx-webhook", methods=["POST"])
def issyx_webhook():
    raw_body = request.get_data()  # exact, unparsed bytes -- verify before parsing
    if not verify_webhook_signature(raw_body, request.headers.get("X-Issyx-Signature"), subscription_secret):
        return "", 401

    payload = request.get_json()
    # ... handle payload["event"] / payload["payload"]
    return "", 200

Your own ids, safe retries, and canceling

Give an envelope or a recipient a reference (your own id, up to 200 characters) and it comes back on the document and on every webhook event, so you never need to keep a mapping of Issyx ids. A recipient whose reference is already on the document is skipped, so adding the same party twice is harmless.

Upload, add recipients and send also take an idempotency key. Retrying with the same key returns the first successful answer instead of doing the work again, so a request that timed out can be retried without making a second envelope:

with open("contract.pdf", "rb") as f:
    doc = client.upload_document(
        file=f, filename="contract.pdf", title="Master Services Agreement",
        reference="deal-1042", idempotency_key="upload-deal-1042",
    )
client.add_recipients(doc["id"], [{"email": "alice@example.com", "reference": "contact-77"}], idempotency_key="recipients-deal-1042")
client.send_document(doc["id"], idempotency_key="send-deal-1042")

client.remind_document(doc["id"])   # every signer whose turn it is
client.cancel_document(doc["id"])   # withdraw it while it is still open

Error handling

Every non-2xx response raises IssyxSignError with .status, the parsed error .body, and .code when the server gives a machine-readable reason (for example document_not_sendable or document_not_cancelable):

from issyx_sign import IssyxSignError

try:
    client.get_document("does-not-exist")
except IssyxSignError as err:
    if err.status == 404:
        ...

Full method reference

See GET /api/openapi.json on your instance for the canonical API reference. Every client method maps 1:1 to a single REST endpoint:

  • Documents: list_documents, summary, upload_document, get_document, delete_document, add_recipients, send_document, remind_document, cancel_document, download_signed_pdf, get_analytics
  • Templates: list_templates, create_template, use_template, bulk_send_template, get_merge_fields
  • Webhooks (session_cookie only): list_webhooks, create_webhook, update_webhook, delete_webhook

Metadata

Release files for issyx-sign 1.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for issyx-sign 1.0.0
File Size Uploaded Provenance Actions
issyx_sign-1.0.0.tar.gz 8.8 kB Without provenance Details for issyx_sign-1.0.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for issyx-sign 1.0.0
File Interpreter ABI Platform Actions
issyx_sign-1.0.0-py3-none-any.whl Python 3 none any Details for issyx_sign-1.0.0-py3-none-any.whl

Total release size: 17.7 kB

Release files / issyx_sign-1.0.0.tar.gz

Download URL issyx_sign-1.0.0.tar.gz
Size 8.8 kB
Tags Source
SHA-256 checksum
How to use checksums
a198f07894b302431c30d79996b9c61c14d1dc4fad81935d667e290f766f1ec0
BLAKE2b-256 checksum
How to use checksums
e012a02c0815122510bb638cf1982efb6e0e68676e1734dda02ebdb34f821d1c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / issyx_sign-1.0.0-py3-none-any.whl

Download URL issyx_sign-1.0.0-py3-none-any.whl
Size 8.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
4588c7686092ed0632ff35e4af547ec300e39ca1a222afff9ed31b91f425b617
BLAKE2b-256 checksum
How to use checksums
899b846359129aeb4615ed9d62059ddbc4057ef48f3cb6cff8346411c7d6eeea
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Security for issyx-sign 1.0.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.0.0 This release

2 release files No provenance

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