Documentação da API FraterTrust

Base URL

https://fratertrust.fratertech.com.br

Primeiros passos

Gere uma chave na área autenticada, guarde o segredo em um cofre de variáveis e envie-o no cabeçalho de cada requisição. Chaves podem ser revogadas a qualquer momento sem afetar as registros já emitidos.

Gere a chave

Crie uma chave live em API & integrações.

Proteja o segredo

O valor completo é exibido somente uma vez.

Faça a chamada

Envie e receba JSON com Content-Type correto.

Escopo atual da API v1

Estes endpoints automatizam registros estruturados, status e revogação. O upload do PDF original e a geração da versão final selada são realizados na área autenticada enquanto o contrato multipart da API é preparado.

Segurança

Autenticação e escopos

Use o esquema Bearer. A plataforma armazena somente o hash SHA-256 da chave e valida organização, status e escopo antes de executar a operação.

Cabeçalho HTTP

Authorization: Bearer ft_live_SUA_CHAVE

Escopos disponíveis

credentials:write
credentials:read
credentials:revoke

POST/v1/credentials

Emitir um registro verificável

Cria o registro estruturado na organização vinculada à chave, registra a prova de integridade e devolve a URL pública de verificação.

Escopo: credentials:write

Corpo da requisição

{
  "template": "membership",
  "holder": {
    "name": "Fernanda Alves",
    "identifier": "MEMBRO-1048"
  },
  "purpose": "Comprovar vínculo institucional ativo.",
  "expiresAt": "2027-12-31T23:59:59-03:00",
  "attributes": [
    { "label": "Unidade", "value": "Sede" }
  ]
}

201 Created

{
  "id": "FT-2026-7E26A4F9183B4C10",
  "type": "Vínculo institucional",
  "status": "valid",
  "holder": {
    "name": "Fernanda Alves",
    "identifierMasked": "Documento ••••1048"
  },
  "proof": {
    "method": "sha256",
    "documentHash": "sha256:..."
  },
  "verificationUrl": "https://fratertrust.fratertech.com.br/verificar/..."
}

GET/v1/credentials/{code}

Consultar um registro verificável

Retorna um registro pertencente à organização autenticada. O identificador do titular permanece mascarado na resposta.

Escopo: credentials:read

cURL

curl --request GET \
  --url https://fratertrust.fratertech.com.br/v1/credentials/FT-2026-7E26A4F9183B4C10 \
  --header 'Authorization: Bearer ft_live_SUA_CHAVE'

POST/v1/credentials/{code}/revoke

Revogar um registro verificável

Altera o status de forma imediata, registra o motivo e preserva o evento na trilha de auditoria da organização.

Escopo: credentials:revoke

Corpo da requisição

{
  "reason": "Vínculo institucional encerrado."
}

200 OK

{
  "id": "FT-2026-7E26A4F9183B4C10",
  "status": "revoked",
  "revoked": true
}

Operação

Saúde e contrato OpenAPI

GET/v1/health

Confirma disponibilidade e versão da API.

GET/v1/openapi.json

Contrato OpenAPI 3.1 legível por ferramentas.

Respostas

Erros HTTP

Código	Situação	Ação recomendada
400	Payload ou parâmetro inválido	Revise os campos informados.
401	Chave ausente, revogada ou sem escopo	Confira o Bearer token e os escopos.
404	Registro não localizado	Confira o código e a organização da chave.
500	Falha inesperada	Registre o horário e contate o suporte.

Pronto para integrar

Gere uma chave e faça sua primeira emissão.

O registro criado pela API aparece imediatamente no painel e na trilha de auditoria.

Acessar integrações