API

Autenticação

Envie a sua chave como bearer token em cada chamada. As chaves são apresentadas uma única vez, na criação; guardamos apenas um hash.

Authorization: Bearer signet_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

URL base: https://basignet.com/api/v1. Existe uma descrição legível por máquina em /api/v1/openapi.json.

Criar um pedido

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

Apenas chain é obrigatório. Deixe targetAddress vazio para que a contraparte indique o endereço com que assina; preencha-o para exigir exatamente esse endereço.

anchor: true ancora o certificado on-chain depois de assinado, sendo descontado da sua quota mensal nesse momento. messageLocale define o idioma da mensagem predefinida (ver Blockchains e idiomas); message substitui o corpo pelo seu próprio texto. O rodapé Nonce / Issued / Domain é sempre acrescentado.

A resposta é o objeto pedido. Envie signingUrl à sua contraparte pelo seu próprio canal.

Obter um pedido

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

Devolve o objeto pedido. status é pending, failed (a última assinatura não foi verificada; a ligação continua utilizável), verified ou expired. Depois da verificação, certificate fica preenchido.

Listar pedidos

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

Os mais recentes primeiro. limit vai de 1 a 100 (predefinição 20), status filtra e before recebe o valor nextBefore da página anterior.

Certificado

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

O pacote de prova autónomo em JSON, ou o PDF com ?format=pdf. Responde 409 até o pedido estar assinado. O pacote verifica-se sem nós, com o verificador de código aberto.

Blockchains e idiomas

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

Público, sem chave: as blockchains suportadas (use o id como chain) e os idiomas disponíveis para messageLocale.

Webhooks

Configure um endpoint em Conta → Webhooks para receber um POST HTTPS em vez de consultar periodicamente:

• request.verified: a contraparte assinou e o certificado foi emitido.
• request.anchored: o certificado foi ancorado on-chain (apenas para pedidos criados com anchor).
• ping: o evento de teste enviado a partir da página da conta.

O corpo é { id, type, created, data: { request } }, em que request é o mesmo objeto devolvido pela API. Responda com qualquer 2xx no prazo de 5 segundos. As entregas falhadas são repetidas após 1 minuto, 5 minutos, 30 minutos, 2, 6, 12 e 24 horas e depois marcadas como falhadas. Use id para ignorar duplicados.

Cada POST inclui Signet-Signature: t=…,v1=…: v1 é o HMAC-SHA256 em hexadecimal de t + "." + raw body com o segredo de assinatura do seu endpoint. Verifique-o sobre o corpo em bruto, antes do parsing, e rejeite carimbos temporais com mais de alguns minutos:

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

Erros e limites

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

Os erros são JSON: { "error": { "type", "message" } }. Tipos: unauthorized (401), plan_required (403), not_found (404, também para o token de outra conta), conflict (409), invalid_request (400), rate_limited (429, com Retry-After).

Cada chave pode fazer 120 chamadas por minuto.

O objeto pedido

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

Podem ser acrescentados campos dentro da v1; os existentes não são renomeados nem removidos.