OpenAPI

1. Download

A spec completa também alimenta a Referência da API desta documentação — navegue pelos endpoints com exemplos interativos. Para tooling, baixe o arquivo bruto:

Baixar openapi.json · OpenAPI 3.1.0 · Versão 2026.05.0

Em produção, a spec também é servida pelos hosts da API:

Ambiente	URL
Sandbox	`https://hs-api.sandbox.iorq.com.br/openapi.json`
Produção	`https://hs-api.iorq.com.br/openapi.json`

Os endpoints respondem sem autenticação — a spec é pública. Para versões anteriores, consulte o Changelog.

2. Versionamento da spec

Mudanças aditivas (novos campos opcionais, novos endpoints, novos eventos) — versão menor, sem aviso prévio
Mudanças breaking — versão maior, comunicada com 90 dias de antecedência via header X-IORQ-API-Deprecation e e-mail

A versão atual da spec aparece no campo info.version e nos cabeçalhos das respostas:

HTTP/1.1 200 OK
X-IORQ-API-Version: 2026.05.0

3. Gerando um cliente

Recomendamos openapi-generator para gerar SDKs em sua linguagem:

Python

npx @openapitools/openapi-generator-cli generate \
  -i https://hs-api.iorq.com.br/openapi.yaml \
  -g python \
  -o ./iorq-client-python

TypeScript (Axios)

npx @openapitools/openapi-generator-cli generate \
  -i https://hs-api.iorq.com.br/openapi.yaml \
  -g typescript-axios \
  -o ./iorq-client-ts

Go

npx @openapitools/openapi-generator-cli generate \
  -i https://hs-api.iorq.com.br/openapi.yaml \
  -g go \
  -o ./iorq-client-go

Lista completa de geradores: openapi-generator.

4. Importar em ferramentas de cliente

Postman

Import → Link
Cole https://hs-api.iorq.com.br/openapi.yaml
Selecione "OpenAPI 3.0/3.1" como formato

Bruno

Collection → Import → OpenAPI V3 Spec
Selecione o arquivo YAML local ou cole a URL

Insomnia

Create → From URL
Cole a URL do YAML

5. Exemplo de trecho da spec

Só para dar uma ideia do formato — o arquivo completo tem ~3000 linhas:

{
  "openapi": "3.1.0",
  "info": {
    "title": "IORQ API",
    "version": "2026.05.0",
    "description": "API de cessão, liquidação e operações pós-cessão de FIDCs"
  },
  "servers": [
    { "url": "https://hs-api.iorq.com.br", "description": "Produção" },
    { "url": "https://hs-api.sandbox.iorq.com.br", "description": "Sandbox" }
  ],
  "paths": {
    "/loan": {
      "post": {
        "summary": "Ceder operação",
        "requestBody": {
          "content": {
            "multipart/form-data": {
              "schema": { "$ref": "#/components/schemas/LoanCreateRequest" }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Operação aceita",
            "content": {
              "application/json": {
                "schema": { "$ref": "#/components/schemas/LoanCreateResponse" }
              }
            }
          }
        }
      }
    }
  }
}

6. Validação local

Para validar um payload contra a spec antes de enviar para a IORQ, use jsonschema ou bibliotecas equivalentes:

from openapi_spec_validator import validate_spec
import yaml, requests

spec = yaml.safe_load(requests.get(
    "https://hs-api.iorq.com.br/openapi.yaml"
).text)
validate_spec(spec)  # garante que a spec está válida

# Validar payload contra schema específico
from jsonschema import validate
loan_data = { }
validate(loan_data, spec["components"]["schemas"]["LoanCreateRequest"])

7. Próximos passos

Início — Visão geral

Volte ao topo da documentação.

Mãos à obra — Quickstart

Primeira cessão em sandbox.