# IORQ Dev Hub Documentation

> Documentação dos fluxos internos e API da IORQ.

## Guides: primeiros-passos
- [Visão geral](https://dev-hub.iorq.com.br/docs/visao-geral.md): A API da IORQ permite que originadores, bancarizadores e plataformas de crédito integrem operações em FIDCs dedicados de forma programática. Cessão, liquidação, recompra e renegociação — todo o ciclo…
- [Ambientes e hosts](https://dev-hub.iorq.com.br/docs/ambientes-e-hosts.md): A IORQ disponibiliza dois ambientes isolados — sandbox para integração, testes e homologação; produção para operações reais. Ambos compartilham a mesma superfície de API. O que muda são URLs base,…
- [Autenticação](https://dev-hub.iorq.com.br/docs/autenticacao.md): A API IORQ usa OAuth 2.0 client_credentials. Você troca um client_id + client_secret por um Bearer JWT com validade de 1 hora e passa o token no header Authorization de cada chamada operacional. Sem…
- [Quickstart](https://dev-hub.iorq.com.br/docs/quickstart.md): Em poucos minutos, sua primeira cessão em sandbox: obtenha um token, registre um webhook v2 e valide a entrega, ceda uma operação CCB com lastro em PDF e receba o evento de aprovação. O que depende…

## Guides: conceitos
- [O que é um FIDC](https://dev-hub.iorq.com.br/docs/o-que-e-um-fidc.md): Um Fundo de Investimento em Direitos Creditórios é o veículo jurídico-financeiro que adquire as operações que você cede via API. Entender quem é quem dentro de um FIDC ajuda a interpretar erros de…
- [Atores da operação](https://dev-hub.iorq.com.br/docs/atores-da-operacao.md): Uma cessão de crédito tem mais partes do que aparece no payload da API. Conhecer cada papel ajuda a interpretar erros (por que esse webhook veio?) e a desenhar sua integração de forma defensiva.
- [Ciclo de vida do direito creditório](https://dev-hub.iorq.com.br/docs/ciclo-de-vida-do-direito-creditorio.md): Da originação à saída terminal, todo direito creditório passa por uma sequência de estados bem definida. Esta página documenta o caminho feliz, os estados intermediários de processamento com a…
- [Critérios de elegibilidade](https://dev-hub.iorq.com.br/docs/criterios-de-elegibilidade.md): Cada FIDC tem regras no seu regulamento sobre quais operações pode adquirir. A IORQ enforça essas regras na cessão — operações que violam são rejeitadas antes de entrar no estoque. Esta página…

## Guides: fluxos-operacionais
- [Cessão de operações](https://dev-hub.iorq.com.br/docs/cessao-de-operacoes.md): Transfira um direito creditório do originador para o <Glossary>FIDC</Glossary>. Este fluxo é agnóstico ao tipo de lastro — funciona para CCB, duplicata, contrato pré-pago e outros. A IORQ valida o…
- [Liquidação](https://dev-hub.iorq.com.br/docs/liquidacao.md): Registre o pagamento (total ou parcial) de uma parcela de uma operação ativa no FIDC. Liquidações podem ser na curva (data prevista), antecipadas (parcela ou contrato inteiro) ou a menor (cliente…
- [Operações pós-cessão](https://dev-hub.iorq.com.br/docs/operacoes-pos-cessao.md): Saídas de operações do fundo fora do fluxo normal de liquidação. Cobre recompra, renegociação e reversão de cessão — cada uma com sua regra de quem paga o fundo e como o ativo é removido da carteira.…
- [Alteração de vencimento](https://dev-hub.iorq.com.br/docs/alteracao-de-vencimento.md): Move a data de vencimento de parcelas em aberto de uma ou mais operações ativas — a data e nada mais —, com o aditamento de cada operação anexado. Única operação síncrona da API: o resultado por…

## Guides: webhooks
- [Configurando webhooks](https://dev-hub.iorq.com.br/docs/configurando-webhooks.md): Registre sua URL, receba o standard_webhooks_secret e valide o primeiro evento. Esta é a página de entrada da seção: o formato dos eventos, a segurança e a reentrega têm páginas próprias, apontadas…
- [Configuração e segurança](https://dev-hub.iorq.com.br/docs/configuracao-e-seguranca.md): Como proteger seu endpoint de webhook: verificação da assinatura Standard Webhooks (webhook-id, webhook-timestamp, webhook-signature), defesa contra replay, headers custom como camada adicional, TLS,…
- [Catálogo de eventos](https://dev-hub.iorq.com.br/docs/catalogo-de-eventos.md): O contrato v2 entrega um evento tipado por fato, com envelope próprio e um type por acontecimento. Esta página lista os tipos, o formato do envelope e o corpo de cada um. O contrato v1 tem página…
- [Tipos de evento em detalhe](https://dev-hub.iorq.com.br/docs/tipos-de-evento.md): Um verbete por tipo de evento: o que aconteceu do lado da IORQ para ele disparar, quem é o sujeito, o que data garante, qual evento vem antes e depois, e o que o seu sistema deve fazer ao receber.
- [Códigos de erro](https://dev-hub.iorq.com.br/docs/codigos-de-erro.md): O catálogo dos códigos que chegam em errors[].code quando uma chamada falha: o que cada um significa, de qual fluxo vem, se vale retentar, e como o mesmo motivo aparece no corpo v1.
- [Contrato v1 (legado)](https://dev-hub.iorq.com.br/docs/contrato-v1-legado.md): O corpo {event, data} que webhooks com contract_version = v1 recebem, com os valores de data.status e os dois campos que a IORQ acrescenta na entrega. Preservado na íntegra; integrações novas devem…
- [Idempotência e reentrega](https://dev-hub.iorq.com.br/docs/idempotencia-e-reentrega.md): A IORQ garante entrega no mínimo uma vez (at-least-once) — não exatamente uma vez. Você pode receber o mesmo evento duas ou mais vezes. Esta página explica por que isso acontece e como construir seu…

## Guides: investidor
- [API do investidor](https://dev-hub.iorq.com.br/docs/api-do-investidor.md): API somente leitura para investidores institucionais acompanharem os covenants e os indicadores dos FIDCs em que têm cotas. Usa a mesma autenticação da API operacional, em um host próprio, com o…
- [Covenants](https://dev-hub.iorq.com.br/docs/covenants.md): Os covenants que a API do investidor publica por fundo: o que cada um mede, a unidade, o limite do regulamento, as datas do dado e os campos da resposta de GET /v1/covenants.
- [Indicadores de acompanhamento](https://dev-hub.iorq.com.br/docs/indicadores-de-acompanhamento.md): O painel corrente do fundo em GET /v1/indicators: patrimônio por classe, PDD sobre o PL, PL médio de 12 meses e duration da carteira, cada um com o valor, a unidade e as datas do dado.
- [Séries históricas e versões de fórmula](https://dev-hub.iorq.com.br/docs/series-historicas.md): Como a IORQ forma a série de cada covenant em GET /v1/covenants/history: um ponto por dia desde o fim de setembro de 2026, pontos mensais antes disso, as datas de cada ponto e como ler a mudança de…
- [Extração de estoque (WIP)](https://dev-hub.iorq.com.br/docs/extracao-de-estoque.md): Pedido assíncrono do estoque de um fundo pela API do investidor: o arquivo CSV, uma linha por parcela, chega por link no e-mail cadastrado da credencial. Rota em estágio inicial.

## Guides: llm
- [Copiar para LLM](https://dev-hub.iorq.com.br/docs/copiar-para-llm.md): Pacotes da documentação em Markdown puro, prontos para colar no Claude, ChatGPT, Cursor ou qualquer assistente. Escolha uma seção ou a documentação completa, copie ou baixe o arquivo. A estimativa de…

## API Reference: IORQ API
- Autenticação
  - [Trocar credenciais por Bearer JWT](https://dev-hub.iorq.com.br/reference/createtoken.md): Fluxo OAuth2 client_credentials (Amazon Cognito). Token válido por 1 hora. Cacheie o token e renove proativamente quando faltar menos de 5 minutos para expirar. As permissões e os fundos acessíveis…
- Cessão
  - [Ceder operação com lastro](https://dev-hub.iorq.com.br/reference/createloan.md): Disponibiliza uma operação de crédito formalizada para aquisição pelo FIDC. Multipart com o campo `loan_data` (JSON serializado) + `files` (PDFs). Aceita até 5 PDFs de lastro (max 2 MB cada); o nome…
  - [Listar operações](https://dev-hub.iorq.com.br/reference/listloans.md): Lista operações com filtros opcionais. Paginação por `page`/`page_size`. Para uma operação específica, prefira `GET /loan/{id_loan}` pelo identificador da IORQ: o filtro `originator_proposal_code`…
  - [Consultar operação por identificador](https://dev-hub.iorq.com.br/reference/getloan.md): Devolve a operação pelo identificador da IORQ, o `data.loan.id` dos webhooks v2. É a consulta exata que a listagem não dá: o filtro por `originator_proposal_code` casa por trecho, sem diferenciar…
  - [Anexar lastro a operação existente](https://dev-hub.iorq.com.br/reference/attachloanfiles.md): Anexa um ou mais arquivos de lastro a uma operação já criada via `POST /loan/`. Multipart com o campo `attach_data` (JSON serializado) + `files`. Todos os documentos de uma mesma requisição devem ter…
  - [Rejeitar operação (originador)](https://dev-hub.iorq.com.br/reference/rejectloan.md): Rejeita uma operação em processamento, por decisão do originador, antes da aquisição.
  - [Atualizar operation_data de uma operação](https://dev-hub.iorq.com.br/reference/updateloanoperationdata.md): Atualiza os metadados livres (`operation_data`) de uma operação existente.
- Aquisição
  - [Criar lote de aquisição](https://dev-hub.iorq.com.br/reference/createacquisition.md): Abre um lote (aquisição) que agrupa operações de uma mesma cessão ou renegociação. O fundo é resolvido pelo header `iorq-fund-id`. O `kind` define se o lote é uma `acquisition` (cessão) ou…
  - [Listar lotes de aquisição](https://dev-hub.iorq.com.br/reference/listacquisitions.md): Lista lotes de aquisição do fundo indicado no header `iorq-fund-id`. Filtros opcionais por estado e intervalo de datas. Paginação por `page`/`page_size`.
  - [Consultar lote de aquisição](https://dev-hub.iorq.com.br/reference/getacquisition.md): Retorna os dados de um lote e as operações (`loans`) vinculadas, com suas parcelas aninhadas. O fundo é resolvido pelo header `iorq-fund-id`.
  - [Revisar lote de aquisição](https://dev-hub.iorq.com.br/reference/reviewacquisition.md): Aplica a revisão do originador a um lote: `approve` libera o lote para aquisição pelo FIDC, `reject` recusa o lote. O fundo é resolvido pelo header `iorq-fund-id`.
- Liquidação
  - [Notificar liquidação de parcela](https://dev-hub.iorq.com.br/reference/settleinstallment.md): Registra o pagamento de uma parcela. Use o `paid_amount` real — pode ser menor (a menor/parcial, com `is_partial_payment: true`) ou maior (com encargos) que o valor previsto. `payment_date` no futuro…
  - [Notificar liquidação antecipada multi-operação](https://dev-hub.iorq.com.br/reference/prepayinstallmentv2.md): Registra um pagamento antecipado (ex.: um único boleto) que quita parcelas de múltiplas operações em uma chamada. Cada item em `loans` identifica a operação pelos códigos de proposta…
- Pós-cessão
  - [Recompra de operação](https://dev-hub.iorq.com.br/reference/repurchaseloan.md): Retira uma operação ativa do estoque do fundo. O comportamento é discriminado pelo campo `type` (`standard`, `compulsory_acquisition`, `compulsory_repurchase`). O `repurchase_value` é obrigatório — a…
  - [Renegociar operação](https://dev-hub.iorq.com.br/reference/renegotiateloan.md): Baixa uma ou mais operações originais (`renegotiated_loans`) e cede uma nova operação (`new_loan`, no mesmo formato da cessão) com novos termos. A nova operação passa por elegibilidade independente.…
  - [Renegociar operação com novos documentos](https://dev-hub.iorq.com.br/reference/renegotiateloanwithdocuments.md): Variante multipart de `PATCH /loan/`: baixa uma ou mais operações originais e cede a nova operação (`new_loan`) quando há **novos documentos de lastro** a anexar. Multipart com o campo…
  - [Alterar data de vencimento de parcelas](https://dev-hub.iorq.com.br/reference/changeinstallmentduedate.md): Move a data de vencimento de parcelas de uma ou mais operações ativas — a data e **nada mais** (sem transição de estado, sem mudança de valores). Uma única chamada cobre N operações, cada uma com N…
- Webhooks
  - [Registrar URL de webhook](https://dev-hub.iorq.com.br/reference/createwebhook.md): Registra uma URL HTTPS que receberá os eventos `LOAN_UPDATE` do fundo informado no header `iorq-fund-id`. Escolha no corpo a `contract_version` (v2, o envelope tipado, é o padrão; v1, o corpo legado,…
  - [Listar webhooks do fundo](https://dev-hub.iorq.com.br/reference/listwebhooks.md)
  - [Detalhe de um webhook](https://dev-hub.iorq.com.br/reference/getwebhook.md)
  - [Atualizar URL, headers, status, versão do contrato ou filtro de tipos](https://dev-hub.iorq.com.br/reference/updatewebhook.md): Atualiza a URL, os headers custom, o `status`, a `contract_version` e/ou os `event_types` do webhook; só os campos enviados mudam. Para **pausar** a entrega envie `{"status": "INACTIVE"}`; para…
  - [Rotacionar o signing_secret com sobreposição](https://dev-hub.iorq.com.br/reference/rotatewebhooksecret.md): Gera um secret novo e o devolve **uma única vez**, na mesma resposta do registro, nos dois formatos: `standard_webhooks_secret` e `signing_secret`. O secret anterior continua assinando as entregas…
  - [Disparar um evento de teste](https://dev-hub.iorq.com.br/reference/sendtestwebhookevent.md): Enfileira um evento `webhook.test` só para este webhook (os outros webhooks do fundo não recebem). O evento percorre a entrega normal: assinatura, tentativas, replay, e aparece em `GET…
  - [Listar eventos de um webhook](https://dev-hub.iorq.com.br/reference/listwebhookevents.md): Lista os eventos gerados para o webhook, do mais novo para o mais velho. `payload` é a mensagem como foi armazenada (v1 do produtor ou envelope v2, conforme `schema_version`), não necessariamente o…
  - [Detalhe de um evento](https://dev-hub.iorq.com.br/reference/getevent.md): Devolve um único evento, com os mesmos campos dos itens de `GET /events/webhook/{webhook_id}`: `payload` é a mensagem como foi armazenada (v1 do produtor ou envelope v2, conforme `schema_version`),…
  - [Forçar reentrega (replay) de um evento](https://dev-hub.iorq.com.br/reference/redeliverevent.md): Cria um novo evento a partir de um evento que esgotou as tentativas com falha, ou cuja reentrega foi interrompida, por exemplo pela suspensão ou pausa do webhook (a última tentativa falhou, não era a…
  - [Reenviar os eventos de um período](https://dev-hub.iorq.com.br/reference/replayevents.md): Reenfileira, numa página de até 200 eventos do intervalo, tudo que ficou para trás num webhook: os que esgotaram as tentativas com falha, como clones; os cuja reentrega foi interrompida, por exemplo…
  - [Histórico de entregas de um evento](https://dev-hub.iorq.com.br/reference/listwebhookdeliveries.md): Lista as tentativas de entrega de um evento (sucesso e falha). Útil para diagnóstico e reconciliação após outage. Pela política da IORQ são até 11 tentativas por evento, em cerca de 70 h (esperas de…
  - [Detalhe de uma tentativa de entrega](https://dev-hub.iorq.com.br/reference/getattempt.md): Devolve uma única tentativa, pelo `attempt_id` que os itens de `GET /attempts/event/{event_id}` trazem. Vem com os campos daquela listagem menos `attempt_id`, `attempt_number` e `webhook_url`, e com…
  - Corpo entregue — v1 (LOAN_UPDATE)
    - [Atualização de operação (LOAN_UPDATE)](https://dev-hub.iorq.com.br/reference/post_loan-update.md): Único tipo de mensagem enviado pela IORQ. O corpo do POST para a URL registrada é o objeto `payload` acrescido de `iorq_fund_id` (UUID do fundo do evento, útil para roteamento em integrações…
  - Corpo entregue — v2 (evento tipado)
    - [Evento tipado (contrato v2)](https://dev-hub.iorq.com.br/reference/post_iorq-event-v2.md): Corpo entregue a webhooks registrados com `contract_version: v2`. É o envelope canônico, sem campos injetados: `fund` e `occurred_at` já fazem parte dele. O `type` diz o que aconteceu e determina a…
- Fundos
  - [Listar fundos provisionados](https://dev-hub.iorq.com.br/reference/listfunds.md): Lista fundos aos quais a aplicação cliente tem acesso. Cada fundo é identificado por um UUID estável.
  - [Detalhes do fundo](https://dev-hub.iorq.com.br/reference/getfund.md)

## API Reference: IORQ Investor API
- Fundos
  - [Listar fundos do investidor](https://dev-hub.iorq.com.br/reference/listinvestorfunds.md): Lista os fundos em que a credencial do investidor tem permissão de leitura. O `id` de cada fundo é o valor do header `iorq-fund-id` nas rotas de fundo. Esta rota não recebe o header.
- Covenants
  - [Covenants correntes do fundo](https://dev-hub.iorq.com.br/reference/listfundcovenants.md): Último ponto de cada covenant do catálogo do fundo do header `iorq-fund-id`, qualquer que seja a idade (confira `as_of`). Fail-closed: se faltar ponto de algum covenant, ou um ponto estiver fora do…
  - [Série histórica dos covenants do fundo](https://dev-hub.iorq.com.br/reference/listfundcovenanthistory.md): Pontos diários e mensais dos covenants do fundo entre `from` e `to` (até 366 dias), paginados. Ver a página Séries históricas e versões de fórmula.
- Indicadores
  - [Indicadores de acompanhamento do fundo](https://dev-hub.iorq.com.br/reference/listfundindicators.md): Painel corrente do fundo: último ponto de cada indicador, qualquer que seja a idade. Indicador sem ponto ou com ponto fora do contrato sai `unavailable`, e os demais respondem `200`. Campo sem valor…
- Estoque (WIP)
  - [🚧 Pedir o estoque do fundo (WIP)](https://dev-hub.iorq.com.br/reference/requestinventoryexport.md): > 🚧 **Em estágio inicial (WIP).** O contrato, as colunas do arquivo e os limites podem mudar sem nova versão da API.  Enfileira a geração do estoque do fundo do header `iorq-fund-id` e responde `202`…