Guides

Smart Documents and variables

Smart Documents generate the PDF for you: a blueprint is contract text with typed variables, and a package bundles several blueprints that share the same variables and signers.

Blueprints and packages are built and generated in the sign.yt app; they are not part of the API-key surface yet. Documents they produce are ordinary documents: you can read them, download them and receive their webhooks through the API. The company lookup below is available to API keys.

Concepts#

Blueprint: contract body with placeholders, a variables schema, up to 3 signature slots, optional header and footer text, and a language (pl, en, de, uk, es). Blueprints can be written in the app, installed from starters or imported from a DOCX file.
Variables: up to 300 per blueprint, with dotted keys such as client.nip. Types: text, textarea, number, money, percent, date, email, phone, nip, regon, pesel, iban, select, boolean, list. Values are validated by type (for example checksum validation for Polish tax and ID numbers); variables can also be computed from expressions and carry labels in several languages.
Package: 1-20 blueprints generated together, with up to 10 signer roles mapped to variables (name, email, phone) and default values.
Signer intake: a signer can be asked to fill in their own details (for example their company data) and upload attachments on a start form before signing; the submitted data is kept as evidence.

Company lookup (API)#

GET /lookup/company?nip=<NIP> (documents:read) returns Polish company data from the Ministry of Finance VAT whitelist, useful to pre-fill counterparty data or metadata before creating a document. Results are cached for 24 hours; lookups share a budget of 30 per minute per organization (429 with Retry-After: 60).

curl -sS "https://api.sign.yt/v1/lookup/company?nip=5260250274" \
  -H "Authorization: Bearer $SIGNYT_API_KEY"

import os
import httpx

resp = httpx.get(
    "https://api.sign.yt/v1/lookup/company",
    params={"nip": "5260250274"},
    headers={"Authorization": f"Bearer {os.environ['SIGNYT_API_KEY']}"},
)
resp.raise_for_status()
print(resp.json()["name"])

const res = await fetch("https://api.sign.yt/v1/lookup/company?nip=5260250274", {
  headers: { Authorization: `Bearer ${process.env.SIGNYT_API_KEY}` },
});
console.log((await res.json()).name);

Response fields: nip, name, status (VAT status), regon, krs, working_address, residence_address, representatives, authorized_clerks. In the app, smart document forms additionally merge data from the GUS REGON registry and the EU VIES service.

Template catalog#

For simple, PDF-based templates the API exposes a built-in catalog of common agreement types with suggested roles and fields: see Templates.