Skip to content

Referência API do Registry

URL base: https://api.biologicalsovereigntyprotocol.com

A Registry API é um relayer gasless. Ela verifica assinaturas Ed25519 e retransmite transações para o Arweave, pagando o gas em nome dos usuários. Não pode forjar nem modificar ações do usuário.

Toda operação de escrita requer payload assinado com nonce (16+ caracteres) e timestamp (ISO8601, máx 5 min de idade).


Operações de BEO

Todas as rotas em POST /api/relayer/beo/...

RotaDescriçãoAuth
POST /api/relayer/beoCriar novo BEOAssinatura Ed25519
POST /api/relayer/beo/lockTravamento de emergênciaAssinatura Ed25519
POST /api/relayer/beo/unlockDestravarAssinatura Ed25519
POST /api/relayer/beo/destroyApagamento permanente (LGPD/GDPR)Assinatura Ed25519
POST /api/relayer/beo/rotate-keyRotacionar chave Ed25519Assinatura Ed25519
POST /api/relayer/beo/recoveryAtualizar configuração de recoveryAssinatura Ed25519
POST /api/relayer/beo/request-recoveryIniciar Social RecoveryPúblico
POST /api/relayer/beo/revoke-allRevogar todos os tokens de um BEOAssinatura Ed25519
POST /api/relayer/consentConceder ConsentTokenAssinatura Ed25519

Formato de payload (exemplo: createBEO)

json
{
  "domain": "andre.bsp",
  "publicKey": "ed25519-hex-64-chars",
  "recovery": null,
  "signature": "base64-ed25519-detached-signature",
  "nonce": "random-16-chars-min",
  "timestamp": "2026-04-07T20:00:00.000Z"
}

A signature é computada sobre: JSON.stringify(sortedKeys({ function: "createBEO", domain, publicKey, recovery, nonce, timestamp })).


Operações de IEO

Todas as rotas em POST /api/ieo/...

RotaDescriçãoAuth
POST /api/ieoCriar novo IEOAssinatura Ed25519
POST /api/ieo/lockTravamento de emergênciaAssinatura Ed25519
POST /api/ieo/unlockDestravarAssinatura Ed25519
POST /api/ieo/destroyApagamento permanenteAssinatura Ed25519
POST /api/ieo/rotate-keyRotacionar chave Ed25519Assinatura Ed25519
POST /api/ieo/contactsAtualizar endpoint API / webhookAssinatura Ed25519
POST /api/ieo/recoveryAtualizar configuração de recoveryAssinatura Ed25519
POST /api/ieo/approveAprovar proposta de governança (multisig 2-de-3)X-Institute-Key
POST /api/ieo/certificationAtualizar nível de certificação do IEOX-Institute-Key

Operações de Guardian

Todas as rotas em /api/guardian/...

RotaDescriçãoAuth
POST /api/guardian/inviteTitular do BEO convida guardiãoAssinatura Ed25519
GET /api/guardian/accept/:tokenRenderizar página de aceitaçãoPúblico
POST /api/guardian/accept/:tokenGuardião aceita e registra chave pública Ed25519Público
GET /api/guardian/confirm-recovery/:tokenRenderizar confirmação de recoveryPúblico
POST /api/guardian/confirm-recovery/:tokenGuardião confirma recovery (threshold 2-de-3 dispara rotação de chave)Público

Operações de Query (somente leitura)

Sem autenticação — lê estado público no Arweave.

RotaDescrição
GET /api/beos/:beoIdObter BEO por UUID
GET /api/beos/domain/:domainResolver BEO por domínio .bsp
GET /api/ieosListar IEOs (filtros: status, ieoType, certLevel)
GET /api/ieos/:ieoIdObter IEO por UUID
GET /api/ieos/domain/:domainResolver IEO por domínio .bsp
GET /api/ieos/:ieoId/certificationVerificar certificação do IEO
GET /api/consent/:tokenIdVerificar ConsentToken
GET /api/consent/history/:beo_domainHistórico completo de tokens

Revogação de Consentimento

RotaDescriçãoAuth
DELETE /api/consent/:tokenIdRevogar um tokenAssinatura Ed25519
DELETE /api/consent/allRevogar TODOS os tokens (emergência)Assinatura Ed25519
DELETE /api/consent/ieo/:ieo_domainRevogar todos de um IEOAssinatura Ed25519
DELETE /api/consent/intent/:intentRevogar todos por intençãoAssinatura Ed25519

Operações de Exchange

RotaDescriçãoAuth
POST /api/exchange/recordsEnviar BioRecordsConsentToken + Ed25519
GET /api/exchange/recordsLer BioRecordsConsentToken + Ed25519
POST /api/exchange/exportExport soberano de dados (JSON/CSV/FHIR_R4)ConsentToken + Ed25519

Limites de Taxa

Grupo de RotaLimite
Relayer BEO/IEO10 req/min
Leitura de query60 req/min por IP
Escritas de consentimento15 req/min por IP
Submit de exchange10 req/min por IP
Leitura de exchange30 req/min por IP
Export soberano5 req/min por IP
Convite de guardião5 req/min

Health Check

GET /health
→ { "status": "ok", "service": "bsp-registry-api", "version": "1.0.0" }

Referência CLI · Referência SDK · Servidor MCP