# BORA Docs

> A BORA faz autenticação pela palma da mão em catracas de transporte. O BORA ACCESS reconhece a palma offline na catraca e manda um veredito assinado pelo cabo USB ao validador da operadora (o DBD), que decide e abre a catraca. A API BORA é a parte na nuvem: pessoas, consentimento, cadastro da palma, passagens, aparelhos e carteiro.

Esta documentação cobre as 16 operações da prova de conceito. Base URL do sandbox: https://sandbox.api.bora.id (em breve). Autenticação: `Authorization: Bearer bora_test_...`. As rotas internas do aparelho não fazem parte desta referência.

## Documentação

- [Referência da API](https://docs.bora.id/api/): introdução, autenticação, erros, idempotência, paginação e as 16 operações.
- [Build with AI](https://docs.bora.id/ai/): prompt de integração, docs para agentes e credenciais.
- [llms-full.txt](https://docs.bora.id/llms-full.txt): a documentação inteira em um arquivo Markdown.
- [openapi.json](https://docs.bora.id/openapi.json): contrato OpenAPI 3.1 das operações da prova de conceito.
- [prompt.md](https://docs.bora.id/prompt.md): prompt para colar no seu agente de código.
- [skill.md](https://docs.bora.id/skill.md): Agent Skill `bora-api` para agentes de código.

## Introdução

- [Visão geral](https://docs.bora.id/api/#visao-geral)
- [Autenticação](https://docs.bora.id/api/#autenticacao)
- [Erros](https://docs.bora.id/api/#erros)
- [Idempotência](https://docs.bora.id/api/#idempotencia)
- [Paginação](https://docs.bora.id/api/#paginacao)
- [Fluxo básico](https://docs.bora.id/api/#fluxo)
- [Base URL](https://docs.bora.id/api/#base-url)
- [Limites de taxa](https://docs.bora.id/api/#limites)
- [Códigos de erro](https://docs.bora.id/api/#codigos)

## Pessoas

- [Criar pessoa](https://docs.bora.id/api/#createSubject): `POST /v1/subjects`. Cria uma pessoa pelo external_ref.
- [Listar pessoas](https://docs.bora.id/api/#listSubjects): `GET /v1/subjects`. Lista pessoas (ou busca pelo external_ref).
- [Consultar pessoa](https://docs.bora.id/api/#getSubject): `GET /v1/subjects/{subject_id}`. Consulta uma pessoa.
- [Apagar pessoa](https://docs.bora.id/api/#eraseSubject): `DELETE /v1/subjects/{subject_id}`. Apaga a pessoa (LGPD) e devolve recibo assinado.

## Consentimento

- [Registrar consentimento](https://docs.bora.id/api/#grantConsent): `POST /v1/subjects/{subject_id}/consents`. Registra consentimento para uma finalidade.
- [Revogar consentimento](https://docs.bora.id/api/#revokeConsent): `DELETE /v1/subjects/{subject_id}/consents/{purpose}`. Revoga o consentimento de uma finalidade.

## Cadastro

- [Abrir cadastro](https://docs.bora.id/api/#createEnrollmentSession): `POST /v1/enrollment-sessions`. Abre um cadastro de palma.
- [Consultar cadastro](https://docs.bora.id/api/#getEnrollmentSession): `GET /v1/enrollment-sessions/{session_id}`. Consulta o estado de um cadastro.

## Passagens

- [Listar passagens](https://docs.bora.id/api/#listVerdicts): `GET /v1/verdicts`. Log de passagens.
- [Consultar passagem](https://docs.bora.id/api/#getVerdict): `GET /v1/verdicts/{verdict_id}`. Veredito com prova assinada.

## Aparelhos

- [Listar aparelhos](https://docs.bora.id/api/#listDevices): `GET /v1/devices`. Lista os aparelhos do tenant.
- [Revogar aparelho](https://docs.bora.id/api/#revokeDevice): `POST /v1/devices/{device_id}/revoke`. Revoga um aparelho (kill remoto).

## Carteiro

- [Buscar a inbox](https://docs.bora.id/api/#listDeviceInbox): `GET /v1/devices/{device_id}/inbox`. Registros selados para levar ao aparelho.
- [Entregar a outbox](https://docs.bora.id/api/#submitDeviceOutbox): `POST /v1/devices/{device_id}/outbox`. Entrega registros selados que saíram do aparelho.

## Sistema

- [Estado do serviço](https://docs.bora.id/api/#getHealth): `GET /v1/health`. Estado do serviço.
- [Chaves públicas](https://docs.bora.id/api/#listSigningKeys): `GET /v1/keys`. Chaves públicas de assinatura da BORA.