API

Opret verifikationsanmodninger fra dine egne systemer, send underskriftslinket til din modpart, og hent certifikatet, når modparten underskriver. For modparten ændrer intet sig: de åbner linket og underskriver én besked, uden konto.

API-adgang er inkluderet i Pro og Business. Opret en nøgle under Konto → API-nøgler.

Godkendelse

Send din nøgle som bearer-token ved hvert kald. Nøgler vises én gang, når de oprettes; vi gemmer kun en hash.

Authorization: Bearer signet_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Basis-URL: https://basignet.com/api/v1. En maskinlæsbar beskrivelse findes på /api/v1/openapi.json.

Opret en anmodning

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

Kun chain er påkrævet. Lad targetAddress være tom for at lade modparten angive den adresse, de underskriver med; udfyld den for at kræve præcis den adresse.

anchor: true forankrer certifikatet on-chain, når der er underskrevet, og tæller mod din månedlige kvote på det tidspunkt. messageLocale angiver sproget for standardbeskeden (se Blockchains og sprog); message erstatter dens brødtekst med din egen tekst. Sidefoden Nonce / Issued / Domain tilføjes altid.

Svaret er anmodningsobjektet. Send signingUrl til din modpart via din egen kanal.

Hent en anmodning

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

Returnerer anmodningsobjektet. status er pending, failed (den seneste signatur kunne ikke verificeres; linket kan stadig bruges), verified eller expired. Når anmodningen er verificeret, udfyldes certificate.

Vis anmodninger

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

Nyeste først. limit er 1 til 100 (standard 20), status filtrerer, og before tager værdien nextBefore fra den forrige side.

Certifikat

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

Den selvstændige bevispakke som JSON, eller som PDF med ?format=pdf. Den svarer 409, indtil anmodningen er underskrevet. Pakken kan verificeres uden os med open source-verifikatoren.

Blockchains og sprog

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

Offentligt, ingen nøgle nødvendig: de understøttede blockchains (brug id som chain) og de sprog, der er tilgængelige for messageLocale.

Webhooks

Angiv et endpoint under Konto → Webhooks for at modtage en HTTPS POST i stedet for polling:

Brødteksten er { id, type, created, data: { request } }, hvor request er det samme objekt, som API’et returnerer. Svar med en vilkårlig 2xx inden for 5 sekunder. Mislykkede leveringer forsøges igen efter 1 minut, 5 minutter, 30 minutter, 2, 6, 12 og 24 timer og markeres derefter som mislykkede. Brug id til at ignorere dubletter.

Hver POST indeholder Signet-Signature: t=…,v1=…: v1 er den hex-kodede HMAC-SHA256 af t + "." + raw body med dit endpoints signeringshemmelighed. Kontrollér den på den rå brødtekst, før parsing, og afvis tidsstempler, der er ældre end et par minutter:

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

Fejl og grænser

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

Fejl returneres som JSON: { "error": { "type", "message" } }. Typer: unauthorized (401), plan_required (403), not_found (404, også for en anden kontos token), conflict (409), invalid_request (400), rate_limited (429, med Retry-After).

Hver nøgle kan foretage 120 kald i minuttet.

Anmodningsobjektet

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

Felter kan tilføjes inden for v1; eksisterende felter omdøbes eller fjernes ikke.