> For the complete documentation index, see [llms.txt](https://docs.giro.tech/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.giro.tech/desenvolvedores/api-gtfgts/api-reference.md).

# API Reference

Referência completa dos endpoints da API GTFgts, organizada por recurso. Todos os endpoints estão sob `/api/v1/**` e exigem `Authorization: Bearer {originatorToken}`.

### Operações FGTS

* [Operações FGTS](https://docs.giro.tech/desenvolvedores/api-gtfgts/api-reference/operacoes-fgts.md) — submissão assíncrona de averbação, retentativa de averbação recusada, manutenção de garantia, cancelamento de reserva e consultas (saldo, valor reservado, protocolos), além do polling de status por `requestId`, do cancelamento da operação por `requestId` e da consulta de protocolo na Caixa.

### Simulações

* [Simulações](https://docs.giro.tech/desenvolvedores/api-gtfgts/api-reference/simulacoes.md) — simulação de empréstimo com garantia FGTS e consulta da simulação por id.

### Contratos (Formalização)

* [Contratos](https://docs.giro.tech/desenvolvedores/api-gtfgts/api-reference/contratos.md) — submissão de contratos (CCB) de empréstimo com garantia FGTS para formalização: averbação na Caixa, envio ao provedor e acompanhamento de pagamento. Inclui retentativa de averbação recusada, cancelamento durante formalização, encerramento de contrato vigente, revisão de conta de desembolso e download da CCB. A submissão é síncrona (`201` com `contractNumber`); os marcos seguintes chegam por [webhook](https://docs.giro.tech/desenvolvedores/api-gtfgts/webhooks/eventos.md) (`source = CONTRACT`) ou polling.

### Configuração

* [Cadastro de Webhook](https://docs.giro.tech/desenvolvedores/api-gtfgts/api-reference/cadastro-webhook.md) — CRUD do cadastro de webhook escopado ao originator (URL de callback, header de autenticação e filtro de eventos).

{% hint style="info" %}
**Operações são assíncronas.** A submissão retorna `202 Accepted` com um `requestId`; o resultado chega por [webhook](https://docs.giro.tech/desenvolvedores/api-gtfgts/webhooks.md) ou por [polling](https://docs.giro.tech/desenvolvedores/api-gtfgts/api-reference/operacoes-fgts/acompanhar-resultado/consultar-status-operacao.md). Entenda o ciclo completo em [Fluxo assíncrono e polling](https://docs.giro.tech/desenvolvedores/api-gtfgts/guias/fluxo-assincrono-e-polling.md).
{% endhint %}
