API

Luo vahvistuspyyntöjä omista järjestelmistäsi, lähetä allekirjoituslinkki vastapuolellesi ja hae sertifikaatti, kun vastapuoli allekirjoittaa. Vastapuolen kannalta mikään ei muutu: hän avaa linkin ja allekirjoittaa yhden viestin ilman tiliä.

API-käyttö sisältyy Pro- ja Business-tilauksiin. Luo avain kohdassa Tili → API-avaimet.

Todennus

Lähetä avaimesi bearer-tunnisteena jokaisessa kutsussa. Avaimet näytetään kerran luonnin yhteydessä; tallennamme vain tiivisteen.

Authorization: Bearer signet_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Perus-URL: https://basignet.com/api/v1. Koneluettava kuvaus on osoitteessa /api/v1/openapi.json.

Pyynnön luominen

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

Vain chain on pakollinen. Jätä targetAddress tyhjäksi, jos vastapuoli saa itse antaa osoitteen, jolla hän allekirjoittaa; täytä se, jos vaaditaan juuri kyseinen osoite.

anchor: true ankkuroi sertifikaatin lohkoketjuun allekirjoituksen jälkeen, ja se lasketaan kuukausikiintiöösi sillä hetkellä. messageLocale määrittää oletusviestin kielen (katso Lohkoketjut ja kielet); message korvaa viestin leipätekstin omalla tekstilläsi. Alatunniste Nonce / Issued / Domain lisätään aina.

Vastaus on pyyntöobjekti. Lähetä signingUrl vastapuolellesi omaa kanavaasi pitkin.

Pyynnön hakeminen

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

Palauttaa pyyntöobjektin. status on pending, failed (viimeisintä allekirjoitusta ei voitu vahvistaa; linkki on yhä käytettävissä), verified tai expired. Kun pyyntö on vahvistettu, certificate täytetään.

Pyyntöjen listaus

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

Uusimmat ensin. limit on välillä 1–100 (oletus 20), status suodattaa, ja before ottaa edellisen sivun nextBefore-arvon.

Sertifikaatti

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

Itsenäinen todistepaketti JSON-muodossa tai PDF-tiedostona parametrilla ?format=pdf. Vastaus on 409, kunnes pyyntö on allekirjoitettu. Paketin voi tarkistaa ilman meitä avoimen lähdekoodin tarkistimella.

Lohkoketjut ja kielet

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

Julkinen, avainta ei tarvita: tuetut lohkoketjut (käytä id-arvoa kentässä chain) ja kielet, jotka ovat käytettävissä kentälle messageLocale.

Webhookit

Määritä päätepiste kohdassa Tili → Webhookit, niin saat HTTPS POST -pyynnön kyselyn sijaan:

Runko on { id, type, created, data: { request } }, jossa request on sama objekti, jonka API palauttaa. Vastaa millä tahansa 2xx-koodilla 5 sekunnin kuluessa. Epäonnistuneet toimitukset yritetään uudelleen 1 minuutin, 5 minuutin, 30 minuutin sekä 2, 6, 12 ja 24 tunnin kuluttua, minkä jälkeen ne merkitään epäonnistuneiksi. Käytä id-arvoa kaksoiskappaleiden ohittamiseen.

Jokainen POST sisältää otsakkeen Signet-Signature: t=…,v1=…: v1 on heksamuotoinen HMAC-SHA256 arvosta t + "." + raw body päätepisteesi allekirjoitussalaisuudella laskettuna. Tarkista se raakarungosta ennen jäsentämistä ja hylkää aikaleimat, jotka ovat muutamaa minuuttia vanhempia:

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

Virheet ja rajat

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

Virheet palautetaan JSON-muodossa: { "error": { "type", "message" } }. Tyypit: unauthorized (401), plan_required (403), not_found (404, myös toisen tilin tunnisteelle), conflict (409), invalid_request (400), rate_limited (429, Retry-After-otsakkeen kanssa).

Kukin avain voi tehdä 120 kutsua minuutissa.

Pyyntöobjekti

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

Kenttiä voidaan lisätä v1:n sisällä; olemassa olevia kenttiä ei nimetä uudelleen eikä poisteta.