API

Twórz zlecenia weryfikacji z własnych systemów, wysyłaj kontrahentowi link do podpisu i pobieraj certyfikat, gdy podpisze. Po stronie kontrahenta nic się nie zmienia: otwiera link i podpisuje jedną wiadomość, bez konta.

Dostęp do API jest zawarty w planach Pro i Business. Utwórz klucz w sekcji Konto → Klucze API.

Uwierzytelnianie

Przesyłaj klucz jako bearer token w każdym wywołaniu. Klucze są wyświetlane tylko raz, przy tworzeniu; przechowujemy wyłącznie ich hash.

Authorization: Bearer signet_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Bazowy URL: https://basignet.com/api/v1. Opis czytelny maszynowo znajduje się pod /api/v1/openapi.json.

Tworzenie zlecenia

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"
  }'

Wymagane jest tylko chain. Pozostaw targetAddress puste, aby kontrahent sam podał adres, którym podpisuje; ustaw je, aby wymagać dokładnie tego adresu.

anchor: true zakotwicza certyfikat on-chain po podpisaniu i w tym momencie wlicza się do Twojego miesięcznego limitu. messageLocale ustawia język domyślnej wiadomości (zob. Sieci i języki); message zastępuje jej treść Twoim tekstem. Stopka Nonce / Issued / Domain jest zawsze dołączana.

Odpowiedzią jest obiekt zlecenia. Wyślij signingUrl kontrahentowi własnym kanałem.

Pobieranie zlecenia

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

Zwraca obiekt zlecenia. status przyjmuje wartość pending, failed (ostatni podpis nie przeszedł weryfikacji; link nadal działa), verified lub expired. Po weryfikacji pole certificate jest wypełnione.

Lista zleceń

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 najnowszych. limit wynosi od 1 do 100 (domyślnie 20), status filtruje, a before przyjmuje wartość nextBefore z poprzedniej strony.

Certyfikat

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

Samodzielny pakiet dowodowy w formacie JSON lub PDF z ?format=pdf. Zwraca 409, dopóki zlecenie nie zostanie podpisane. Pakiet można zweryfikować bez nas, za pomocą weryfikatora open source.

Sieci i języki

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

Publiczne, bez klucza: obsługiwane sieci (użyj id jako chain) i języki dostępne dla messageLocale.

Webhooki

Ustaw endpoint w sekcji Konto → Webhooki, aby otrzymywać POST przez HTTPS zamiast odpytywać API:

request.verified: kontrahent podpisał, a certyfikat został wystawiony.
request.anchored: certyfikat został zakotwiczony on-chain (tylko dla zleceń utworzonych z anchor).
ping: zdarzenie testowe wysłane ze strony konta.

Treść to { id, type, created, data: { request } }, gdzie request to ten sam obiekt, który zwraca API. Odpowiedz dowolnym kodem 2xx w ciągu 5 sekund. Nieudane doręczenia są ponawiane po 1 minucie, 5 minutach, 30 minutach, 2, 6, 12 i 24 godzinach, a następnie oznaczane jako nieudane. Używaj id, aby ignorować duplikaty.

Każdy POST zawiera Signet-Signature: t=…,v1=…: v1 to szesnastkowy HMAC-SHA256 z t + "." + raw body obliczony sekretem podpisującym Twojego endpointu. Sprawdzaj go na surowej treści, przed parsowaniem, i odrzucaj znaczniki czasu starsze niż kilka minut:

// 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)

Błędy i limity

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

Błędy są zwracane jako JSON: { "error": { "type", "message" } }. Typy: unauthorized (401), plan_required (403), not_found (404, także dla tokenu innego konta), conflict (409), invalid_request (400), rate_limited (429, z Retry-After).

Każdy klucz może wykonać 120 wywołań na minutę.

Obiekt zlecenia

{
  "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
    }
  }
}

W ramach v1 mogą pojawiać się nowe pola; istniejącym polom nie zmienia się nazw ani się ich nie usuwa.