API

Authentication

Send your key as a bearer token on every call. Keys are shown once when created; we store only a hash.

Authorization: Bearer signet_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Base URL: https://basignet.com/api/v1. A machine-readable description is at /api/v1/openapi.json.

Create a request

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

Only chain is required. Leave targetAddress empty to let the counterparty supply the address they sign with; set it to require that exact address.

anchor: true anchors the certificate on-chain once signed, counted against your monthly quota at that moment. messageLocale sets the language of the default message (see Chains and languages); message replaces its body with your own text. The Nonce / Issued / Domain footer is always appended.

The response is the request object. Send signingUrl to your counterparty through your own channel.

Get a request

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

Returns the request object. status is pending, failed (the last signature did not verify; the link stays usable), verified or expired. Once verified, certificate is filled in.

List requests

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

Newest first. limit is 1 to 100 (default 20), status filters, and before takes the nextBefore value of the previous page.

Certificate

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

The self-contained proof packet as JSON, or the PDF with ?format=pdf. It answers 409 until the request is signed. The packet verifies without us, with the open-source verifier.

Chains and languages

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

Public, no key needed: the supported chains (use the id as chain) and the languages available for messageLocale.

Webhooks

Set an endpoint under Account → Webhooks to receive an HTTPS POST instead of polling:

• request.verified: the counterparty signed and the certificate was issued.
• request.anchored: the certificate was anchored on-chain (only for requests created with anchor).
• ping: the test event from the account page.

The body is { id, type, created, data: { request } }, where request is the same object the API returns. Answer with any 2xx within 5 seconds. Failed deliveries are retried after 1 minute, 5 minutes, 30 minutes, 2, 6, 12 and 24 hours, then marked failed. Use id to ignore duplicates.

Every POST carries Signet-Signature: t=…,v1=…: v1 is the hex HMAC-SHA256 of t + "." + raw body with your endpoint's signing secret. Check it on the raw body, before parsing, and reject timestamps older than a few minutes:

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

Errors and limits

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

Errors are JSON: { "error": { "type", "message" } }. Types: unauthorized (401), plan_required (403), not_found (404, also for another account's token), conflict (409), invalid_request (400), rate_limited (429, with Retry-After).

Each key can make 120 calls per minute.

The request object

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

Fields may be added within v1; existing ones are not renamed or removed.