API

Vytvárajte žiadosti o overenie z vlastných systémov, pošlite protistrane odkaz na podpis a získajte certifikát, keď podpíše. Pre protistranu sa nič nemení: otvorí odkaz a podpíše jedinú správu, bez účtu.

Prístup k API je súčasťou plánov Pro a Business. Kľúč vytvoríte v sekcii Účet → API kľúče.

Autentifikácia

Kľúč posielajte pri každom volaní ako bearer token. Kľúče sa zobrazia iba raz pri vytvorení; ukladáme iba ich hash.

Authorization: Bearer signet_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Základná URL: https://basignet.com/api/v1. Strojovo čitateľný popis nájdete na /api/v1/openapi.json.

Vytvorenie žiadosti

curl https://basignet.com/api/v1/requests \
  -H "Authorization: Bearer $SIGNET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "chain": "tron",
    "targetAddress": "TNeiUDQmrGHbsC4oPd8L6dZdxyPQrrWyP2",
    "reference": "KYC-2026-0412",
    "anchor": true,
    "messageLocale": "ru",
    "expiresAt": "2026-10-31T23:59:59Z"
  }'

Povinné je iba chain. Nechajte targetAddress prázdne, aby protistrana sama zadala adresu, ktorou podpisuje; vyplňte ho, ak chcete vyžadovať presne túto adresu.

anchor: true po podpísaní ukotví certifikát on-chain a v tej chvíli sa započíta do vašej mesačnej kvóty. messageLocale nastavuje jazyk predvolenej správy (pozri Blockchainy a jazyky); message nahradí jej text vaším vlastným. Päta Nonce / Issued / Domain sa pripojí vždy.

Odpoveďou je objekt žiadosti. signingUrl pošlite protistrane vlastným kanálom.

Získanie žiadosti

curl https://basignet.com/api/v1/requests/{token} \
  -H "Authorization: Bearer $SIGNET_KEY"

Vracia objekt žiadosti. status je pending, failed (posledný podpis sa nepodarilo overiť; odkaz zostáva použiteľný), verified alebo expired. Po overení je vyplnené certificate.

Zoznam žiadostí

curl "https://basignet.com/api/v1/requests?status=verified&limit=50" \
  -H "Authorization: Bearer $SIGNET_KEY"

{ "object": "list", "data": [ …requests ], "hasMore": true, "nextBefore": "2026-09-30T10:12:03.117Z" }

Od najnovších. limit je 1 až 100 (predvolene 20), status filtruje a before prijíma hodnotu nextBefore z predchádzajúcej stránky.

Certifikát

curl https://basignet.com/api/v1/requests/{token}/certificate \
  -H "Authorization: Bearer $SIGNET_KEY" -o proof.json

curl "https://basignet.com/api/v1/requests/{token}/certificate?format=pdf" \
  -H "Authorization: Bearer $SIGNET_KEY" -o certificate.pdf

Samostatný balík dôkazu ako JSON alebo PDF s ?format=pdf. Kým žiadosť nie je podpísaná, vracia 409. Balík možno overiť bez nás, pomocou open-source overovača.

Blockchainy a jazyky

curl https://basignet.com/api/v1/chains

Verejné, bez kľúča: podporované blockchainy (ako chain použite id) a jazyky dostupné pre messageLocale.

Webhooky

Nastavte endpoint v sekcii Účet → Webhooky a namiesto dopytovania budete dostávať HTTPS POST:

Telo je { id, type, created, data: { request } }, kde request je rovnaký objekt, aký vracia API. Odpovedzte ľubovoľným kódom 2xx do 5 sekúnd. Neúspešné doručenia sa opakujú po 1 minúte, 5 minútach, 30 minútach, 2, 6, 12 a 24 hodinách, potom sa označia ako neúspešné. Pomocou id ignorujte duplikáty.

Každý POST obsahuje Signet-Signature: t=…,v1=…: v1 je hexadecimálny HMAC-SHA256 z t + "." + raw body s podpisovým tajomstvom vášho endpointu. Overte ho na nespracovanom tele, pred parsovaním, a odmietnite časové pečiatky staršie ako niekoľko minút:

// Node.js
import { createHmac, timingSafeEqual } from "node:crypto";

function verifySignet(rawBody, header, secret, toleranceSec = 300) {
  const { t, v1 } = Object.fromEntries(header.split(",").map((kv) => kv.split("=")));
  if (!t || !v1 || Math.abs(Date.now() / 1000 - Number(t)) > toleranceSec) return false;
  const expected = createHmac("sha256", secret).update(`${t}.${rawBody}`).digest();
  const given = Buffer.from(v1, "hex");
  return given.length === expected.length && timingSafeEqual(given, expected);
}
# Python
import hmac, hashlib, time

def verify_signet(raw_body: bytes, header: str, secret: str, tolerance: int = 300) -> bool:
    parts = dict(kv.split("=", 1) for kv in header.split(","))
    t, v1 = parts.get("t"), parts.get("v1")
    if not t or not v1 or abs(time.time() - int(t)) > tolerance:
        return False
    expected = hmac.new(secret.encode(), f"{t}.".encode() + raw_body, hashlib.sha256).hexdigest()
    return hmac.compare_digest(expected, v1)

Chyby a limity

HTTP/1.1 403
{ "error": { "type": "plan_required", "message": "API access is included in the Pro and Business plans." } }

Chyby sú vo formáte JSON: { "error": { "type", "message" } }. Typy: unauthorized (401), plan_required (403), not_found (404, aj pre token iného účtu), conflict (409), invalid_request (400), rate_limited (429, s Retry-After).

Každý kľúč môže vykonať 120 volaní za minútu.

Objekt žiadosti

{
  "object": "request",
  "token": "q0tHA2UW6oiuuzVC1qtIf2N1dgKX6miW",
  "status": "verified",                      // pending | failed | verified | expired
  "chain": "ethereum",
  "chainLabel": "Ethereum",
  "targetAddress": null,                     // null = supplied by the signer
  "reference": "KYC-2026-0412",
  "anchor": true,
  "signingUrl": "https://basignet.com/s/q0tHA2UW6oiuuzVC1qtIf2N1dgKX6miW",
  "challenge": "BA Signet — Proof of Wallet Control\n…\nNonce: …\nIssued: …\nDomain: basignet.com",
  "createdAt": "2026-09-30T09:58:41.201Z",
  "expiresAt": null,
  "completedAt": "2026-09-30T10:03:12.554Z",
  "certificate": {                           // null until signed
    "address": "0x5e3fbf618ef1cc1cc021e7fed95e07c6ff334ca8",
    "sigType": "eip191",
    "contentHash": "0xaa00c6f6…",
    "verifiedAt": "2026-09-30T10:03:12.554Z",
    "verifyUrl": "https://basignet.com/verify/0xaa00c6f6…",
    "anchorStatus": "anchored",              // unanchored | pending | anchored
    "anchor": {                              // null until anchored
      "chain": "polygon",
      "txHash": "0x…",
      "txUrl": "https://polygonscan.com/tx/0x…",
      "blockNumber": 94660444,
      "blockTime": "2026-09-29T15:30:06.000Z",
      "merkleRoot": "0x…",
      "bitcoinBlockHeight": null
    }
  }
}

V rámci v1 môžu pribúdať polia; existujúce sa nepremenúvajú ani neodstraňujú.