{ "openapi": "3.1.0", "info": { "title": "API Full", "version": "1.0.0", "description": "Consultas e serviços da API Full. Utilize o Bearer Token da sua conta em https://app.apifull.com.br/. As consultas podem consumir créditos. A especificação é gerada das rotas e dos contratos da aplicação a cada acesso. Em endpoints legados, verifique também o campo status da resposta, mesmo com HTTP 200.", "contact": { "name": "Suporte API Full", "url": "https://wa.me/553194943376?text=Preciso%20de%20suporte" } }, "servers": [ { "url": "https://api.apifull.com.br" } ], "security": [ { "BearerAuth": [] } ], "tags": [ { "name": "AI" }, { "name": "AI - Acionadores" }, { "name": "AI - Agentes" }, { "name": "AI - Atendimento" }, { "name": "AI - CRM" }, { "name": "AI - Chat" }, { "name": "AI - Uso" }, { "name": "AI Studio" }, { "name": "Análise de Mercado" }, { "name": "Armazenamento" }, { "name": "Certidões" }, { "name": "Compliance" }, { "name": "Comunicação" }, { "name": "Consultas" }, { "name": "Conta e créditos" }, { "name": "Dados" }, { "name": "Dados e crédito" }, { "name": "Dívidas e Crédito" }, { "name": "Ferramentas" }, { "name": "Jurídico" }, { "name": "Veículos" }, { "name": "WhatsApp" }, { "name": "White Label" } ], "paths": { "/ai": { "get": { "summary": "Status publico da API AI", "tags": [ "AI" ], "operationId": "get_ai", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullSuccessResponse" } } } }, "400": { "description": "Erro na requisicao", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } }, "401": { "description": "Token invalido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } } } } }, "/ai-studio/catalog": { "get": { "summary": "Catálogo do AI Studio", "tags": [ "AI Studio" ], "responses": { "2XX": { "description": "Resultado do AI Studio. Criação: 201. Geração assíncrona: 202.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "default": { "description": "Erro com código e mensagem.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } }, "operationId": "get_ai_studio_catalog" } }, "/ai-studio/jobs/{id}": { "get": { "summary": "Consultar geração", "tags": [ "AI Studio" ], "responses": { "2XX": { "description": "Resultado do AI Studio. Criação: 201. Geração assíncrona: 202.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "default": { "description": "Erro com código e mensagem.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } }, "operationId": "get_ai_studio_jobs_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/ai-studio/jobs/{id}/cancel": { "post": { "summary": "Cancelar geração", "tags": [ "AI Studio" ], "responses": { "2XX": { "description": "Resultado do AI Studio. Criação: 201. Geração assíncrona: 202.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "default": { "description": "Erro com código e mensagem.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } }, "operationId": "post_ai_studio_jobs_id_cancel", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/ai-studio/projects": { "get": { "summary": "Listar projetos", "tags": [ "AI Studio" ], "responses": { "2XX": { "description": "Resultado do AI Studio. Criação: 201. Geração assíncrona: 202.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "default": { "description": "Erro com código e mensagem.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } }, "operationId": "get_ai_studio_projects" }, "post": { "summary": "Criar projeto", "tags": [ "AI Studio" ], "responses": { "2XX": { "description": "Resultado do AI Studio. Criação: 201. Geração assíncrona: 202.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "default": { "description": "Erro com código e mensagem.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "artifact_type": { "type": "string", "enum": [ "website", "image", "chart", "spreadsheet", "slides", "workflow", "audio", "carousel", "document", "auto" ] }, "name": { "type": "string", "maxLength": 160 }, "description": { "type": "string", "maxLength": 3000 }, "options": { "type": "object", "additionalProperties": true } }, "additionalProperties": true, "required": [ "artifact_type" ] } } } }, "operationId": "post_ai_studio_projects" } }, "/ai-studio/projects/{id}": { "get": { "summary": "Detalhar projeto", "tags": [ "AI Studio" ], "responses": { "2XX": { "description": "Resultado do AI Studio. Criação: 201. Geração assíncrona: 202.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "default": { "description": "Erro com código e mensagem.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } }, "operationId": "get_ai_studio_projects_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "Atualizar projeto", "tags": [ "AI Studio" ], "responses": { "2XX": { "description": "Resultado do AI Studio. Criação: 201. Geração assíncrona: 202.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "default": { "description": "Erro com código e mensagem.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 160 }, "description": { "type": "string", "maxLength": 3000 }, "options": { "type": "object", "additionalProperties": true } }, "additionalProperties": true } } } }, "operationId": "patch_ai_studio_projects_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "delete": { "summary": "Excluir projeto", "tags": [ "AI Studio" ], "responses": { "2XX": { "description": "Resultado do AI Studio. Criação: 201. Geração assíncrona: 202.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "default": { "description": "Erro com código e mensagem.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } }, "operationId": "delete_ai_studio_projects_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/ai-studio/projects/{id}/generate": { "post": { "summary": "Gerar conteúdo", "tags": [ "AI Studio" ], "responses": { "2XX": { "description": "Resultado do AI Studio. Criação: 201. Geração assíncrona: 202.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "default": { "description": "Erro com código e mensagem.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "prompt": { "type": "string" }, "operation": { "type": "string", "enum": [ "create", "update" ] }, "options": { "type": "object", "additionalProperties": true } }, "additionalProperties": true, "required": [ "prompt" ] } } } }, "operationId": "post_ai_studio_projects_id_generate", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/ai-studio/projects/{id}/messages": { "get": { "summary": "Listar mensagens", "tags": [ "AI Studio" ], "responses": { "2XX": { "description": "Resultado do AI Studio. Criação: 201. Geração assíncrona: 202.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "default": { "description": "Erro com código e mensagem.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } }, "operationId": "get_ai_studio_projects_id_messages", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "summary": "Solicitar alteração", "tags": [ "AI Studio" ], "responses": { "2XX": { "description": "Resultado do AI Studio. Criação: 201. Geração assíncrona: 202.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "default": { "description": "Erro com código e mensagem.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "content": { "type": "string" }, "prompt": { "type": "string" }, "options": { "type": "object", "additionalProperties": true } }, "additionalProperties": true } } } }, "operationId": "post_ai_studio_projects_id_messages", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/ai-studio/projects/{id}/versions": { "get": { "summary": "Listar versões", "tags": [ "AI Studio" ], "responses": { "2XX": { "description": "Resultado do AI Studio. Criação: 201. Geração assíncrona: 202.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "default": { "description": "Erro com código e mensagem.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } }, "operationId": "get_ai_studio_projects_id_versions", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/ai-studio/projects/{id}/versions/{version}": { "get": { "summary": "Detalhar versão", "tags": [ "AI Studio" ], "responses": { "2XX": { "description": "Resultado do AI Studio. Criação: 201. Geração assíncrona: 202.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "default": { "description": "Erro com código e mensagem.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } }, "operationId": "get_ai_studio_projects_id_versions_version", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "integer" } } ] } }, "/ai-studio/projects/{id}/versions/{version}/export": { "get": { "summary": "Exportar versão", "tags": [ "AI Studio" ], "responses": { "2XX": { "description": "Resultado do AI Studio. Criação: 201. Geração assíncrona: 202.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "default": { "description": "Erro com código e mensagem.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } }, "operationId": "get_ai_studio_projects_id_versions_version_export", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "integer" } } ] } }, "/ai-studio/projects/{id}/versions/{version}/restore": { "post": { "summary": "Restaurar versão", "tags": [ "AI Studio" ], "responses": { "2XX": { "description": "Resultado do AI Studio. Criação: 201. Geração assíncrona: 202.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "default": { "description": "Erro com código e mensagem.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } }, "operationId": "post_ai_studio_projects_id_versions_version_restore", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "integer" } } ] } }, "/ai/agents": { "get": { "summary": "Listar agentes de IA", "tags": [ "AI - Agentes" ], "operationId": "get_ai_agents", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullSuccessResponse" } } } }, "400": { "description": "Erro na requisicao", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } }, "401": { "description": "Token invalido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } } } }, "post": { "summary": "Criar agente de IA", "tags": [ "AI - Agentes" ], "operationId": "post_ai_agents", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullSuccessResponse" } } } }, "400": { "description": "Erro na requisicao", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } }, "401": { "description": "Token invalido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AIAgentRequest" } } } } } }, "/ai/agents/{hash}": { "get": { "summary": "Detalhar agente de IA", "tags": [ "AI - Agentes" ], "operationId": "get_ai_agents_hash", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullSuccessResponse" } } } }, "400": { "description": "Erro na requisicao", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } }, "401": { "description": "Token invalido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } } }, "parameters": [ { "name": "hash", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "summary": "Atualizar agente de IA", "tags": [ "AI - Agentes" ], "operationId": "post_ai_agents_hash", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullSuccessResponse" } } } }, "400": { "description": "Erro na requisicao", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } }, "401": { "description": "Token invalido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } } }, "parameters": [ { "name": "hash", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AIAgentRequest" } } } } }, "put": { "summary": "Atualizar agente de IA", "tags": [ "AI - Agentes" ], "operationId": "put_ai_agents_hash", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullSuccessResponse" } } } }, "400": { "description": "Erro na requisicao", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } }, "401": { "description": "Token invalido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } } }, "parameters": [ { "name": "hash", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AIAgentRequest" } } } } }, "delete": { "summary": "Excluir agente de IA", "tags": [ "AI - Agentes" ], "operationId": "delete_ai_agents_hash", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullSuccessResponse" } } } }, "400": { "description": "Erro na requisicao", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } }, "401": { "description": "Token invalido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } } }, "parameters": [ { "name": "hash", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/ai/agents/{hash}/delete": { "post": { "summary": "Excluir agente de IA via POST", "tags": [ "AI - Agentes" ], "operationId": "post_ai_agents_hash_delete", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullSuccessResponse" } } } }, "400": { "description": "Erro na requisicao", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } }, "401": { "description": "Token invalido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } } }, "parameters": [ { "name": "hash", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/ai/agents/{hash}/files": { "get": { "summary": "Listar arquivos do agente", "tags": [ "AI - Agentes" ], "operationId": "get_ai_agents_hash_files", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullSuccessResponse" } } } }, "400": { "description": "Erro na requisicao", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } }, "401": { "description": "Token invalido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } } }, "parameters": [ { "name": "hash", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "summary": "Treinar agente com arquivo", "tags": [ "AI - Agentes" ], "operationId": "post_ai_agents_hash_files", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullSuccessResponse" } } } }, "400": { "description": "Erro na requisicao", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } }, "401": { "description": "Token invalido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } } }, "parameters": [ { "name": "hash", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "required": [ "file" ], "properties": { "file": { "type": "string", "format": "binary" } } } } } } } }, "/ai/agents/{hash}/files/{file}": { "delete": { "summary": "Remover arquivo do agente", "tags": [ "AI - Agentes" ], "operationId": "delete_ai_agents_hash_files_file", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullSuccessResponse" } } } }, "400": { "description": "Erro na requisicao", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } }, "401": { "description": "Token invalido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } } }, "parameters": [ { "name": "hash", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "file", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/ai/agents/{hash}/files/{file}/delete": { "post": { "summary": "Remover arquivo do agente via POST", "tags": [ "AI - Agentes" ], "operationId": "post_ai_agents_hash_files_file_delete", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullSuccessResponse" } } } }, "400": { "description": "Erro na requisicao", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } }, "401": { "description": "Token invalido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } } }, "parameters": [ { "name": "hash", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "file", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/ai/agents/{hash}/handoff": { "get": { "summary": "Consultar configuracoes de atendimento humano", "tags": [ "AI - Agentes" ], "operationId": "get_ai_agents_hash_handoff", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullSuccessResponse" } } } }, "400": { "description": "Erro na requisicao", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } }, "401": { "description": "Token invalido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } } }, "parameters": [ { "name": "hash", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "summary": "Atualizar configuracoes de atendimento humano", "tags": [ "AI - Agentes" ], "operationId": "post_ai_agents_hash_handoff", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullSuccessResponse" } } } }, "400": { "description": "Erro na requisicao", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } }, "401": { "description": "Token invalido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } } }, "parameters": [ { "name": "hash", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AIHandoffSettingsRequest" } } } } } }, "/ai/agents/{hash}/integration": { "post": { "summary": "Integrar agente com WhatsApp e roteamento", "tags": [ "AI - Agentes" ], "operationId": "post_ai_agents_hash_integration", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullSuccessResponse" } } } }, "400": { "description": "Erro na requisicao", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } }, "401": { "description": "Token invalido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } } }, "parameters": [ { "name": "hash", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AIAgentIntegrationRequest" } } } } } }, "/ai/agents/{hash}/prompt": { "post": { "summary": "Gerar persona ou regras do agente", "tags": [ "AI - Agentes" ], "operationId": "post_ai_agents_hash_prompt", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullSuccessResponse" } } } }, "400": { "description": "Erro na requisicao", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } }, "401": { "description": "Token invalido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } } }, "parameters": [ { "name": "hash", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AIPromptRequest" } } } } } }, "/ai/agents/{hash}/training-file": { "post": { "summary": "Treinar agente com arquivo", "tags": [ "AI - Agentes" ], "operationId": "post_ai_agents_hash_training_file", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullSuccessResponse" } } } }, "400": { "description": "Erro na requisicao", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } }, "401": { "description": "Token invalido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } } }, "parameters": [ { "name": "hash", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "required": [ "file" ], "properties": { "file": { "type": "string", "format": "binary" } } } } } } } }, "/ai/agents/{hash}/training-site": { "post": { "summary": "Treinar agente com URL de site", "tags": [ "AI - Agentes" ], "operationId": "post_ai_agents_hash_training_site", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullSuccessResponse" } } } }, "400": { "description": "Erro na requisicao", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } }, "401": { "description": "Token invalido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } } }, "parameters": [ { "name": "hash", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AITrainingSiteRequest" } } } } } }, "/ai/agents/{hash}/voice": { "post": { "summary": "Atualizar voz do agente", "tags": [ "AI - Agentes" ], "operationId": "post_ai_agents_hash_voice", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullSuccessResponse" } } } }, "400": { "description": "Erro na requisicao", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } }, "401": { "description": "Token invalido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } } }, "parameters": [ { "name": "hash", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AIVoiceRequest" } } } } } }, "/ai/chat": { "post": { "summary": "Enviar mensagem para agente de IA", "tags": [ "AI - Chat" ], "operationId": "post_ai_chat", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullSuccessResponse" } } } }, "400": { "description": "Erro na requisicao", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } }, "401": { "description": "Token invalido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AIChatRequest" } } } } } }, "/ai/conversations": { "get": { "summary": "Listar conversas de atendimento AI", "tags": [ "AI - Atendimento" ], "operationId": "get_ai_conversations", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullSuccessResponse" } } } }, "400": { "description": "Erro na requisicao", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } }, "401": { "description": "Token invalido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } } }, "parameters": [ { "name": "status", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/ai/conversations/{id}": { "get": { "summary": "Detalhar conversa de atendimento AI", "tags": [ "AI - Atendimento" ], "operationId": "get_ai_conversations_id", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullSuccessResponse" } } } }, "400": { "description": "Erro na requisicao", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } }, "401": { "description": "Token invalido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ] } }, "/ai/conversations/{id}/messages": { "post": { "summary": "Enviar mensagem humana na conversa AI", "tags": [ "AI - Atendimento" ], "operationId": "post_ai_conversations_id_messages", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullSuccessResponse" } } } }, "400": { "description": "Erro na requisicao", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } }, "401": { "description": "Token invalido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AIConversationMessageRequest" } } } } } }, "/ai/conversations/{id}/status": { "post": { "summary": "Atualizar status da conversa AI", "tags": [ "AI - Atendimento" ], "operationId": "post_ai_conversations_id_status", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullSuccessResponse" } } } }, "400": { "description": "Erro na requisicao", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } }, "401": { "description": "Token invalido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AIConversationStatusRequest" } } } } } }, "/ai/crm/contacts": { "get": { "summary": "Listar contatos do CRM da IA", "tags": [ "AI - CRM" ], "operationId": "get_ai_crm_contacts", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullSuccessResponse" } } } }, "400": { "description": "Erro na requisicao", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } }, "401": { "description": "Token invalido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } } }, "parameters": [ { "name": "crm", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "stage", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" } } ] }, "post": { "summary": "Criar contato do CRM da IA", "tags": [ "AI - CRM" ], "operationId": "post_ai_crm_contacts", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullSuccessResponse" } } } }, "400": { "description": "Erro na requisicao", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } }, "401": { "description": "Token invalido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AICRMContactRequest" } } } } } }, "/ai/crm/contacts/{id}": { "get": { "summary": "Detalhar contato do CRM da IA", "tags": [ "AI - CRM" ], "operationId": "get_ai_crm_contacts_id", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullSuccessResponse" } } } }, "400": { "description": "Erro na requisicao", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } }, "401": { "description": "Token invalido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ] }, "post": { "summary": "Atualizar contato do CRM da IA", "tags": [ "AI - CRM" ], "operationId": "post_ai_crm_contacts_id", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullSuccessResponse" } } } }, "400": { "description": "Erro na requisicao", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } }, "401": { "description": "Token invalido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AICRMContactRequest" } } } } }, "put": { "summary": "Atualizar contato do CRM da IA", "tags": [ "AI - CRM" ], "operationId": "put_ai_crm_contacts_id", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullSuccessResponse" } } } }, "400": { "description": "Erro na requisicao", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } }, "401": { "description": "Token invalido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AICRMContactRequest" } } } } }, "delete": { "summary": "Excluir contato do CRM da IA", "tags": [ "AI - CRM" ], "operationId": "delete_ai_crm_contacts_id", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullSuccessResponse" } } } }, "400": { "description": "Erro na requisicao", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } }, "401": { "description": "Token invalido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ] } }, "/ai/crm/contacts/{id}/deals": { "post": { "summary": "Criar ou atualizar oportunidade do contato", "tags": [ "AI - CRM" ], "operationId": "post_ai_crm_contacts_id_deals", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullSuccessResponse" } } } }, "400": { "description": "Erro na requisicao", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } }, "401": { "description": "Token invalido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AICRMDealRequest" } } } } } }, "/ai/crm/contacts/{id}/delete": { "post": { "summary": "Excluir contato do CRM da IA via POST", "tags": [ "AI - CRM" ], "operationId": "post_ai_crm_contacts_id_delete", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullSuccessResponse" } } } }, "400": { "description": "Erro na requisicao", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } }, "401": { "description": "Token invalido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ] } }, "/ai/crm/contacts/{id}/notes": { "post": { "summary": "Adicionar nota ao contato do CRM da IA", "tags": [ "AI - CRM" ], "operationId": "post_ai_crm_contacts_id_notes", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullSuccessResponse" } } } }, "400": { "description": "Erro na requisicao", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } }, "401": { "description": "Token invalido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AICRMNoteRequest" } } } } } }, "/ai/crm/contacts/{id}/tasks": { "post": { "summary": "Criar ou atualizar tarefa do contato", "tags": [ "AI - CRM" ], "operationId": "post_ai_crm_contacts_id_tasks", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullSuccessResponse" } } } }, "400": { "description": "Erro na requisicao", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } }, "401": { "description": "Token invalido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AICRMTaskRequest" } } } } } }, "/ai/crm/contacts/{id}/tasks/{task_id}/status": { "post": { "summary": "Atualizar status da tarefa do contato", "tags": [ "AI - CRM" ], "operationId": "post_ai_crm_contacts_id_tasks_task_id_status", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullSuccessResponse" } } } }, "400": { "description": "Erro na requisicao", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } }, "401": { "description": "Token invalido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "task_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AICRMTaskStatusRequest" } } } } } }, "/ai/crm/pipelines": { "get": { "summary": "Listar CRMs da IA", "tags": [ "AI - CRM" ], "operationId": "get_ai_crm_pipelines", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullSuccessResponse" } } } }, "400": { "description": "Erro na requisicao", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } }, "401": { "description": "Token invalido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } } } }, "post": { "summary": "Criar CRM da IA", "tags": [ "AI - CRM" ], "operationId": "post_ai_crm_pipelines", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullSuccessResponse" } } } }, "400": { "description": "Erro na requisicao", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } }, "401": { "description": "Token invalido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AICRMPipelineRequest" } } } } } }, "/ai/crm/pipelines/{id}": { "post": { "summary": "Atualizar CRM da IA", "tags": [ "AI - CRM" ], "operationId": "post_ai_crm_pipelines_id", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullSuccessResponse" } } } }, "400": { "description": "Erro na requisicao", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } }, "401": { "description": "Token invalido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AICRMPipelineRequest" } } } } }, "put": { "summary": "Atualizar CRM da IA", "tags": [ "AI - CRM" ], "operationId": "put_ai_crm_pipelines_id", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullSuccessResponse" } } } }, "400": { "description": "Erro na requisicao", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } }, "401": { "description": "Token invalido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AICRMPipelineRequest" } } } } }, "delete": { "summary": "Excluir CRM da IA", "tags": [ "AI - CRM" ], "operationId": "delete_ai_crm_pipelines_id", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullSuccessResponse" } } } }, "400": { "description": "Erro na requisicao", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } }, "401": { "description": "Token invalido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ] } }, "/ai/crm/pipelines/{id}/delete": { "post": { "summary": "Excluir CRM da IA via POST", "tags": [ "AI - CRM" ], "operationId": "post_ai_crm_pipelines_id_delete", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullSuccessResponse" } } } }, "400": { "description": "Erro na requisicao", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } }, "401": { "description": "Token invalido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ] } }, "/ai/crm/pipelines/{id}/permissions": { "get": { "summary": "Listar permissoes de CRM da IA", "tags": [ "AI - CRM" ], "operationId": "get_ai_crm_pipelines_id_permissions", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullSuccessResponse" } } } }, "400": { "description": "Erro na requisicao", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } }, "401": { "description": "Token invalido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ] }, "post": { "summary": "Salvar permissoes de CRM da IA", "tags": [ "AI - CRM" ], "operationId": "post_ai_crm_pipelines_id_permissions", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullSuccessResponse" } } } }, "400": { "description": "Erro na requisicao", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } }, "401": { "description": "Token invalido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AICRMPipelinePermissionsRequest" } } } } } }, "/ai/crm/stages": { "get": { "summary": "Listar etapas do CRM da IA", "tags": [ "AI - CRM" ], "operationId": "get_ai_crm_stages", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullSuccessResponse" } } } }, "400": { "description": "Erro na requisicao", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } }, "401": { "description": "Token invalido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } } }, "parameters": [ { "name": "crm", "in": "query", "required": false, "schema": { "type": "string" } } ] }, "post": { "summary": "Criar etapa do CRM da IA", "tags": [ "AI - CRM" ], "operationId": "post_ai_crm_stages", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullSuccessResponse" } } } }, "400": { "description": "Erro na requisicao", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } }, "401": { "description": "Token invalido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AICRMStageRequest" } } } } } }, "/ai/crm/stages/{id}": { "post": { "summary": "Atualizar etapa do CRM da IA", "tags": [ "AI - CRM" ], "operationId": "post_ai_crm_stages_id", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullSuccessResponse" } } } }, "400": { "description": "Erro na requisicao", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } }, "401": { "description": "Token invalido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AICRMStageRequest" } } } } }, "put": { "summary": "Atualizar etapa do CRM da IA", "tags": [ "AI - CRM" ], "operationId": "put_ai_crm_stages_id", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullSuccessResponse" } } } }, "400": { "description": "Erro na requisicao", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } }, "401": { "description": "Token invalido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AICRMStageRequest" } } } } }, "delete": { "summary": "Excluir etapa do CRM da IA", "tags": [ "AI - CRM" ], "operationId": "delete_ai_crm_stages_id", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullSuccessResponse" } } } }, "400": { "description": "Erro na requisicao", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } }, "401": { "description": "Token invalido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AICRMStageDeleteRequest" } } } } } }, "/ai/crm/stages/{id}/delete": { "post": { "summary": "Excluir etapa do CRM da IA via POST", "tags": [ "AI - CRM" ], "operationId": "post_ai_crm_stages_id_delete", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullSuccessResponse" } } } }, "400": { "description": "Erro na requisicao", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } }, "401": { "description": "Token invalido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AICRMStageDeleteRequest" } } } } } }, "/ai/crm/stats": { "get": { "summary": "Estatisticas do CRM da IA", "tags": [ "AI - CRM" ], "operationId": "get_ai_crm_stats", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullSuccessResponse" } } } }, "400": { "description": "Erro na requisicao", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } }, "401": { "description": "Token invalido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } } }, "parameters": [ { "name": "crm", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/ai/options": { "get": { "summary": "Opcoes do modulo AI", "tags": [ "AI" ], "operationId": "get_ai_options", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullSuccessResponse" } } } }, "400": { "description": "Erro na requisicao", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } }, "401": { "description": "Token invalido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } } } } }, "/ai/triggers": { "get": { "summary": "Listar acionadores da IA", "tags": [ "AI - Acionadores" ], "operationId": "get_ai_triggers", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullSuccessResponse" } } } }, "400": { "description": "Erro na requisicao", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } }, "401": { "description": "Token invalido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } } } }, "post": { "summary": "Criar acionador da IA", "tags": [ "AI - Acionadores" ], "operationId": "post_ai_triggers", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullSuccessResponse" } } } }, "400": { "description": "Erro na requisicao", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } }, "401": { "description": "Token invalido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AITriggerRequest" } } } } } }, "/ai/triggers/{id}": { "get": { "summary": "Detalhar acionador da IA", "tags": [ "AI - Acionadores" ], "operationId": "get_ai_triggers_id", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullSuccessResponse" } } } }, "400": { "description": "Erro na requisicao", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } }, "401": { "description": "Token invalido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ] }, "post": { "summary": "Atualizar acionador da IA", "tags": [ "AI - Acionadores" ], "operationId": "post_ai_triggers_id", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullSuccessResponse" } } } }, "400": { "description": "Erro na requisicao", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } }, "401": { "description": "Token invalido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AITriggerRequest" } } } } }, "put": { "summary": "Atualizar acionador da IA", "tags": [ "AI - Acionadores" ], "operationId": "put_ai_triggers_id", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullSuccessResponse" } } } }, "400": { "description": "Erro na requisicao", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } }, "401": { "description": "Token invalido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AITriggerRequest" } } } } }, "delete": { "summary": "Excluir acionador da IA", "tags": [ "AI - Acionadores" ], "operationId": "delete_ai_triggers_id", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullSuccessResponse" } } } }, "400": { "description": "Erro na requisicao", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } }, "401": { "description": "Token invalido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ] } }, "/ai/triggers/{id}/delete": { "post": { "summary": "Excluir acionador da IA via POST", "tags": [ "AI - Acionadores" ], "operationId": "post_ai_triggers_id_delete", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullSuccessResponse" } } } }, "400": { "description": "Erro na requisicao", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } }, "401": { "description": "Token invalido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ] } }, "/ai/upload-file": { "post": { "summary": "Upload de arquivo temporario para conversa", "tags": [ "AI - Chat" ], "operationId": "post_ai_upload_file", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullSuccessResponse" } } } }, "400": { "description": "Erro na requisicao", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } }, "401": { "description": "Token invalido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } } }, "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "required": [ "file" ], "properties": { "file": { "type": "string", "format": "binary" } } } } } } } }, "/ai/usage": { "get": { "summary": "Relatorio de uso de IA", "tags": [ "AI - Uso" ], "operationId": "get_ai_usage", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullSuccessResponse" } } } }, "400": { "description": "Erro na requisicao", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } }, "401": { "description": "Token invalido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFullErrorResponse" } } } } }, "parameters": [ { "name": "start_date", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "end_date", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "agent_hash", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/api/agregados-basica": { "post": { "summary": "Agregados básico", "tags": [ "Veículos" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "agregados-basica" ], "example": "agregados-basica" }, "placa": { "type": "string", "description": "Placa do veículo." } }, "required": [ "link", "placa" ], "additionalProperties": true } } } }, "x-mcp-executable": true, "operationId": "post_api_agregados_basica" } }, "/api/agregados-propria": { "post": { "summary": "Agregados própria", "tags": [ "Veículos" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "agregados-propria" ], "example": "agregados-propria" }, "pdf": { "type": [ "string", "boolean", "integer" ], "description": "Opcional. A presença deste campo solicita o relatório PDF. Omita para retornar apenas os dados." }, "placa": { "type": "string", "description": "Placa do veículo." } }, "required": [ "link", "placa" ], "additionalProperties": true } } } }, "x-mcp-executable": true, "operationId": "post_api_agregados_propria" } }, "/api/ai-generate-image": { "post": { "summary": "Cria imagem por AI", "tags": [ "Ferramentas" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "ai-generate-image" ], "example": "ai-generate-image" }, "prompt": { "type": "string", "description": "prompt" } }, "required": [ "link", "prompt" ], "additionalProperties": true } } } }, "x-supported-methods": [ "post" ], "description": "Use POST com corpo JSON. A rota legada aceita outros métodos, mas eles não são recomendados para integração.", "x-mcp-executable": false, "operationId": "post_api_ai_generate_image" } }, "/api/ap-boavista": { "post": { "summary": "SCPC Boa vista plus", "tags": [ "Dados e crédito" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "document": { "type": "string", "description": "CPF ou CNPJ do titular consultado." }, "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "ap-boavista" ], "example": "ap-boavista" } }, "required": [ "link", "document" ], "additionalProperties": true } } } }, "x-mcp-executable": false, "operationId": "post_api_ap_boavista" } }, "/api/atpv-e": { "post": { "summary": "Busca por 2ª via ATPV-e de veículo", "tags": [ "Veículos" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "atpv-e" ], "example": "atpv-e" }, "pdf": { "type": [ "string", "boolean", "integer" ], "description": "Opcional. A presença deste campo solicita o relatório PDF. Omita para retornar apenas os dados." }, "placa": { "type": "string", "description": "Placa do veículo." }, "renavam": { "type": "string", "description": "renavam" }, "chassi": { "type": "string", "description": "chassi" } }, "required": [ "link", "placa", "renavam", "chassi" ], "additionalProperties": true } } } }, "x-mcp-executable": true, "operationId": "post_api_atpv_e" } }, "/api/bacen": { "post": { "summary": "Consulta do BACEN SCR e score", "tags": [ "Dados e crédito" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "bacen" ], "example": "bacen" }, "pdf": { "type": [ "string", "boolean", "integer" ], "description": "Opcional. A presença deste campo solicita o relatório PDF. Omita para retornar apenas os dados." }, "document": { "type": "string", "description": "CPF ou CNPJ do titular consultado." } }, "required": [ "link", "document" ], "additionalProperties": true } } } }, "x-mcp-executable": true, "operationId": "post_api_bacen" } }, "/api/busca-documentos": { "post": { "summary": "Busca por reversa por documentos", "tags": [ "Veículos" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "busca-documentos" ], "example": "busca-documentos" }, "pdf": { "type": [ "string", "boolean", "integer" ], "description": "Opcional. A presença deste campo solicita o relatório PDF. Omita para retornar apenas os dados." }, "cpf": { "type": "string", "description": "CPF do titular consultado." }, "telefone": { "type": "string", "description": "telefone" }, "placa": { "type": "string", "description": "Placa do veículo." }, "rg": { "type": "string", "description": "rg" }, "email": { "type": "string", "description": "email" }, "tituloEleitor": { "type": "string", "description": "tituloEleitor" }, "nis": { "type": "string", "description": "nis" }, "pis": { "type": "string", "description": "pis" }, "cns": { "type": "string", "description": "cns" } }, "required": [ "link" ], "additionalProperties": true, "anyOf": [ { "required": [ "cpf" ] }, { "required": [ "telefone" ] }, { "required": [ "placa" ] }, { "required": [ "rg" ] }, { "required": [ "email" ] }, { "required": [ "tituloEleitor" ] }, { "required": [ "nis" ] }, { "required": [ "pis" ] }, { "required": [ "cns" ] } ] } } } }, "x-mcp-executable": true, "operationId": "post_api_busca_documentos" } }, "/api/busca-reputacao": { "post": { "summary": "API de busca de produtos por modelo de veículo grátis", "tags": [ "Ferramentas" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "name" }, "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "busca-reputacao" ], "example": "busca-reputacao" }, "variations": { "type": "string", "description": "Variações do nome separadas por vírgula." }, "keys": { "type": "string", "description": "keys" }, "contacts": { "type": "string", "description": "Contatos separados por |." }, "document": { "type": "string", "description": "CPF ou CNPJ do titular consultado." }, "brands": { "type": "string", "description": "brands" }, "time": { "type": "string", "description": "time" } }, "required": [ "link", "name" ], "additionalProperties": true } } } }, "x-mcp-executable": false, "operationId": "post_api_busca_reputacao" } }, "/api/cadin": { "post": { "summary": "Consulta de dividas a orgãos federais em tempo real", "tags": [ "Dados e crédito" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "cadin" ], "example": "cadin" }, "pdf": { "type": [ "string", "boolean", "integer" ], "description": "Opcional. A presença deste campo solicita o relatório PDF. Omita para retornar apenas os dados." }, "document": { "type": "string", "description": "CPF ou CNPJ do titular consultado." } }, "required": [ "link", "document" ], "additionalProperties": true } } } }, "x-mcp-executable": true, "operationId": "post_api_cadin" } }, "/api/cert-pf-acoes-trabalhistas": { "post": { "summary": "Certidão de Ações Trabalhistas - PF", "description": "Consulta certidão de ações trabalhistas vinculadas ao CPF. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Certidões" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "cert-pf-acoes-trabalhistas" ], "description": "Identificador da consulta.", "example": "cert-pf-acoes-trabalhistas" }, "cpf": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "document": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cpf" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_cert_pf_acoes_trabalhistas" } }, "/api/cert-pf-antecedentes-criminais": { "post": { "summary": "Certidão de Antecedentes Criminais", "description": "Emite ou consulta a certidão federal de antecedentes criminais para o CPF. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Certidões" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "cert-pf-antecedentes-criminais" ], "description": "Identificador da consulta.", "example": "cert-pf-antecedentes-criminais" }, "cpf": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "document": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cpf" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_cert_pf_antecedentes_criminais" } }, "/api/cert-pf-debitos-estaduais": { "post": { "summary": "Certidão de Débitos Estaduais - PF", "description": "Consulta certidão estadual de débitos para o CPF e a UF informada. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Certidões" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "cert-pf-debitos-estaduais" ], "description": "Identificador da consulta.", "example": "cert-pf-debitos-estaduais" }, "cpf": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "document": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "uf": { "type": "string", "minLength": 1, "description": "Sigla da UF com duas letras." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cpf" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] }, { "anyOf": [ { "required": [ "uf" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_cert_pf_debitos_estaduais" } }, "/api/cert-pf-debitos-trabalhistas": { "post": { "summary": "Certidão de Débitos Trabalhistas - PF", "description": "Consulta a Certidão Negativa de Débitos Trabalhistas do CPF. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Certidões" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "cert-pf-debitos-trabalhistas" ], "description": "Identificador da consulta.", "example": "cert-pf-debitos-trabalhistas" }, "cpf": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "document": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cpf" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_cert_pf_debitos_trabalhistas" } }, "/api/cert-pf-divida-ativa-pgfn": { "post": { "summary": "Consulta de Dívida Ativa PGFN - PF", "description": "Pesquisa o CPF na lista de devedores e retorna o total de dívida ativa disponível. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Certidões" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "cert-pf-divida-ativa-pgfn" ], "description": "Identificador da consulta.", "example": "cert-pf-divida-ativa-pgfn" }, "cpf": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "document": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cpf" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_cert_pf_divida_ativa_pgfn" } }, "/api/cert-pf-embargos-ibama": { "post": { "summary": "Certidão de Embargos IBAMA - PF", "description": "Consulta a existência de embargos ambientais do IBAMA associados ao CPF. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Certidões" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "cert-pf-embargos-ibama" ], "description": "Identificador da consulta.", "example": "cert-pf-embargos-ibama" }, "cpf": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "document": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cpf" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_cert_pf_embargos_ibama" } }, "/api/cert-pf-judicial-nada-consta": { "post": { "summary": "Certidão Judicial Nada Consta - PF", "description": "Consulta certidão judicial de nada consta para o CPF. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Certidões" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "cert-pf-judicial-nada-consta" ], "description": "Identificador da consulta.", "example": "cert-pf-judicial-nada-consta" }, "cpf": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "document": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cpf" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_cert_pf_judicial_nada_consta" } }, "/api/cert-pf-negativa-cgu": { "post": { "summary": "Certidão Negativa CGU - PF", "description": "Consulta certidão negativa da Controladoria-Geral da União para o CPF. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Certidões" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "cert-pf-negativa-cgu" ], "description": "Identificador da consulta.", "example": "cert-pf-negativa-cgu" }, "cpf": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "document": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cpf" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_cert_pf_negativa_cgu" } }, "/api/cert-pf-negativa-cnj": { "post": { "summary": "Certidão Negativa CNJ - PF", "description": "Consulta certidão negativa de improbidade e inelegibilidade do CNJ para o CPF. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Certidões" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "cert-pf-negativa-cnj" ], "description": "Identificador da consulta.", "example": "cert-pf-negativa-cnj" }, "cpf": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "document": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cpf" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_cert_pf_negativa_cnj" } }, "/api/cert-pf-negativa-ibama": { "post": { "summary": "Certidão Negativa IBAMA - PF", "description": "Consulta certidão negativa do IBAMA para o CPF. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Certidões" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "cert-pf-negativa-ibama" ], "description": "Identificador da consulta.", "example": "cert-pf-negativa-ibama" }, "cpf": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "document": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cpf" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_cert_pf_negativa_ibama" } }, "/api/cert-pf-pgfn": { "post": { "summary": "Certidão PGFN - Pessoa Física", "description": "Consulta certidão de regularidade fiscal perante a PGFN e a Receita Federal. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Certidões" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "cert-pf-pgfn" ], "description": "Identificador da consulta.", "example": "cert-pf-pgfn" }, "cpf": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "document": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cpf" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_cert_pf_pgfn" } }, "/api/cert-pf-regularidade-ibama": { "post": { "summary": "Certidão de Regularidade IBAMA - PF", "description": "Consulta a certidão de regularidade do CPF nos cadastros do IBAMA. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Certidões" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "cert-pf-regularidade-ibama" ], "description": "Identificador da consulta.", "example": "cert-pf-regularidade-ibama" }, "cpf": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "document": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cpf" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_cert_pf_regularidade_ibama" } }, "/api/cert-pj-acoes-trabalhistas": { "post": { "summary": "Certidão de Ações Trabalhistas - PJ", "description": "Consulta certidão de ações trabalhistas vinculadas ao CNPJ. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Certidões" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "cert-pj-acoes-trabalhistas" ], "description": "Identificador da consulta.", "example": "cert-pj-acoes-trabalhistas" }, "cnpj": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "document": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cnpj" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_cert_pj_acoes_trabalhistas" } }, "/api/cert-pj-contratacao-pcd": { "post": { "summary": "Certidão de Contratação de PCD", "description": "Consulta a certidão de cumprimento da reserva legal para contratação de pessoas com deficiência. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Certidões" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "cert-pj-contratacao-pcd" ], "description": "Identificador da consulta.", "example": "cert-pj-contratacao-pcd" }, "cnpj": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "document": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cnpj" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_cert_pj_contratacao_pcd" } }, "/api/cert-pj-debitos-estaduais": { "post": { "summary": "Certidão de Débitos Estaduais - PJ", "description": "Consulta certidão estadual de débitos para o CNPJ e a UF informada. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Certidões" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "cert-pj-debitos-estaduais" ], "description": "Identificador da consulta.", "example": "cert-pj-debitos-estaduais" }, "cnpj": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "document": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "uf": { "type": "string", "minLength": 1, "description": "Sigla da UF com duas letras." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cnpj" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] }, { "anyOf": [ { "required": [ "uf" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_cert_pj_debitos_estaduais" } }, "/api/cert-pj-debitos-trabalhistas": { "post": { "summary": "Certidão de Débitos Trabalhistas - PJ", "description": "Consulta a Certidão Negativa de Débitos Trabalhistas do CNPJ. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Certidões" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "cert-pj-debitos-trabalhistas" ], "description": "Identificador da consulta.", "example": "cert-pj-debitos-trabalhistas" }, "cnpj": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "document": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cnpj" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_cert_pj_debitos_trabalhistas" } }, "/api/cert-pj-embargos-ibama": { "post": { "summary": "Certidão de Embargos IBAMA - PJ", "description": "Consulta a existência de embargos ambientais do IBAMA associados ao CNPJ. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Certidões" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "cert-pj-embargos-ibama" ], "description": "Identificador da consulta.", "example": "cert-pj-embargos-ibama" }, "cnpj": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "document": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cnpj" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_cert_pj_embargos_ibama" } }, "/api/cert-pj-fgts": { "post": { "summary": "Certidão FGTS", "description": "Consulta o Certificado de Regularidade do FGTS, situação e endereço da empresa. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Certidões" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "cert-pj-fgts" ], "description": "Identificador da consulta.", "example": "cert-pj-fgts" }, "cnpj": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "document": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cnpj" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_cert_pj_fgts" } }, "/api/cert-pj-negativa-cgu": { "post": { "summary": "Certidão Negativa CGU - PJ", "description": "Consulta certidão negativa da Controladoria-Geral da União para o CNPJ. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Certidões" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "cert-pj-negativa-cgu" ], "description": "Identificador da consulta.", "example": "cert-pj-negativa-cgu" }, "cnpj": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "document": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cnpj" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_cert_pj_negativa_cgu" } }, "/api/cert-pj-negativa-cnj": { "post": { "summary": "Certidão Negativa CNJ - PJ", "description": "Consulta certidão negativa de improbidade e inelegibilidade do CNJ para o CNPJ. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Certidões" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "cert-pj-negativa-cnj" ], "description": "Identificador da consulta.", "example": "cert-pj-negativa-cnj" }, "cnpj": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "document": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cnpj" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_cert_pj_negativa_cnj" } }, "/api/cert-pj-negativa-ibama": { "post": { "summary": "Certidão Negativa IBAMA - PJ", "description": "Consulta certidão negativa do IBAMA para o CNPJ. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Certidões" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "cert-pj-negativa-ibama" ], "description": "Identificador da consulta.", "example": "cert-pj-negativa-ibama" }, "cnpj": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "document": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cnpj" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_cert_pj_negativa_ibama" } }, "/api/cert-pj-pgfn": { "post": { "summary": "Certidão PGFN - Empresa", "description": "Consulta certidão de regularidade fiscal da empresa perante a PGFN e a Receita Federal. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Certidões" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "cert-pj-pgfn" ], "description": "Identificador da consulta.", "example": "cert-pj-pgfn" }, "cnpj": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "document": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cnpj" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_cert_pj_pgfn" } }, "/api/cert-pj-regularidade-ibama": { "post": { "summary": "Certidão de Regularidade IBAMA - PJ", "description": "Consulta a certidão de regularidade do CNPJ nos cadastros do IBAMA. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Certidões" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "cert-pj-regularidade-ibama" ], "description": "Identificador da consulta.", "example": "cert-pj-regularidade-ibama" }, "cnpj": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "document": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cnpj" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_cert_pj_regularidade_ibama" } }, "/api/cert-pj-situacao-cadastral": { "post": { "summary": "Certidão de Situação Cadastral", "description": "Consulta o comprovante e a situação cadastral atual do CNPJ na Receita Federal. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Certidões" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "cert-pj-situacao-cadastral" ], "description": "Identificador da consulta.", "example": "cert-pj-situacao-cadastral" }, "cnpj": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "document": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cnpj" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_cert_pj_situacao_cadastral" } }, "/api/check-stability-api": { "post": { "summary": "Verifica a estabilidade da API em tempo real", "tags": [ "Conta e créditos" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "endpoint": { "type": "string", "description": "endpoint" } }, "required": [ "endpoint" ], "additionalProperties": true } } } }, "x-mcp-executable": false, "operationId": "post_api_check_stability_api" } }, "/api/cnpj": { "post": { "summary": "CNPJ", "tags": [ "Dados e crédito" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "cnpj": { "type": "string", "description": "CNPJ da empresa consultada." }, "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "cnpj" ], "example": "cnpj" } }, "required": [ "link", "cnpj" ], "additionalProperties": true } } } }, "x-supported-methods": [ "post" ], "description": "Use POST com corpo JSON. A rota legada aceita outros métodos, mas eles não são recomendados para integração.", "x-mcp-executable": false, "operationId": "post_api_cnpj" } }, "/api/consulta-imoveis": { "post": { "summary": "Consulta de imóveis por CPF ou CNPJ", "tags": [ "Dados e crédito" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "consulta-imoveis" ], "example": "consulta-imoveis" }, "pdf": { "type": [ "string", "boolean", "integer" ], "description": "Opcional. A presença deste campo solicita o relatório PDF. Omita para retornar apenas os dados." }, "document": { "type": "string", "description": "CPF ou CNPJ do titular consultado." } }, "required": [ "link", "document" ], "additionalProperties": true } } } }, "x-mcp-executable": true, "operationId": "post_api_consulta_imoveis" } }, "/api/cp-cadastrais-score-dividas": { "post": { "summary": "Cadastrais - Score - Dívidas CP", "tags": [ "Dados e crédito" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "cp-cadastrais-score-dividas" ], "example": "cp-cadastrais-score-dividas" }, "pdf": { "type": [ "string", "boolean", "integer" ], "description": "Opcional. A presença deste campo solicita o relatório PDF. Omita para retornar apenas os dados." }, "document": { "type": "string", "description": "CPF ou CNPJ do titular consultado." } }, "required": [ "link", "document" ], "additionalProperties": true } } } }, "x-mcp-executable": true, "operationId": "post_api_cp_cadastrais_score_dividas" } }, "/api/cpf-ultra": { "post": { "summary": "Busca por reconhecimento facial", "tags": [ "Dados e crédito" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "cpf-ultra" ], "example": "cpf-ultra" }, "pdf": { "type": [ "string", "boolean", "integer" ], "description": "Opcional. A presença deste campo solicita o relatório PDF. Omita para retornar apenas os dados." }, "cpf": { "type": "string", "description": "CPF do titular consultado." } }, "required": [ "link", "cpf" ], "additionalProperties": true } } } }, "x-mcp-executable": true, "operationId": "post_api_cpf_ultra" } }, "/api/credito-positivo": { "post": { "summary": "Busca por Crédito Positivo Serasa e SPC Brasil", "tags": [ "Dados e crédito" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "credito-positivo" ], "example": "credito-positivo" }, "pdf": { "type": [ "string", "boolean", "integer" ], "description": "Opcional. A presença deste campo solicita o relatório PDF. Omita para retornar apenas os dados." }, "document": { "type": "string", "description": "CPF ou CNPJ do titular consultado." } }, "required": [ "link", "document" ], "additionalProperties": true } } } }, "x-mcp-executable": true, "operationId": "post_api_credito_positivo" } }, "/api/credits/insert": { "post": { "summary": "Recarregar créditos", "tags": [ "Conta e créditos" ], "responses": { "200": { "description": "Resultado da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "amount": { "oneOf": [ { "type": "number", "minimum": 10, "maximum": 100000 }, { "type": "string" } ], "description": "Valor em reais entre 10 e 100.000. Aceita string decimal com ponto ou vírgula." }, "payment_method": { "type": "string", "enum": [ "pix", "boleto" ], "default": "pix" }, "address": { "type": "object", "description": "Obrigatório para boleto quando solicitado pelo provedor de cobrança.", "properties": { "zipcode": { "type": "string" }, "street": { "type": "string" }, "number": { "type": "string" }, "complement": { "type": "string" }, "neighborhood": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" } } } }, "additionalProperties": true, "required": [ "amount" ] } } } }, "description": "Cria a cobrança. Os créditos são liberados após confirmação do pagamento.", "operationId": "post_api_credits_insert" } }, "/api/credits/statement": { "get": { "summary": "Extrato de créditos", "tags": [ "Conta e créditos" ], "responses": { "200": { "description": "Resultado da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "parameters": [ { "name": "start_date", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "end_date", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "consultation", "in": "query", "schema": { "type": "string" } }, { "name": "client", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1 } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } } ], "description": "Intervalo máximo de 366 dias. Por padrão, retorna os últimos 30 dias.", "operationId": "get_api_credits_statement" } }, "/api/crlv": { "post": { "summary": "Busca dados CRLV-MG", "tags": [ "Veículos" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "crlv" ], "example": "crlv" }, "placa": { "type": "string", "description": "Placa do veículo." }, "state": { "type": "string", "description": "Código da UF: AL 1345, AP 1696, BA 1747, GO 1697, MA 1698, MG 1680, MT 1700, PA 1701, PR 1703, PI 1702, RO 1769, RR 1750, SP 1704, SE 1348, TO 1705.", "enum": [ "1345", "1696", "1747", "1697", "1698", "1680", "1700", "1701", "1703", "1702", "1769", "1750", "1704", "1348", "1705" ] } }, "required": [ "link", "placa", "state" ], "additionalProperties": true } } } }, "x-mcp-executable": true, "operationId": "post_api_crlv" } }, "/api/csv-renainf-renajud-recall-bin-proprietario": { "post": { "summary": "Busca dados Consulta integrada que reúne múltiplas verificações em uma única pesquisa", "tags": [ "Veículos" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "csv-renainf-renajud-recall-bin-proprietario" ], "example": "csv-renainf-renajud-recall-bin-proprietario" }, "placa": { "type": "string", "description": "Placa do veículo." } }, "required": [ "link", "placa" ], "additionalProperties": true } } } }, "x-mcp-executable": true, "operationId": "post_api_csv_renainf_renajud_recall_bin_proprietario" } }, "/api/csv-v2": { "post": { "summary": "Consulta CSV V2", "tags": [ "Veículos" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "csv-v2" ], "example": "csv-v2" }, "pdf": { "type": [ "string", "boolean", "integer" ], "description": "Opcional. A presença deste campo solicita o relatório PDF. Omita para retornar apenas os dados." }, "placa": { "type": "string", "description": "Placa do veículo." } }, "required": [ "link", "placa" ], "additionalProperties": true } } } }, "x-mcp-executable": true, "operationId": "post_api_csv_v2" } }, "/api/curtidas-instagram-mundiais": { "post": { "summary": "Coloca 1000 curtidas mundiais no Instagram", "tags": [ "Comunicação" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "curtidas-instagram-mundiais" ], "example": "curtidas-instagram-mundiais" }, "campo": { "type": "string", "description": "campo" } }, "required": [ "link", "campo" ], "additionalProperties": true } } } }, "x-supported-methods": [ "post" ], "description": "Use POST com corpo JSON. A rota legada aceita outros métodos, mas eles não são recomendados para integração.", "x-mcp-executable": false, "operationId": "post_api_curtidas_instagram_mundiais" } }, "/api/curtidas-instagram-mundiais-cem": { "post": { "summary": "Coloca 100 curtidas mundiais no Instagram", "tags": [ "Comunicação" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "curtidas-instagram-mundiais-cem" ], "example": "curtidas-instagram-mundiais-cem" }, "campo": { "type": "string", "description": "campo" } }, "required": [ "link", "campo" ], "additionalProperties": true } } } }, "x-supported-methods": [ "post" ], "description": "Use POST com corpo JSON. A rota legada aceita outros métodos, mas eles não são recomendados para integração.", "x-mcp-executable": false, "operationId": "post_api_curtidas_instagram_mundiais_cem" } }, "/api/debitos-veicular": { "post": { "summary": "Busca por débitos veicular", "tags": [ "Veículos" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "debitos-veicular" ], "example": "debitos-veicular" }, "pdf": { "type": [ "string", "boolean", "integer" ], "description": "Opcional. A presença deste campo solicita o relatório PDF. Omita para retornar apenas os dados." }, "placa": { "type": "string", "description": "Placa do veículo." } }, "required": [ "link", "placa" ], "additionalProperties": true } } } }, "x-mcp-executable": true, "operationId": "post_api_debitos_veicular" } }, "/api/e-boavista": { "post": { "summary": "Busca dados de crédito do Boa Vista com ou sem CENPROT", "tags": [ "Dados e crédito" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "e-boavista" ], "example": "e-boavista" }, "pdf": { "type": [ "string", "boolean", "integer" ], "description": "Opcional. A presença deste campo solicita o relatório PDF. Omita para retornar apenas os dados." }, "document": { "type": "string", "description": "CPF ou CNPJ do titular consultado." }, "cenprot": { "type": "string", "description": "cenprot" } }, "required": [ "link", "document" ], "additionalProperties": true } } } }, "x-mcp-executable": true, "operationId": "post_api_e_boavista" } }, "/api/e-cenprot": { "post": { "summary": "Busca dados de protestos nacional", "tags": [ "Dados e crédito" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "e-cenprot" ], "example": "e-cenprot" }, "pdf": { "type": [ "string", "boolean", "integer" ], "description": "Opcional. A presença deste campo solicita o relatório PDF. Omita para retornar apenas os dados." }, "document": { "type": "string", "description": "CPF ou CNPJ do titular consultado." } }, "required": [ "link", "document" ], "additionalProperties": true } } } }, "x-mcp-executable": true, "operationId": "post_api_e_cenprot" } }, "/api/fake-nada-consta": { "post": { "summary": "Fake Nada consta", "tags": [ "Ferramentas" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "cpf": { "type": "string", "description": "CPF do titular consultado." }, "score": { "type": "integer", "minimum": 0, "maximum": 1000 }, "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "fake-nada-consta" ], "example": "fake-nada-consta" } }, "required": [ "link", "cpf", "score" ], "additionalProperties": true } } } }, "x-mcp-executable": false, "operationId": "post_api_fake_nada_consta" } }, "/api/fipe": { "post": { "summary": "FIPE", "tags": [ "Veículos" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "fipe" ], "example": "fipe" }, "pdf": { "type": [ "string", "boolean", "integer" ], "description": "Opcional. A presença deste campo solicita o relatório PDF. Omita para retornar apenas os dados." }, "placa": { "type": "string", "description": "Placa do veículo." } }, "required": [ "link", "placa" ], "additionalProperties": true } } } }, "x-mcp-executable": true, "operationId": "post_api_fipe" } }, "/api/get-balance": { "get": { "summary": "Traz o saldo atual do usuário", "tags": [ "Conta e créditos" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": false, "operationId": "get_api_get_balance" } }, "/api/get-payment": { "post": { "summary": "Recarga de créditos (legado)", "tags": [ "Conta e créditos" ], "responses": { "200": { "description": "Resultado da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "value": { "type": "string", "description": "Valor em centavos, mínimo 1000." }, "type": { "type": "string", "enum": [ "1", "2" ], "description": "1: PIX; 2: boleto." }, "invoice": { "type": "string" } }, "additionalProperties": true, "required": [ "value" ] } } } }, "deprecated": true, "operationId": "post_api_get_payment" } }, "/api/gravame": { "post": { "summary": "Busca dados gravame", "tags": [ "Veículos" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "gravame" ], "example": "gravame" }, "chassi": { "type": "string", "description": "chassi" } }, "required": [ "link", "chassi" ], "additionalProperties": true } } } }, "x-mcp-executable": true, "operationId": "post_api_gravame" } }, "/api/ic-bacen": { "post": { "summary": "SCR Bacen e score", "tags": [ "Dados e crédito" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "ic-bacen" ], "example": "ic-bacen" }, "document": { "type": "string", "description": "CPF ou CNPJ do titular consultado." } }, "required": [ "link", "document" ], "additionalProperties": true } } } }, "x-mcp-executable": true, "operationId": "post_api_ic_bacen" } }, "/api/ic-bin-estadual": { "post": { "summary": "BIN Estadual", "tags": [ "Veículos" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "ic-bin-estadual" ], "example": "ic-bin-estadual" }, "placa": { "type": "string", "description": "Placa do veículo." } }, "required": [ "link", "placa" ], "additionalProperties": true } } } }, "x-mcp-executable": true, "operationId": "post_api_ic_bin_estadual" } }, "/api/ic-bin-nacional": { "post": { "summary": "BIN Nacional", "tags": [ "Veículos" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "ic-bin-nacional" ], "example": "ic-bin-nacional" }, "placa": { "type": "string", "description": "Placa do veículo." } }, "required": [ "link", "placa" ], "additionalProperties": true } } } }, "x-mcp-executable": true, "operationId": "post_api_ic_bin_nacional" } }, "/api/ic-cndt": { "post": { "summary": "Certidão Nacional de Débitos Trabalhistas", "tags": [ "Dados e crédito" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "ic-cndt" ], "example": "ic-cndt" }, "document": { "type": "string", "description": "CPF ou CNPJ do titular consultado." } }, "required": [ "link", "document" ], "additionalProperties": true } } } }, "x-mcp-executable": true, "operationId": "post_api_ic_cndt" } }, "/api/ic-cpf-completo": { "post": { "summary": "CPF Completo", "tags": [ "Dados e crédito" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "ic-cpf-completo" ], "example": "ic-cpf-completo" }, "cpf": { "type": "string", "description": "CPF do titular consultado." } }, "required": [ "link", "cpf" ], "additionalProperties": true } } } }, "x-mcp-executable": true, "operationId": "post_api_ic_cpf_completo" } }, "/api/ic-foto-leilao": { "post": { "summary": "Foto Leilão", "tags": [ "Veículos" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "ic-foto-leilao" ], "example": "ic-foto-leilao" }, "placa": { "type": "string", "description": "Placa do veículo." } }, "required": [ "link", "placa" ], "additionalProperties": true } } } }, "x-mcp-executable": true, "operationId": "post_api_ic_foto_leilao" } }, "/api/ic-historico-roubo-furto": { "post": { "summary": "Histórico de roubo ou furto", "tags": [ "Veículos" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "ic-historico-roubo-furto" ], "example": "ic-historico-roubo-furto" }, "placa": { "type": "string", "description": "Placa do veículo." } }, "required": [ "link", "placa" ], "additionalProperties": true } } } }, "x-mcp-executable": false, "deprecated": true, "description": "Rota legada registrada, mas sem implementação do identificador no controller atual. Não utilizar para novas integrações.", "operationId": "post_api_ic_historico_roubo_furto" } }, "/api/ic-nome": { "post": { "summary": "Busca por Nome", "tags": [ "Consultas" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "ic-nome" ], "example": "ic-nome" }, "name": { "type": "string", "description": "name" }, "state": { "type": "string", "description": "Código de estado aceito por esta consulta." } }, "required": [ "link", "name", "state" ], "additionalProperties": true } } } }, "x-mcp-executable": true, "operationId": "post_api_ic_nome" } }, "/api/ic-proprietario-atual": { "post": { "summary": "Proprietário placa", "tags": [ "Veículos" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "ic-proprietario-atual" ], "example": "ic-proprietario-atual" }, "placa": { "type": "string", "description": "Placa do veículo." } }, "required": [ "link", "placa" ], "additionalProperties": true } } } }, "x-mcp-executable": true, "operationId": "post_api_ic_proprietario_atual" } }, "/api/ic-quod": { "post": { "summary": "QUOD", "tags": [ "Dados e crédito" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "ic-quod" ], "example": "ic-quod" }, "document": { "type": "string", "description": "CPF ou CNPJ do titular consultado." } }, "required": [ "link", "document" ], "additionalProperties": true } } } }, "x-mcp-executable": true, "operationId": "post_api_ic_quod" } }, "/api/ic-recall": { "post": { "summary": "Recall", "tags": [ "Veículos" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "ic-recall" ], "example": "ic-recall" }, "placa": { "type": "string", "description": "Placa do veículo." } }, "required": [ "link", "placa" ], "additionalProperties": true } } } }, "x-mcp-executable": true, "operationId": "post_api_ic_recall" } }, "/api/ic-vipcar": { "post": { "summary": "Consulta de Vipcar", "tags": [ "Veículos" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "ic-vipcar" ], "example": "ic-vipcar" }, "placa": { "type": "string", "description": "Placa do veículo." } }, "required": [ "link", "placa" ], "additionalProperties": true } } } }, "x-mcp-executable": true, "operationId": "post_api_ic_vipcar" } }, "/api/leilao": { "post": { "summary": "Busca dados Leilão", "tags": [ "Veículos" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "leilao" ], "example": "leilao" }, "placa": { "type": "string", "description": "Placa do veículo." } }, "required": [ "link", "placa" ], "additionalProperties": true } } } }, "x-mcp-executable": true, "operationId": "post_api_leilao" } }, "/api/mail-send": { "post": { "summary": "Envia e-mails", "tags": [ "Ferramentas" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "emails": { "type": "string", "description": "emails" }, "from": { "type": "string", "description": "from" }, "subject": { "type": "string", "description": "subject" }, "content": { "type": "string", "description": "content" }, "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "mail-send" ], "example": "mail-send" } }, "required": [ "link", "emails", "from", "subject", "content" ], "additionalProperties": true } } } }, "x-mcp-executable": false, "operationId": "post_api_mail_send" } }, "/api/make-code": { "post": { "summary": "API que cria uma página com IA para o cliente", "tags": [ "Ferramentas" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "prompt": { "type": "string", "description": "prompt" }, "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "make-code" ], "example": "make-code" } }, "required": [ "link", "prompt" ], "additionalProperties": true } } } }, "x-mcp-executable": false, "operationId": "post_api_make_code" } }, "/api/mercado-concorrencia": { "post": { "summary": "Score de Concorrência", "description": "Mede a presença e intensidade de concorrentes por segmentos na região do CEP. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Análise de Mercado" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "mercado-concorrencia" ], "description": "Identificador da consulta.", "example": "mercado-concorrencia" }, "cep": { "type": "string", "minLength": 1, "description": "CEP com 8 dígitos; aceita pontuação." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cep" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_mercado_concorrencia" } }, "/api/mercado-gastos-alimentacao": { "post": { "summary": "Gastos com Alimentação por CEP", "description": "Estima gastos com alimentação dos domicílios localizados no CEP. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Análise de Mercado" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "mercado-gastos-alimentacao" ], "description": "Identificador da consulta.", "example": "mercado-gastos-alimentacao" }, "cep": { "type": "string", "minLength": 1, "description": "CEP com 8 dígitos; aceita pontuação." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cep" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_mercado_gastos_alimentacao" } }, "/api/mercado-gastos-consumo": { "post": { "summary": "Gastos com Consumo por CEP", "description": "Estima despesas de consumo recorrente dos domicílios localizados no CEP. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Análise de Mercado" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "mercado-gastos-consumo" ], "description": "Identificador da consulta.", "example": "mercado-gastos-consumo" }, "cep": { "type": "string", "minLength": 1, "description": "CEP com 8 dígitos; aceita pontuação." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cep" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_mercado_gastos_consumo" } }, "/api/mercado-gastos-diversos": { "post": { "summary": "Gastos com Despesas Diversas", "description": "Estima gastos diversos, comunicação, eventos e imóveis de uso ocasional no CEP. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Análise de Mercado" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "mercado-gastos-diversos" ], "description": "Identificador da consulta.", "example": "mercado-gastos-diversos" }, "cep": { "type": "string", "minLength": 1, "description": "CEP com 8 dígitos; aceita pontuação." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cep" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_mercado_gastos_diversos" } }, "/api/mercado-gastos-educacao": { "post": { "summary": "Gastos com Educação por CEP", "description": "Estima despesas com educação, cursos, livros e atividades educacionais no CEP. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Análise de Mercado" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "mercado-gastos-educacao" ], "description": "Identificador da consulta.", "example": "mercado-gastos-educacao" }, "cep": { "type": "string", "minLength": 1, "description": "CEP com 8 dígitos; aceita pontuação." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cep" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_mercado_gastos_educacao" } }, "/api/mercado-gastos-habitacao": { "post": { "summary": "Gastos com Habitação por CEP", "description": "Estima despesas com moradia, manutenção do lar e artigos de limpeza no CEP. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Análise de Mercado" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "mercado-gastos-habitacao" ], "description": "Identificador da consulta.", "example": "mercado-gastos-habitacao" }, "cep": { "type": "string", "minLength": 1, "description": "CEP com 8 dígitos; aceita pontuação." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cep" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_mercado_gastos_habitacao" } }, "/api/mercado-gastos-higiene": { "post": { "summary": "Gastos com Higiene e Cuidados", "description": "Estima despesas com higiene e cuidados pessoais dos domicílios no CEP. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Análise de Mercado" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "mercado-gastos-higiene" ], "description": "Identificador da consulta.", "example": "mercado-gastos-higiene" }, "cep": { "type": "string", "minLength": 1, "description": "CEP com 8 dígitos; aceita pontuação." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cep" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_mercado_gastos_higiene" } }, "/api/mercado-gastos-recreacao": { "post": { "summary": "Gastos com Recreação e Cultura", "description": "Estima despesas com lazer, recreação, cultura e serviços relacionados no CEP. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Análise de Mercado" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "mercado-gastos-recreacao" ], "description": "Identificador da consulta.", "example": "mercado-gastos-recreacao" }, "cep": { "type": "string", "minLength": 1, "description": "CEP com 8 dígitos; aceita pontuação." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cep" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_mercado_gastos_recreacao" } }, "/api/mercado-gastos-saude": { "post": { "summary": "Gastos com Assistência à Saúde", "description": "Estima gastos com planos, consultas, tratamentos e hospitalização no CEP. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Análise de Mercado" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "mercado-gastos-saude" ], "description": "Identificador da consulta.", "example": "mercado-gastos-saude" }, "cep": { "type": "string", "minLength": 1, "description": "CEP com 8 dígitos; aceita pontuação." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cep" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_mercado_gastos_saude" } }, "/api/mercado-gastos-servicos": { "post": { "summary": "Gastos com Serviços por CEP", "description": "Estima despesas domiciliares com serviços, pacotes de telecomunicações e utilidades. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Análise de Mercado" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "mercado-gastos-servicos" ], "description": "Identificador da consulta.", "example": "mercado-gastos-servicos" }, "cep": { "type": "string", "minLength": 1, "description": "CEP com 8 dígitos; aceita pontuação." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cep" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_mercado_gastos_servicos" } }, "/api/mercado-gastos-transporte": { "post": { "summary": "Gastos com Transporte por CEP", "description": "Estima despesas com transporte, combustível e manutenção de veículos no CEP. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Análise de Mercado" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "mercado-gastos-transporte" ], "description": "Identificador da consulta.", "example": "mercado-gastos-transporte" }, "cep": { "type": "string", "minLength": 1, "description": "CEP com 8 dígitos; aceita pontuação." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cep" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_mercado_gastos_transporte" } }, "/api/mercado-gastos-vestuario": { "post": { "summary": "Gastos com Vestuário por CEP", "description": "Estima despesas com vestuário, calçados e acessórios dos domicílios no CEP. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Análise de Mercado" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "mercado-gastos-vestuario" ], "description": "Identificador da consulta.", "example": "mercado-gastos-vestuario" }, "cep": { "type": "string", "minLength": 1, "description": "CEP com 8 dígitos; aceita pontuação." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cep" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_mercado_gastos_vestuario" } }, "/api/mercado-infraestrutura-urbana": { "post": { "summary": "Índice de Infraestrutura Urbana", "description": "Avalia qualidade de vida, padrão de vida e infraestrutura urbana da região do CEP. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Análise de Mercado" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "mercado-infraestrutura-urbana" ], "description": "Identificador da consulta.", "example": "mercado-infraestrutura-urbana" }, "cep": { "type": "string", "minLength": 1, "description": "CEP com 8 dígitos; aceita pontuação." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cep" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_mercado_infraestrutura_urbana" } }, "/api/mercado-macroeconomicos": { "post": { "summary": "Indicadores Macroeconômicos", "description": "Apresenta indicadores de crescimento econômico e urbanístico para o CEP. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Análise de Mercado" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "mercado-macroeconomicos" ], "description": "Identificador da consulta.", "example": "mercado-macroeconomicos" }, "cep": { "type": "string", "minLength": 1, "description": "CEP com 8 dígitos; aceita pontuação." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cep" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_mercado_macroeconomicos" } }, "/api/mercado-outras-despesas": { "post": { "summary": "Gastos com Outras Despesas", "description": "Estima outras despesas e aquisição de ativos dos domicílios no CEP. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Análise de Mercado" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "mercado-outras-despesas" ], "description": "Identificador da consulta.", "example": "mercado-outras-despesas" }, "cep": { "type": "string", "minLength": 1, "description": "CEP com 8 dígitos; aceita pontuação." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cep" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_mercado_outras_despesas" } }, "/api/mercado-precos-saude": { "post": { "summary": "Índice de Preços de Serviços de Saúde", "description": "Apresenta índices de preços e modalidades de seguros e serviços de saúde no CEP. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Análise de Mercado" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "mercado-precos-saude" ], "description": "Identificador da consulta.", "example": "mercado-precos-saude" }, "cep": { "type": "string", "minLength": 1, "description": "CEP com 8 dígitos; aceita pontuação." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cep" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_mercado_precos_saude" } }, "/api/mercado-propensao-seguro": { "post": { "summary": "Índice de Propensão a Seguro", "description": "Estima a propensão regional à contratação de seguros e planos odontológicos. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Análise de Mercado" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "mercado-propensao-seguro" ], "description": "Identificador da consulta.", "example": "mercado-propensao-seguro" }, "cep": { "type": "string", "minLength": 1, "description": "CEP com 8 dígitos; aceita pontuação." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cep" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_mercado_propensao_seguro" } }, "/api/mercado-risco-geografico": { "post": { "summary": "Risco Geográfico", "description": "Avalia riscos geográficos e indicadores de colisão automotiva na região do CEP. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Análise de Mercado" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "mercado-risco-geografico" ], "description": "Identificador da consulta.", "example": "mercado-risco-geografico" }, "cep": { "type": "string", "minLength": 1, "description": "CEP com 8 dígitos; aceita pontuação." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cep" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_mercado_risco_geografico" } }, "/api/mercado-seguro-patologia": { "post": { "summary": "Índice de Seguro por Patologia", "description": "Apresenta indicadores regionais de patologias relevantes para análise de seguros. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Análise de Mercado" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "mercado-seguro-patologia" ], "description": "Identificador da consulta.", "example": "mercado-seguro-patologia" }, "cep": { "type": "string", "minLength": 1, "description": "CEP com 8 dígitos; aceita pontuação." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cep" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_mercado_seguro_patologia" } }, "/api/mercado-sociodemografico": { "post": { "summary": "Dados Sociodemográficos por CEP", "description": "Apresenta população, domicílios, renda, gênero e faixas etárias estimadas para o CEP. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Análise de Mercado" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "mercado-sociodemografico" ], "description": "Identificador da consulta.", "example": "mercado-sociodemografico" }, "cep": { "type": "string", "minLength": 1, "description": "CEP com 8 dígitos; aceita pontuação." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cep" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_mercado_sociodemografico" } }, "/api/nome-endereco": { "post": { "summary": "Busca por reversa por nome e/ou endereço", "tags": [ "Consultas" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "nome-endereco" ], "example": "nome-endereco" }, "pdf": { "type": [ "string", "boolean", "integer" ], "description": "Opcional. A presença deste campo solicita o relatório PDF. Omita para retornar apenas os dados." }, "nome": { "type": "string", "description": "nome" }, "nomeExato": { "type": "string", "description": "nomeExato" }, "mae": { "type": "string", "description": "mae" }, "maeExato": { "type": "string", "description": "maeExato" }, "pai": { "type": "string", "description": "pai" }, "paiExato": { "type": "string", "description": "paiExato" }, "idade": { "type": "string", "description": "idade" }, "dataNasc": { "type": "string", "description": "dataNasc" }, "cep": { "type": "string", "description": "cep" }, "numero": { "type": "string", "description": "numero" }, "estado": { "type": "string", "description": "estado" }, "cidade": { "type": "string", "description": "cidade" } }, "required": [ "link" ], "additionalProperties": true, "anyOf": [ { "required": [ "nome" ] }, { "required": [ "nomeExato" ] }, { "required": [ "mae" ] }, { "required": [ "maeExato" ] }, { "required": [ "pai" ] }, { "required": [ "paiExato" ] }, { "required": [ "idade" ] }, { "required": [ "dataNasc" ] }, { "required": [ "cep" ] }, { "required": [ "numero" ] }, { "required": [ "estado" ] }, { "required": [ "cidade" ] } ] } } } }, "x-mcp-executable": true, "operationId": "post_api_nome_endereco" } }, "/api/pessoa-telefone": { "post": { "summary": "Busca de pessoa por telefone", "tags": [ "Consultas" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "pessoa-telefone" ], "example": "pessoa-telefone" }, "pdf": { "type": [ "string", "boolean", "integer" ], "description": "Opcional. A presença deste campo solicita o relatório PDF. Omita para retornar apenas os dados." }, "telefone": { "type": "string", "description": "telefone" } }, "required": [ "link", "telefone" ], "additionalProperties": true } } } }, "x-mcp-executable": true, "operationId": "post_api_pessoa_telefone" } }, "/api/pessoas-cep": { "post": { "summary": "Consulta de pessoas por CEP", "tags": [ "Consultas" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "pessoas-cep" ], "example": "pessoas-cep" }, "pdf": { "type": [ "string", "boolean", "integer" ], "description": "Opcional. A presença deste campo solicita o relatório PDF. Omita para retornar apenas os dados." }, "cep": { "type": "string", "description": "cep" }, "page": { "type": "string", "description": "page" } }, "required": [ "link", "cep", "page" ], "additionalProperties": true } } } }, "x-mcp-executable": true, "operationId": "post_api_pessoas_cep" } }, "/api/pf-assistencia-social": { "post": { "summary": "Assistência Social", "description": "Consulta benefícios e auxílios sociais vinculados ao CPF, com situação, período e valores disponíveis. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Dados" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pf-assistencia-social" ], "description": "Identificador da consulta.", "example": "pf-assistencia-social" }, "cpf": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "document": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cpf" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pf_assistencia_social" } }, "/api/pf-carteira-idoso": { "post": { "summary": "Carteira da Pessoa Idosa", "description": "Valida a Carteira da Pessoa Idosa e retorna situação, emissão, identificação e NIS. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Dados" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pf-carteira-idoso" ], "description": "Identificador da consulta.", "example": "pf-carteira-idoso" }, "cpf": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "document": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cpf" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pf_carteira_idoso" } }, "/api/pf-celulares-hot": { "post": { "summary": "Celulares Hot", "description": "Retorna celulares priorizados da base hot, incluindo tipo e indicadores de contato disponíveis. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Dados" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pf-celulares-hot" ], "description": "Identificador da consulta.", "example": "pf-celulares-hot" }, "cpf": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "document": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cpf" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pf_celulares_hot" } }, "/api/pf-celulares-hot-email": { "post": { "summary": "Celulares Hot e E-mail", "description": "Combina celulares priorizados da base hot com os e-mails mais relevantes associados ao CPF. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Dados" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pf-celulares-hot-email" ], "description": "Identificador da consulta.", "example": "pf-celulares-hot-email" }, "cpf": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "document": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cpf" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pf_celulares_hot_email" } }, "/api/pf-cnh": { "post": { "summary": "Carteira Nacional de Habilitação", "description": "Consulta dados da CNH, categoria, validade, RENACH, filiação e eventuais débitos vinculados. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Dados" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pf-cnh" ], "description": "Identificador da consulta.", "example": "pf-cnh" }, "cpf": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "document": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cpf" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pf_cnh" } }, "/api/pf-cnh-v2": { "post": { "summary": "Carteira Nacional de Habilitação V2", "description": "Consulta ampliada da CNH com foto, categoria, validade, RENACH, filiação e débitos. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Dados" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pf-cnh-v2" ], "description": "Identificador da consulta.", "example": "pf-cnh-v2" }, "cpf": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "document": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cpf" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pf_cnh_v2" } }, "/api/pf-compliance-pld-v3": { "post": { "summary": "Compliance PLD V3 - Pessoa Física", "description": "Análise de compliance e prevenção à lavagem de dinheiro com PEP, sanções, processos e nível de risco. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Compliance" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pf-compliance-pld-v3" ], "description": "Identificador da consulta.", "example": "pf-compliance-pld-v3" }, "cpf": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "document": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cpf" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pf_compliance_pld_v3" } }, "/api/pf-conselhos-classe": { "post": { "summary": "Conselhos de Classe", "description": "Consulta registros profissionais em conselhos de classe, com categoria, situação e período de filiação. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Dados" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pf-conselhos-classe" ], "description": "Identificador da consulta.", "example": "pf-conselhos-classe" }, "cpf": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "document": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cpf" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pf_conselhos_classe" } }, "/api/pf-corretor-seguros": { "post": { "summary": "Corretor de Seguros de Danos", "description": "Verifica o registro de corretor de seguros de danos, produtos autorizados e situação cadastral. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Dados" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pf-corretor-seguros" ], "description": "Identificador da consulta.", "example": "pf-corretor-seguros" }, "cpf": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "document": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cpf" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pf_corretor_seguros" } }, "/api/pf-credito-completo": { "post": { "summary": "Análise de Crédito Completa", "description": "Análise ampla de crédito com dados cadastrais, score, negativações, protestos, consultas e ocorrências. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Dívidas e Crédito" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pf-credito-completo" ], "description": "Identificador da consulta.", "example": "pf-credito-completo" }, "cpf": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "document": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cpf" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pf_credito_completo" } }, "/api/pf-credito-essencial": { "post": { "summary": "Análise de Crédito Essencial", "description": "Análise essencial de crédito com score, negativações, protestos e principais dados cadastrais. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Dívidas e Crédito" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pf-credito-essencial" ], "description": "Identificador da consulta.", "example": "pf-credito-essencial" }, "cpf": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "document": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cpf" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pf_credito_essencial" } }, "/api/pf-credito-mais": { "post": { "summary": "Análise de Crédito Mais", "description": "Análise intermediária de crédito com score, restrições, protestos, consultas e telefone vinculado. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Dívidas e Crédito" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pf-credito-mais" ], "description": "Identificador da consulta.", "example": "pf-credito-mais" }, "cpf": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "document": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cpf" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pf_credito_mais" } }, "/api/pf-dados-cadastrais": { "post": { "summary": "Dados Cadastrais Básicos", "description": "Retorna identificação, filiação, nascimento, situação na Receita Federal e outros dados cadastrais do CPF. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Dados" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pf-dados-cadastrais" ], "description": "Identificador da consulta.", "example": "pf-dados-cadastrais" }, "cpf": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "document": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cpf" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pf_dados_cadastrais" } }, "/api/pf-dados-contato": { "post": { "summary": "Dados Cadastrais e Contato", "description": "Retorna em uma consulta dados cadastrais, telefones, e-mails e endereços associados ao CPF. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Dados" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pf-dados-contato" ], "description": "Identificador da consulta.", "example": "pf-dados-contato" }, "cpf": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "document": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cpf" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pf_dados_contato" } }, "/api/pf-dados-financeiros": { "post": { "summary": "Dados Financeiros", "description": "Apresenta estimativas de renda, patrimônio, classe social e capacidade financeira da pessoa. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Dívidas e Crédito" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pf-dados-financeiros" ], "description": "Identificador da consulta.", "example": "pf-dados-financeiros" }, "cpf": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "document": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "cep": { "type": "string", "minLength": 1, "description": "CEP com 8 dígitos; aceita pontuação." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cpf" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] }, { "anyOf": [ { "required": [ "cep" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pf_dados_financeiros" } }, "/api/pf-dados-profissionais": { "post": { "summary": "Dados Profissionais", "description": "Retorna vínculos profissionais, empregadores, ocupações e participações empresariais disponíveis. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Dados" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pf-dados-profissionais" ], "description": "Identificador da consulta.", "example": "pf-dados-profissionais" }, "cpf": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "document": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cpf" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pf_dados_profissionais" } }, "/api/pf-dadosbasicos": { "post": { "summary": "CPF simples", "tags": [ "Dados e crédito" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "pf-dadosbasicos" ], "example": "pf-dadosbasicos" }, "cpf": { "type": "string", "description": "CPF do titular consultado." }, "pdf": { "type": [ "string", "boolean", "integer" ], "description": "Opcional. A presença deste campo solicita o relatório PDF. Omita para retornar apenas os dados." } }, "required": [ "link", "cpf" ], "additionalProperties": true } } } }, "x-mcp-executable": true, "operationId": "post_api_pf_dadosbasicos" } }, "/api/pf-darkweb": { "post": { "summary": "Exposição na Dark Web - Pessoa Física", "description": "Pesquisa exposição de e-mail ou telefone em vazamentos conhecidos na dark web. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Compliance" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pf-darkweb" ], "description": "Identificador da consulta.", "example": "pf-darkweb" }, "cpf": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação." }, "phone": { "type": "string", "minLength": 1, "description": "Telefone com 10 a 13 dígitos, incluindo DDD." }, "telefone": { "type": "string", "minLength": 1, "description": "Telefone com 10 a 13 dígitos, incluindo DDD. Alternativa a phone." }, "email": { "type": "string", "minLength": 1, "description": "Endereço de e-mail." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "email" ] }, { "required": [ "phone" ] }, { "required": [ "telefone" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pf_darkweb" } }, "/api/pf-doacoes-politicas": { "post": { "summary": "Doações Políticas - Pessoa Física", "description": "Consulta doações eleitorais vinculadas ao CPF, incluindo eleição, partido, candidato e valores. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Compliance" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pf-doacoes-politicas" ], "description": "Identificador da consulta.", "example": "pf-doacoes-politicas" }, "cpf": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "document": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cpf" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pf_doacoes_politicas" } }, "/api/pf-emails": { "post": { "summary": "E-mails - Pessoa Física", "description": "Retorna e-mails associados ao CPF com domínio, tipo, prioridade, similaridade e qualidade. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Dados" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pf-emails" ], "description": "Identificador da consulta.", "example": "pf-emails" }, "cpf": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "document": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cpf" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pf_emails" } }, "/api/pf-empresas-societarias": { "post": { "summary": "Empresas Societárias - Pessoa Física", "description": "Lista empresas das quais a pessoa participa ou participou, com situação e período do vínculo societário. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Dados" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pf-empresas-societarias" ], "description": "Identificador da consulta.", "example": "pf-empresas-societarias" }, "cpf": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "document": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cpf" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pf_empresas_societarias" } }, "/api/pf-enderecos": { "post": { "summary": "Endereços - Pessoa Física", "description": "Lista endereços associados ao CPF, ordenados por prioridade e enriquecidos com geolocalização. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Dados" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pf-enderecos" ], "description": "Identificador da consulta.", "example": "pf-enderecos" }, "cpf": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "document": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cpf" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pf_enderecos" } }, "/api/pf-historico-academico": { "post": { "summary": "Histórico Escolar e Acadêmico", "description": "Retorna instituições, cursos e períodos acadêmicos encontrados para a pessoa consultada. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Dados" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pf-historico-academico" ], "description": "Identificador da consulta.", "example": "pf-historico-academico" }, "cpf": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "document": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cpf" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pf_historico_academico" } }, "/api/pf-jovem-id": { "post": { "summary": "Identidade Jovem", "description": "Valida o documento ID Jovem e retorna identificação, emissão e vigência disponíveis. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Dados" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pf-jovem-id" ], "description": "Identificador da consulta.", "example": "pf-jovem-id" }, "doc": { "type": "string", "minLength": 1, "description": "doc." }, "documento": { "type": "string", "minLength": 1, "description": "doc. Alternativa a doc." }, "document": { "type": "string", "minLength": 1, "description": "doc. Alternativa a doc." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "doc" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pf_jovem_id" } }, "/api/pf-mandados-prisao": { "post": { "summary": "Mandados de Prisão", "description": "Consulta mandados de prisão no BNMP, com situação, órgão expedidor, data e referência da peça. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Jurídico" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pf-mandados-prisao" ], "description": "Identificador da consulta.", "example": "pf-mandados-prisao" }, "cpf": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "document": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cpf" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pf_mandados_prisao" } }, "/api/pf-nome-social": { "post": { "summary": "Nome Social", "description": "Consulta o nome social associado ao CPF e a data da última atualização disponível. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Dados" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pf-nome-social" ], "description": "Identificador da consulta.", "example": "pf-nome-social" }, "cpf": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "document": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cpf" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pf_nome_social" } }, "/api/pf-obito": { "post": { "summary": "Dados de Óbito", "description": "Verifica indicação de óbito, ano e origem da informação para o CPF consultado. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Dados" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pf-obito" ], "description": "Identificador da consulta.", "example": "pf-obito" }, "cpf": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "document": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cpf" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pf_obito" } }, "/api/pf-passe-livre": { "post": { "summary": "Passe Livre", "description": "Verifica credencial Passe Livre, situação, número, emissão e validade para o CPF. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Dados" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pf-passe-livre" ], "description": "Identificador da consulta.", "example": "pf-passe-livre" }, "cpf": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "document": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cpf" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pf_passe_livre" } }, "/api/pf-pep": { "post": { "summary": "Pessoa Exposta Politicamente", "description": "Identifica condição de PEP, função pública, órgão, período de exercício e vínculos relacionados. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Compliance" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pf-pep" ], "description": "Identificador da consulta.", "example": "pf-pep" }, "cpf": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "document": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cpf" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pf_pep" } }, "/api/pf-pessoas-relacionadas": { "post": { "summary": "Pessoas Relacionadas", "description": "Mapeia familiares, sócios e outras pessoas relacionadas ao CPF a partir das bases disponíveis. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Dados" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pf-pessoas-relacionadas" ], "description": "Identificador da consulta.", "example": "pf-pessoas-relacionadas" }, "cpf": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "document": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cpf" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pf_pessoas_relacionadas" } }, "/api/pf-processos-judiciais": { "post": { "summary": "Processos Judiciais - Pessoa Física", "description": "Lista processos judiciais associados ao CPF, com tribunal, assunto, partes e movimentações. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Jurídico" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pf-processos-judiciais" ], "description": "Identificador da consulta.", "example": "pf-processos-judiciais" }, "cpf": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "document": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cpf" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pf_processos_judiciais" } }, "/api/pf-quod-consulta": { "post": { "summary": "QUOD Consulta - Pessoa Física", "description": "Consolida dados cadastrais, contatos, negativações, protestos e score QUOD. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Dívidas e Crédito" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pf-quod-consulta" ], "description": "Identificador da consulta.", "example": "pf-quod-consulta" }, "cpf": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "document": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cpf" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pf_quod_consulta" } }, "/api/pf-quod-negativo-detalhe": { "post": { "summary": "QUOD Negativo Detalhe - Pessoa Física", "description": "Detalha negativações, apontamentos, protestos, consultas anteriores e valores associados. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Dívidas e Crédito" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pf-quod-negativo-detalhe" ], "description": "Identificador da consulta.", "example": "pf-quod-negativo-detalhe" }, "cpf": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "document": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cpf" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pf_quod_negativo_detalhe" } }, "/api/pf-quod-negativo-flag": { "post": { "summary": "QUOD Negativo Flag - Pessoa Física", "description": "Retorna indicadores resumidos de negativação e situação cadastral na QUOD. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Dívidas e Crédito" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pf-quod-negativo-flag" ], "description": "Identificador da consulta.", "example": "pf-quod-negativo-flag" }, "cpf": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "document": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cpf" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pf_quod_negativo_flag" } }, "/api/pf-quod-score": { "post": { "summary": "QUOD Score de Crédito", "description": "Retorna score de crédito QUOD, sub-scores, segmento e indicadores cadastrais. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Dívidas e Crédito" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pf-quod-score" ], "description": "Identificador da consulta.", "example": "pf-quod-score" }, "cpf": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "document": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cpf" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pf_quod_score" } }, "/api/pf-relacionamentos-grafo": { "post": { "summary": "Pessoas Relacionadas em Grafo", "description": "Apresenta relações do CPF em formato de grafo, com pessoas, empresas e distância entre vínculos. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Dados" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pf-relacionamentos-grafo" ], "description": "Identificador da consulta.", "example": "pf-relacionamentos-grafo" }, "cpf": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "document": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cpf" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pf_relacionamentos_grafo" } }, "/api/pf-restituicao-ir": { "post": { "summary": "Restituição de Imposto de Renda", "description": "Consulta a situação da restituição do Imposto de Renda, banco, lote e data de crédito. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Dados" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pf-restituicao-ir" ], "description": "Identificador da consulta.", "example": "pf-restituicao-ir" }, "cpf": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "document": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cpf" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pf_restituicao_ir" } }, "/api/pf-sancoes-restricoes": { "post": { "summary": "Sanções e Restrições - Pessoa Física", "description": "Pesquisa o CPF em listas nacionais e internacionais de sanções, impedimentos e restrições. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Compliance" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pf-sancoes-restricoes" ], "description": "Identificador da consulta.", "example": "pf-sancoes-restricoes" }, "cpf": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "document": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cpf" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pf_sancoes_restricoes" } }, "/api/pf-score-cadastral": { "post": { "summary": "Score de Dados Cadastrais", "description": "Calcula similaridade e score de validação entre CPF, nome e data de nascimento informados. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Dados" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pf-score-cadastral" ], "description": "Identificador da consulta.", "example": "pf-score-cadastral" }, "cpf": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "document": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "name": { "type": "string", "minLength": 1, "description": "name." }, "nome": { "type": "string", "minLength": 1, "description": "name. Alternativa a name." }, "birth_date": { "type": "string", "minLength": 1, "description": "birth date." }, "data_nascimento": { "type": "string", "minLength": 1, "description": "birth date. Alternativa a birth_date." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cpf" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pf_score_cadastral" } }, "/api/pf-score-credito-nv": { "post": { "summary": "Score de Crédito NV", "description": "Retorna o score de crédito NV calculado para o CPF consultado. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Dívidas e Crédito" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pf-score-credito-nv" ], "description": "Identificador da consulta.", "example": "pf-score-credito-nv" }, "cpf": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "document": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cpf" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pf_score_credito_nv" } }, "/api/pf-servidor-publico": { "post": { "summary": "Servidor Público", "description": "Consulta vínculos com órgãos públicos, esfera, empregador, cargo e localização disponíveis. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Dados" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pf-servidor-publico" ], "description": "Identificador da consulta.", "example": "pf-servidor-publico" }, "cpf": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "document": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cpf" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pf_servidor_publico" } }, "/api/pf-telefones": { "post": { "summary": "Telefones - Pessoa Física", "description": "Lista telefones associados ao CPF, classificados por tipo e prioridade. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Dados" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pf-telefones" ], "description": "Identificador da consulta.", "example": "pf-telefones" }, "cpf": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "document": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cpf" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pf_telefones" } }, "/api/pf-telefones-hot-completo": { "post": { "summary": "Telefones Hot Completo", "description": "Retorna telefones hot completos, enriquecidos e ordenados por prioridade. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Dados" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pf-telefones-hot-completo" ], "description": "Identificador da consulta.", "example": "pf-telefones-hot-completo" }, "cpf": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "document": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cpf" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pf_telefones_hot_completo" } }, "/api/pf-telefones-hot-completo-email": { "post": { "summary": "Telefones Hot Completo e E-mails", "description": "Combina telefones hot completos com e-mails classificados por prioridade e qualidade. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Dados" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pf-telefones-hot-completo-email" ], "description": "Identificador da consulta.", "example": "pf-telefones-hot-completo-email" }, "cpf": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "document": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cpf" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pf_telefones_hot_completo_email" } }, "/api/pf-validacao-telefone": { "post": { "summary": "Validação de Telefone", "description": "Valida a associação entre um CPF e um número de telefone informado. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Dados" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pf-validacao-telefone" ], "description": "Identificador da consulta.", "example": "pf-validacao-telefone" }, "cpf": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "document": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "phone": { "type": "string", "minLength": 1, "description": "Telefone com 10 a 13 dígitos, incluindo DDD." }, "telefone": { "type": "string", "minLength": 1, "description": "Telefone com 10 a 13 dígitos, incluindo DDD. Alternativa a phone." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cpf" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] }, { "anyOf": [ { "required": [ "phone" ] }, { "required": [ "telefone" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pf_validacao_telefone" } }, "/api/pf-veiculos": { "post": { "summary": "Veículos por CPF", "description": "Retorna a frota vinculada ao CPF, com placa, marca, modelo, RENAVAM e atualização. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Veículos" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pf-veiculos" ], "description": "Identificador da consulta.", "example": "pf-veiculos" }, "cpf": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "document": { "type": "string", "minLength": 1, "description": "CPF com 11 dígitos; aceita pontuação. Alternativa a cpf." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cpf" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pf_veiculos" } }, "/api/pj-celulares-hot": { "post": { "summary": "Celulares Hot - Empresa", "description": "Retorna celulares empresariais priorizados, com tipo, WhatsApp e indicadores de contato. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Dados" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pj-celulares-hot" ], "description": "Identificador da consulta.", "example": "pj-celulares-hot" }, "cnpj": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "document": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cnpj" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pj_celulares_hot" } }, "/api/pj-compliance-pld-qsa-v3": { "post": { "summary": "Compliance PLD QSA V3", "description": "Aplica a análise de PLD V3 aos sócios e administradores vinculados ao CNPJ. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Compliance" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pj-compliance-pld-qsa-v3" ], "description": "Identificador da consulta.", "example": "pj-compliance-pld-qsa-v3" }, "cnpj": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "document": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cnpj" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pj_compliance_pld_qsa_v3" } }, "/api/pj-compliance-pld-v3": { "post": { "summary": "Compliance PLD V3 - Empresa", "description": "Análise empresarial de PLD com sanções, processos, notícias, relacionamentos e nível de risco. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Compliance" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pj-compliance-pld-v3" ], "description": "Identificador da consulta.", "example": "pj-compliance-pld-v3" }, "cnpj": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "document": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cnpj" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pj_compliance_pld_v3" } }, "/api/pj-corretor-seguros": { "post": { "summary": "Corretor de Seguros de Danos - PJ", "description": "Verifica registro empresarial de corretor de seguros, produtos autorizados e situação cadastral. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Dados" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pj-corretor-seguros" ], "description": "Identificador da consulta.", "example": "pj-corretor-seguros" }, "cnpj": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "document": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cnpj" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pj_corretor_seguros" } }, "/api/pj-dados-cadastrais": { "post": { "summary": "Dados Cadastrais da Empresa", "description": "Retorna razão social, situação, CNAEs, porte, capital, faturamento e outros dados do CNPJ. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Dados" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pj-dados-cadastrais" ], "description": "Identificador da consulta.", "example": "pj-dados-cadastrais" }, "cnpj": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "document": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cnpj" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pj_dados_cadastrais" } }, "/api/pj-dados-contato": { "post": { "summary": "Dados de Contato da Empresa", "description": "Retorna telefones, fax e e-mails cadastrais associados ao CNPJ. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Dados" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pj-dados-contato" ], "description": "Identificador da consulta.", "example": "pj-dados-contato" }, "cnpj": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "document": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cnpj" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pj_dados_contato" } }, "/api/pj-darkweb": { "post": { "summary": "Exposição na Dark Web - Empresa", "description": "Pesquisa exposição de e-mail ou telefone empresarial em vazamentos conhecidos na dark web. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Compliance" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pj-darkweb" ], "description": "Identificador da consulta.", "example": "pj-darkweb" }, "phone": { "type": "string", "minLength": 1, "description": "Telefone com 10 a 13 dígitos, incluindo DDD." }, "telefone": { "type": "string", "minLength": 1, "description": "Telefone com 10 a 13 dígitos, incluindo DDD. Alternativa a phone." }, "email": { "type": "string", "minLength": 1, "description": "Endereço de e-mail." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "email" ] }, { "required": [ "phone" ] }, { "required": [ "telefone" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pj_darkweb" } }, "/api/pj-define-limite": { "post": { "summary": "Define Limite Positivo", "description": "Análise completa para definição de limite de crédito empresarial com riscos, consultas e restrições. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Dívidas e Crédito" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pj-define-limite" ], "description": "Identificador da consulta.", "example": "pj-define-limite" }, "cnpj": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "document": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cnpj" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pj_define_limite" } }, "/api/pj-define-negocio": { "post": { "summary": "Define Negócio Positivo", "description": "Análise empresarial positiva com estrutura societária, consultas e riscos financeiros. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Dívidas e Crédito" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pj-define-negocio" ], "description": "Identificador da consulta.", "example": "pj-define-negocio" }, "cnpj": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "document": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cnpj" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pj_define_negocio" } }, "/api/pj-define-risco": { "post": { "summary": "Define Risco Positivo", "description": "Avalia o risco de crédito da empresa com consultas anteriores, restrições e indicadores financeiros. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Dívidas e Crédito" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pj-define-risco" ], "description": "Identificador da consulta.", "example": "pj-define-risco" }, "cnpj": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "document": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cnpj" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pj_define_risco" } }, "/api/pj-doacoes-politicas": { "post": { "summary": "Doações Políticas - Empresa", "description": "Consulta doações eleitorais realizadas pelo CNPJ, com eleição, partido, favorecido e valores. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Compliance" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pj-doacoes-politicas" ], "description": "Identificador da consulta.", "example": "pj-doacoes-politicas" }, "cnpj": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "document": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cnpj" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pj_doacoes_politicas" } }, "/api/pj-empresas-societarias": { "post": { "summary": "Empresas Societárias - PJ", "description": "Mapeia empresas ligadas aos sócios e administradores do CNPJ consultado. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Dados" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pj-empresas-societarias" ], "description": "Identificador da consulta.", "example": "pj-empresas-societarias" }, "cnpj": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "document": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cnpj" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pj_empresas_societarias" } }, "/api/pj-financas": { "post": { "summary": "Finanças da Empresa", "description": "Retorna balanços, DRE, contas detalhadas, indicadores financeiros e documentos disponíveis. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Dívidas e Crédito" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pj-financas" ], "description": "Identificador da consulta.", "example": "pj-financas" }, "cnpj": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "document": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cnpj" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pj_financas" } }, "/api/pj-localizacao": { "post": { "summary": "Localização da Empresa", "description": "Retorna endereço empresarial completo, município, UF, latitude, longitude e mapa. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Dados" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pj-localizacao" ], "description": "Identificador da consulta.", "example": "pj-localizacao" }, "cnpj": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "document": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cnpj" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pj_localizacao" } }, "/api/pj-participacao-societaria": { "post": { "summary": "Percentual de Participação Societária", "description": "Detalha participações societárias, percentuais, quantidade e composição dos sócios. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Dados" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pj-participacao-societaria" ], "description": "Identificador da consulta.", "example": "pj-participacao-societaria" }, "cnpj": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "document": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cnpj" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pj_participacao_societaria" } }, "/api/pj-processos-judiciais": { "post": { "summary": "Processos Judiciais - Empresa", "description": "Lista processos judiciais associados ao CNPJ, com tribunal, assunto, partes e movimentações. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Jurídico" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pj-processos-judiciais" ], "description": "Identificador da consulta.", "example": "pj-processos-judiciais" }, "cnpj": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "document": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cnpj" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pj_processos_judiciais" } }, "/api/pj-quadro-societario": { "post": { "summary": "Quadro Societário", "description": "Retorna o quadro societário do CNPJ, incluindo sócios, documentos, qualificações e vínculos. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Dados" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pj-quadro-societario" ], "description": "Identificador da consulta.", "example": "pj-quadro-societario" }, "cnpj": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "document": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cnpj" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pj_quadro_societario" } }, "/api/pj-quod-consulta": { "post": { "summary": "QUOD Consulta - Empresa", "description": "Consolida dados cadastrais, contatos, negativações, protestos e score empresarial QUOD. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Dívidas e Crédito" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pj-quod-consulta" ], "description": "Identificador da consulta.", "example": "pj-quod-consulta" }, "cnpj": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "document": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cnpj" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pj_quod_consulta" } }, "/api/pj-quod-negativo-detalhe": { "post": { "summary": "QUOD Negativo Detalhe - Empresa", "description": "Detalha negativações, apontamentos, protestos, consultas e valores vinculados ao CNPJ. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Dívidas e Crédito" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pj-quod-negativo-detalhe" ], "description": "Identificador da consulta.", "example": "pj-quod-negativo-detalhe" }, "cnpj": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "document": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cnpj" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pj_quod_negativo_detalhe" } }, "/api/pj-quod-negativo-flag": { "post": { "summary": "QUOD Negativo Flag - Empresa", "description": "Retorna indicadores resumidos de negativação e situação cadastral empresarial na QUOD. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Dívidas e Crédito" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pj-quod-negativo-flag" ], "description": "Identificador da consulta.", "example": "pj-quod-negativo-flag" }, "cnpj": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "document": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cnpj" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pj_quod_negativo_flag" } }, "/api/pj-quod-score": { "post": { "summary": "QUOD Score de Crédito - Empresa", "description": "Retorna score de crédito empresarial QUOD, segmento e indicadores cadastrais. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Dívidas e Crédito" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pj-quod-score" ], "description": "Identificador da consulta.", "example": "pj-quod-score" }, "cnpj": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "document": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cnpj" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pj_quod_score" } }, "/api/pj-sancoes-restricoes": { "post": { "summary": "Sanções e Restrições - Empresa", "description": "Pesquisa o CNPJ em listas nacionais e internacionais de sanções, impedimentos e restrições. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Compliance" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pj-sancoes-restricoes" ], "description": "Identificador da consulta.", "example": "pj-sancoes-restricoes" }, "cnpj": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "document": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cnpj" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pj_sancoes_restricoes" } }, "/api/pj-score-cadastral": { "post": { "summary": "Score de Dados Cadastrais - Empresa", "description": "Calcula o score de validação entre o CNPJ e a razão social informada. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Dados" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pj-score-cadastral" ], "description": "Identificador da consulta.", "example": "pj-score-cadastral" }, "cnpj": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "document": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "razao_social": { "type": "string", "minLength": 1, "description": "razao social." }, "nome": { "type": "string", "minLength": 1, "description": "razao social. Alternativa a razao_social." }, "name": { "type": "string", "minLength": 1, "description": "razao social. Alternativa a razao_social." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cnpj" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] }, { "anyOf": [ { "required": [ "razao_social" ] }, { "required": [ "nome" ] }, { "required": [ "name" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pj_score_cadastral" } }, "/api/pj-sintegra": { "post": { "summary": "Sintegra", "description": "Consulta inscrição estadual, situação cadastral, atividade econômica e endereço no Sintegra. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Dados" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pj-sintegra" ], "description": "Identificador da consulta.", "example": "pj-sintegra" }, "cnpj": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "document": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cnpj" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pj_sintegra" } }, "/api/pj-suframa": { "post": { "summary": "SUFRAMA", "description": "Consulta inscrição, incentivos, situação cadastral e projetos aprovados na SUFRAMA. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Dados" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pj-suframa" ], "description": "Identificador da consulta.", "example": "pj-suframa" }, "cnpj": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "document": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cnpj" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pj_suframa" } }, "/api/pj-telefones-socios-hot": { "post": { "summary": "Telefones Hot dos Sócios", "description": "Retorna telefones priorizados dos sócios, com documento relacionado, tipo e nível do vínculo. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Dados" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pj-telefones-socios-hot" ], "description": "Identificador da consulta.", "example": "pj-telefones-socios-hot" }, "cnpj": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "document": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cnpj" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pj_telefones_socios_hot" } }, "/api/pj-veiculos": { "post": { "summary": "Veículos por CNPJ", "description": "Retorna a frota vinculada ao CNPJ, com placa, marca, modelo, RENAVAM e atualização. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Veículos" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "pj-veiculos" ], "description": "Identificador da consulta.", "example": "pj-veiculos" }, "cnpj": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação." }, "documento": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "document": { "type": "string", "minLength": 1, "description": "CNPJ com 14 dígitos; aceita pontuação. Alternativa a cnpj." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cnpj" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_pj_veiculos" } }, "/api/placa-basica": { "post": { "summary": "API de placa grátis", "tags": [ "Ferramentas" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "placa": { "type": "string", "description": "Placa do veículo." }, "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "placa-basica" ], "example": "placa-basica" } }, "required": [ "link", "placa" ], "additionalProperties": true } } } }, "x-mcp-executable": false, "operationId": "post_api_placa_basica" } }, "/api/placa-radar": { "post": { "summary": "Consulta passagens em radares por placa", "tags": [ "Veículos" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "placa-radar" ], "example": "placa-radar" }, "pdf": { "type": [ "string", "boolean", "integer" ], "description": "Opcional. A presença deste campo solicita o relatório PDF. Omita para retornar apenas os dados." }, "placa": { "type": "string", "description": "Placa do veículo." } }, "required": [ "link", "placa" ], "additionalProperties": true } } } }, "x-mcp-executable": true, "operationId": "post_api_placa_radar" } }, "/api/processos-judiciais": { "post": { "summary": "Busca por processos judiciais", "tags": [ "Dados e crédito" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "processos-judiciais" ], "example": "processos-judiciais" }, "pdf": { "type": [ "string", "boolean", "integer" ], "description": "Opcional. A presença deste campo solicita o relatório PDF. Omita para retornar apenas os dados." }, "document": { "type": "string", "description": "CPF ou CNPJ do titular consultado." } }, "required": [ "link", "document" ], "additionalProperties": true } } } }, "x-mcp-executable": true, "operationId": "post_api_processos_judiciais" } }, "/api/products-brand": { "post": { "summary": "API de busca de produtos por modelo de veículo grátis", "tags": [ "Ferramentas" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "text": { "type": "string", "description": "text" }, "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "products-brand" ], "example": "products-brand" } }, "required": [ "link", "text" ], "additionalProperties": true } } } }, "x-mcp-executable": false, "operationId": "post_api_products_brand" } }, "/api/protesto-nacional": { "post": { "summary": "Consulta Protesto Nacional", "tags": [ "Dados e crédito" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "protesto-nacional" ], "example": "protesto-nacional" }, "document": { "type": "string", "description": "CPF ou CNPJ do titular consultado." } }, "required": [ "link", "document" ], "additionalProperties": true } } } }, "x-mcp-executable": true, "operationId": "post_api_protesto_nacional" } }, "/api/r-acoes-e-processos-judiciais": { "post": { "summary": "Consulta de ações e processos judiciais", "tags": [ "Dados e crédito" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "r-acoes-e-processos-judiciais" ], "example": "r-acoes-e-processos-judiciais" }, "html": { "type": [ "string", "boolean", "integer" ], "description": "Opção de relatório da consulta." }, "cpf": { "type": "string", "description": "CPF do titular consultado." } }, "required": [ "link", "cpf" ], "additionalProperties": true } } } }, "x-mcp-executable": true, "operationId": "post_api_r_acoes_e_processos_judiciais" } }, "/api/r-bacen": { "post": { "summary": "Consulta Bacen SCR e score", "tags": [ "Dados e crédito" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "r-bacen" ], "example": "r-bacen" }, "html": { "type": [ "string", "boolean", "integer" ], "description": "Opção de relatório da consulta." }, "document": { "type": "string", "description": "CPF ou CNPJ do titular consultado." } }, "required": [ "link", "document" ], "additionalProperties": true } } } }, "x-mcp-executable": true, "operationId": "post_api_r_bacen" } }, "/api/r-cadastrais-score-dividas": { "post": { "summary": "Cadastrais - Score - Dívidas", "tags": [ "Dados e crédito" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "r-cadastrais-score-dividas" ], "example": "r-cadastrais-score-dividas" }, "pdf": { "type": [ "string", "boolean", "integer" ], "description": "Opcional. A presença deste campo solicita o relatório PDF. Omita para retornar apenas os dados." }, "document": { "type": "string", "description": "CPF ou CNPJ do titular consultado." }, "model_pdf": { "type": "string", "description": "model pdf" } }, "required": [ "link", "document" ], "additionalProperties": true } } } }, "x-mcp-executable": true, "operationId": "post_api_r_cadastrais_score_dividas" } }, "/api/r-cpf-completo": { "post": { "summary": "CPF Completo e Renda presumida", "tags": [ "Dados e crédito" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "r-cpf-completo" ], "example": "r-cpf-completo" }, "html": { "type": [ "string", "boolean", "integer" ], "description": "Opção de relatório da consulta." }, "cpf": { "type": "string", "description": "CPF do titular consultado." } }, "required": [ "link", "cpf" ], "additionalProperties": true } } } }, "x-mcp-executable": true, "operationId": "post_api_r_cpf_completo" } }, "/api/r-negative": { "post": { "summary": "Consulta de dados cadastrais, score e dívidas", "tags": [ "Consultas" ], "responses": { "200": { "description": "Saída de diagnóstico.", "content": { "text/html": { "schema": { "type": "string" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "r-negative" ], "example": "r-negative" }, "CnpjIndireto": { "type": "string", "description": "CnpjIndireto" }, "NomePrincipal": { "type": "string", "description": "NomePrincipal" }, "EmailIndireto": { "type": "string", "description": "EmailIndireto" }, "Telefone": { "type": "string", "description": "Telefone" }, "Cep": { "type": "string", "description": "Cep" }, "Endereco": { "type": "string", "description": "Endereco" }, "Bairro": { "type": "string", "description": "Bairro" }, "Cidade": { "type": "string", "description": "Cidade" } }, "required": [ "link", "CnpjIndireto", "NomePrincipal", "EmailIndireto", "Telefone" ], "additionalProperties": true } } } }, "x-mcp-executable": false, "deprecated": true, "description": "Implementação legada incompleta. Não utilizar para integração: atualmente retorna saída de diagnóstico em HTML.", "operationId": "post_api_r_negative" } }, "/api/rating-credito-bancario": { "post": { "summary": "Consulta de Rating de crédito bancário", "tags": [ "Dados e crédito" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "rating-credito-bancario" ], "example": "rating-credito-bancario" }, "pdf": { "type": [ "string", "boolean", "integer" ], "description": "Opcional. A presença deste campo solicita o relatório PDF. Omita para retornar apenas os dados." }, "document": { "type": "string", "description": "CPF ou CNPJ do titular consultado." } }, "required": [ "link", "document" ], "additionalProperties": true } } } }, "x-mcp-executable": true, "operationId": "post_api_rating_credito_bancario" } }, "/api/rating-score": { "post": { "summary": "Consulta de Rating Score", "tags": [ "Dados e crédito" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "rating-score" ], "example": "rating-score" }, "pdf": { "type": [ "string", "boolean", "integer" ], "description": "Opcional. A presença deste campo solicita o relatório PDF. Omita para retornar apenas os dados." }, "document": { "type": "string", "description": "CPF ou CNPJ do titular consultado." } }, "required": [ "link", "document" ], "additionalProperties": true } } } }, "x-mcp-executable": true, "operationId": "post_api_rating_score" } }, "/api/reconhecimento-facial": { "post": { "summary": "Busca por reconhecimento facial", "tags": [ "Consultas" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "reconhecimento-facial" ], "example": "reconhecimento-facial" }, "pdf": { "type": [ "string", "boolean", "integer" ], "description": "Opcional. A presença deste campo solicita o relatório PDF. Omita para retornar apenas os dados." }, "foto": { "type": "string", "description": "foto" } }, "required": [ "link", "foto" ], "additionalProperties": true } } } }, "x-mcp-executable": true, "operationId": "post_api_reconhecimento_facial" } }, "/api/renainf": { "post": { "summary": "Consulta Renainf", "tags": [ "Veículos" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "renainf" ], "example": "renainf" }, "placa": { "type": "string", "description": "Placa do veículo." } }, "required": [ "link", "placa" ], "additionalProperties": true } } } }, "x-mcp-executable": true, "operationId": "post_api_renainf" } }, "/api/renajud": { "post": { "summary": "Consulta Renajud", "tags": [ "Veículos" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "renajud" ], "example": "renajud" }, "placa": { "type": "string", "description": "Placa do veículo." } }, "required": [ "link", "placa" ], "additionalProperties": true } } } }, "x-mcp-executable": true, "operationId": "post_api_renajud" } }, "/api/roubo-furto": { "post": { "summary": "Busca histórico de roubo e furto", "tags": [ "Veículos" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "roubo-furto" ], "example": "roubo-furto" }, "placa": { "type": "string", "description": "Placa do veículo." } }, "required": [ "link", "placa" ], "additionalProperties": true } } } }, "x-mcp-executable": true, "operationId": "post_api_roubo_furto" } }, "/api/scpc-boavista": { "post": { "summary": "Consulta Boa Vista", "tags": [ "Dados e crédito" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "scpc-boavista" ], "example": "scpc-boavista" }, "pdf": { "type": [ "string", "boolean", "integer" ], "description": "Opcional. A presença deste campo solicita o relatório PDF. Omita para retornar apenas os dados." }, "document": { "type": "string", "description": "CPF ou CNPJ do titular consultado." }, "model_pdf": { "type": "string", "description": "model pdf" } }, "required": [ "link", "document" ], "additionalProperties": true } } } }, "x-mcp-executable": true, "operationId": "post_api_scpc_boavista" } }, "/api/scr-premium": { "post": { "summary": "Consulta SCR Premium", "tags": [ "Dados e crédito" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "scr-premium" ], "example": "scr-premium" }, "pdf": { "type": [ "string", "boolean", "integer" ], "description": "Opcional. A presença deste campo solicita o relatório PDF. Omita para retornar apenas os dados." }, "document": { "type": "string", "description": "CPF ou CNPJ do titular consultado." } }, "required": [ "link", "document" ], "additionalProperties": true } } } }, "x-mcp-executable": true, "operationId": "post_api_scr_premium" } }, "/api/seguidores-instagram-brasileiros": { "post": { "summary": "Coloca 1000 seguidores Brasileiros no Instagram", "tags": [ "Comunicação" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "seguidores-instagram-brasileiros" ], "example": "seguidores-instagram-brasileiros" }, "perfil": { "type": "string", "description": "perfil" }, "state": { "type": "string", "description": "Código de estado aceito por esta consulta." } }, "required": [ "link", "perfil" ], "additionalProperties": true } } } }, "x-supported-methods": [ "post" ], "description": "Use POST com corpo JSON. A rota legada aceita outros métodos, mas eles não são recomendados para integração.", "x-mcp-executable": false, "operationId": "post_api_seguidores_instagram_brasileiros" } }, "/api/seguidores-instagram-brasileiros-cem": { "post": { "summary": "Coloca 100 seguidores Brasileiros no Instagram", "tags": [ "Comunicação" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "seguidores-instagram-brasileiros-cem" ], "example": "seguidores-instagram-brasileiros-cem" }, "perfil": { "type": "string", "description": "perfil" }, "state": { "type": "string", "description": "Código de estado aceito por esta consulta." } }, "required": [ "link", "perfil" ], "additionalProperties": true } } } }, "x-supported-methods": [ "post" ], "description": "Use POST com corpo JSON. A rota legada aceita outros métodos, mas eles não são recomendados para integração.", "x-mcp-executable": false, "operationId": "post_api_seguidores_instagram_brasileiros_cem" } }, "/api/seguidores-instagram-mundiais": { "post": { "summary": "Coloca 1000 seguidores mundiais no Instagram", "tags": [ "Comunicação" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "seguidores-instagram-mundiais" ], "example": "seguidores-instagram-mundiais" }, "perfil": { "type": "string", "description": "perfil" }, "state": { "type": "string", "description": "Código de estado aceito por esta consulta." } }, "required": [ "link", "perfil" ], "additionalProperties": true } } } }, "x-supported-methods": [ "post" ], "description": "Use POST com corpo JSON. A rota legada aceita outros métodos, mas eles não são recomendados para integração.", "x-mcp-executable": false, "operationId": "post_api_seguidores_instagram_mundiais" } }, "/api/seguidores-instagram-mundiais-cem": { "post": { "summary": "Coloca 100 seguidores mundiais no Instagram", "tags": [ "Comunicação" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "seguidores-instagram-mundiais-cem" ], "example": "seguidores-instagram-mundiais-cem" }, "perfil": { "type": "string", "description": "perfil" }, "state": { "type": "string", "description": "Código de estado aceito por esta consulta." } }, "required": [ "link", "perfil" ], "additionalProperties": true } } } }, "x-supported-methods": [ "post" ], "description": "Use POST com corpo JSON. A rota legada aceita outros métodos, mas eles não são recomendados para integração.", "x-mcp-executable": false, "operationId": "post_api_seguidores_instagram_mundiais_cem" } }, "/api/seguidores-tiktok-brasileiros": { "post": { "summary": "Coloca 1000 seguidores Brasileiros no Tiktok", "tags": [ "Comunicação" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "seguidores-tiktok-brasileiros" ], "example": "seguidores-tiktok-brasileiros" }, "perfil": { "type": "string", "description": "perfil" }, "state": { "type": "string", "description": "Código de estado aceito por esta consulta." } }, "required": [ "link", "perfil" ], "additionalProperties": true } } } }, "x-supported-methods": [ "post" ], "description": "Use POST com corpo JSON. A rota legada aceita outros métodos, mas eles não são recomendados para integração.", "x-mcp-executable": false, "operationId": "post_api_seguidores_tiktok_brasileiros" } }, "/api/seguidores-tiktok-brasileiros-cem": { "post": { "summary": "Coloca 100 seguidores Brasileiros no Tiktok", "tags": [ "Comunicação" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "seguidores-tiktok-brasileiros-cem" ], "example": "seguidores-tiktok-brasileiros-cem" }, "perfil": { "type": "string", "description": "perfil" }, "state": { "type": "string", "description": "Código de estado aceito por esta consulta." } }, "required": [ "link", "perfil" ], "additionalProperties": true } } } }, "x-supported-methods": [ "post" ], "description": "Use POST com corpo JSON. A rota legada aceita outros métodos, mas eles não são recomendados para integração.", "x-mcp-executable": false, "operationId": "post_api_seguidores_tiktok_brasileiros_cem" } }, "/api/serasa-basica": { "post": { "summary": "Consulta Serasa Básica", "tags": [ "Dados e crédito" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "serasa-basica" ], "example": "serasa-basica" }, "pdf": { "type": [ "string", "boolean", "integer" ], "description": "Opcional. A presença deste campo solicita o relatório PDF. Omita para retornar apenas os dados." }, "document": { "type": "string", "description": "CPF ou CNPJ do titular consultado." } }, "required": [ "link", "document" ], "additionalProperties": true } } } }, "x-mcp-executable": true, "operationId": "post_api_serasa_basica" } }, "/api/serasa-premium": { "post": { "summary": "Consulta Serasa Premium", "tags": [ "Dados e crédito" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "serasa-premium" ], "example": "serasa-premium" }, "pdf": { "type": [ "string", "boolean", "integer" ], "description": "Opcional. A presença deste campo solicita o relatório PDF. Omita para retornar apenas os dados." }, "document": { "type": "string", "description": "CPF ou CNPJ do titular consultado." } }, "required": [ "link", "document" ], "additionalProperties": true } } } }, "x-mcp-executable": true, "operationId": "post_api_serasa_premium" } }, "/api/serasa-premium-v2": { "post": { "summary": "Consulta Serasa Premium V2", "tags": [ "Dados e crédito" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "serasa-premium-v2" ], "example": "serasa-premium-v2" }, "pdf": { "type": [ "string", "boolean", "integer" ], "description": "Opcional. A presença deste campo solicita o relatório PDF. Omita para retornar apenas os dados." }, "document": { "type": "string", "description": "CPF ou CNPJ do titular consultado." } }, "required": [ "link", "document" ], "additionalProperties": true } } } }, "x-mcp-executable": true, "operationId": "post_api_serasa_premium_v2" } }, "/api/sms-send": { "post": { "summary": "Envia SMS", "tags": [ "Comunicação" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "number": { "type": "string", "description": "number" }, "content": { "type": "string", "description": "content" }, "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "sms-send" ], "example": "sms-send" } }, "required": [ "link", "number", "content" ], "additionalProperties": true } } } }, "x-mcp-executable": false, "operationId": "post_api_sms_send" } }, "/api/sms-sends": { "get": { "summary": "Envios SMS", "tags": [ "Comunicação" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": false, "operationId": "get_api_sms_sends" } }, "/api/spc-brasil": { "post": { "summary": "Consulta SPC Brasil", "tags": [ "Dados e crédito" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "spc-brasil" ], "example": "spc-brasil" }, "pdf": { "type": [ "string", "boolean", "integer" ], "description": "Opcional. A presença deste campo solicita o relatório PDF. Omita para retornar apenas os dados." }, "document": { "type": "string", "description": "CPF ou CNPJ do titular consultado." } }, "required": [ "link", "document" ], "additionalProperties": true } } } }, "x-mcp-executable": true, "operationId": "post_api_spc_brasil" } }, "/api/tool-qrcode": { "post": { "summary": "Gerador de QR CODE", "tags": [ "Ferramentas" ], "responses": { "200": { "description": "Resposta da consulta. Confira também status no corpo: endpoints legados podem retornar erros com HTTP 200.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "description": "Identificador da consulta. Use o valor indicado.", "enum": [ "tool-qrcode" ], "example": "tool-qrcode" }, "content": { "type": "string", "description": "content" } }, "required": [ "link", "content" ], "additionalProperties": true } } } }, "x-supported-methods": [ "post" ], "description": "Use POST com corpo JSON. A rota legada aceita outros métodos, mas eles não são recomendados para integração.", "x-mcp-executable": false, "operationId": "post_api_tool_qrcode" } }, "/api/veiculo-antt": { "post": { "summary": "Consulta ANTT por Veículo", "description": "Consulta RNTRC na ANTT pela placa e documento, incluindo situação, cadastro e validade. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Veículos" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "veiculo-antt" ], "description": "Identificador da consulta.", "example": "veiculo-antt" }, "plate": { "type": "string", "minLength": 1, "description": "Placa do veículo com 7 caracteres." }, "placa": { "type": "string", "minLength": 1, "description": "Placa do veículo com 7 caracteres. Alternativa a plate." }, "doc": { "type": "string", "minLength": 1, "description": "doc." }, "documento": { "type": "string", "minLength": 1, "description": "doc. Alternativa a doc." }, "document": { "type": "string", "minLength": 1, "description": "doc. Alternativa a doc." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "plate" ] }, { "required": [ "placa" ] } ] }, { "anyOf": [ { "required": [ "doc" ] }, { "required": [ "documento" ] }, { "required": [ "document" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_veiculo_antt" } }, "/api/veiculo-combo-rntrc": { "post": { "summary": "Combo de Veículos RNTRC", "description": "Combina dados básicos, débitos e informações ANTT/RNTRC do veículo consultado pela placa. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Veículos" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "veiculo-combo-rntrc" ], "description": "Identificador da consulta.", "example": "veiculo-combo-rntrc" }, "plate": { "type": "string", "minLength": 1, "description": "Placa do veículo com 7 caracteres." }, "placa": { "type": "string", "minLength": 1, "description": "Placa do veículo com 7 caracteres. Alternativa a plate." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "plate" ] }, { "required": [ "placa" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_veiculo_combo_rntrc" } }, "/api/veiculo-dados-basicos": { "post": { "summary": "Dados Básicos do Veículo", "description": "Retorna identificação, características, proprietário e restrições básicas do veículo. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Veículos" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "veiculo-dados-basicos" ], "description": "Identificador da consulta.", "example": "veiculo-dados-basicos" }, "plate": { "type": "string", "minLength": 1, "description": "Placa do veículo com 7 caracteres." }, "placa": { "type": "string", "minLength": 1, "description": "Placa do veículo com 7 caracteres. Alternativa a plate." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "plate" ] }, { "required": [ "placa" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_veiculo_dados_basicos" } }, "/api/veiculo-dados-debitos": { "post": { "summary": "Dados Básicos e Débitos do Veículo", "description": "Retorna dados básicos e débitos como IPVA, licenciamento, multas e demais taxas disponíveis. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Veículos" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "veiculo-dados-debitos" ], "description": "Identificador da consulta.", "example": "veiculo-dados-debitos" }, "plate": { "type": "string", "minLength": 1, "description": "Placa do veículo com 7 caracteres." }, "placa": { "type": "string", "minLength": 1, "description": "Placa do veículo com 7 caracteres. Alternativa a plate." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "plate" ] }, { "required": [ "placa" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_veiculo_dados_debitos" } }, "/api/veiculo-fipe": { "post": { "summary": "FIPE Estimada", "description": "Consulta marca, modelo, referência, código FIPE e valor estimado do veículo pela placa. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Veículos" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "veiculo-fipe" ], "description": "Identificador da consulta.", "example": "veiculo-fipe" }, "plate": { "type": "string", "minLength": 1, "description": "Placa do veículo com 7 caracteres." }, "placa": { "type": "string", "minLength": 1, "description": "Placa do veículo com 7 caracteres. Alternativa a plate." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "plate" ] }, { "required": [ "placa" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_veiculo_fipe" } }, "/api/veiculo-rastreamento": { "post": { "summary": "Rastreamento de Veículos", "description": "Retorna passagens capturadas, localização, pátios, indícios de fraude e registros disponíveis. Requer saldo. Valores e disponibilidade seguem sua conta.", "tags": [ "Veículos" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "link": { "type": "string", "enum": [ "veiculo-rastreamento" ], "description": "Identificador da consulta.", "example": "veiculo-rastreamento" }, "plate": { "type": "string", "minLength": 1, "description": "Placa do veículo com 7 caracteres." }, "placa": { "type": "string", "minLength": 1, "description": "Placa do veículo com 7 caracteres. Alternativa a plate." }, "pdf": { "type": [ "boolean", "string", "integer" ], "description": "A presença deste campo solicita PDF. Omita para retornar apenas dados." } }, "required": [ "link" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "plate" ] }, { "required": [ "placa" ] } ] } ] } } } }, "responses": { "200": { "description": "Resultado. Verifique status no corpo também para falhas de saldo, autenticação ou provedor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-mcp-executable": true, "operationId": "post_api_veiculo_rastreamento" } }, "/storage/delete/{file}": { "get": { "summary": "Excluir arquivo", "tags": [ "Armazenamento" ], "responses": { "200": { "description": "Resultado da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "description": "Atenção: esta rota legada exclui um arquivo, apesar de usar GET.", "operationId": "get_storage_delete_file", "parameters": [ { "name": "file", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/storage/disk": { "get": { "summary": "Consultar espaço em disco", "tags": [ "Armazenamento" ], "responses": { "200": { "description": "Resultado da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "operationId": "get_storage_disk" } }, "/storage/files": { "get": { "summary": "Listar arquivos", "tags": [ "Armazenamento" ], "responses": { "200": { "description": "Resultado da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "operationId": "get_storage_files" } }, "/storage/pay-disk-space": { "post": { "summary": "Contratar espaço em disco", "tags": [ "Armazenamento" ], "responses": { "200": { "description": "Resultado da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "space": { "type": "integer", "minimum": 1 } }, "additionalProperties": true, "required": [ "space" ] } } } }, "operationId": "post_storage_pay_disk_space" } }, "/storage/upload": { "post": { "summary": "Enviar arquivo", "tags": [ "Armazenamento" ], "responses": { "200": { "description": "Resultado da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } }, "required": [ "file" ] } } } }, "operationId": "post_storage_upload" } }, "/storage/uploads": { "post": { "summary": "Enviar arquivos", "tags": [ "Armazenamento" ], "responses": { "200": { "description": "Resultado da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file[]": { "type": "array", "items": { "type": "string", "format": "binary" } } }, "required": [ "file[]" ] } } } }, "operationId": "post_storage_uploads" } }, "/whatsapp/capture-file": { "post": { "summary": "Recuperar mídia recebida", "tags": [ "WhatsApp" ], "responses": { "200": { "description": "Resultado da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string" } }, "additionalProperties": true, "required": [ "url" ] } } } }, "operationId": "post_whatsapp_capture_file" } }, "/whatsapp/create-instance": { "post": { "summary": "Criar instância", "tags": [ "WhatsApp" ], "responses": { "200": { "description": "Resultado da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "webhook": { "type": "string" } }, "additionalProperties": true, "required": [ "name" ] } } } }, "operationId": "post_whatsapp_create_instance" } }, "/whatsapp/delete-instance": { "post": { "summary": "Excluir instância", "tags": [ "WhatsApp" ], "responses": { "200": { "description": "Resultado da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" } }, "additionalProperties": true, "required": [ "name" ] } } } }, "operationId": "post_whatsapp_delete_instance" } }, "/whatsapp/list-chats": { "post": { "summary": "Listar conversas", "tags": [ "WhatsApp" ], "responses": { "200": { "description": "Resultado da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "session": { "type": "string" } }, "additionalProperties": true, "required": [ "session" ] } } } }, "operationId": "post_whatsapp_list_chats" } }, "/whatsapp/list-contacts": { "post": { "summary": "Listar contatos", "tags": [ "WhatsApp" ], "responses": { "200": { "description": "Resultado da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "session": { "type": "string" } }, "additionalProperties": true, "required": [ "session" ] } } } }, "operationId": "post_whatsapp_list_contacts" } }, "/whatsapp/list-groups": { "post": { "summary": "Listar grupos", "tags": [ "WhatsApp" ], "responses": { "200": { "description": "Resultado da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "session": { "type": "string" } }, "additionalProperties": true, "required": [ "session" ] } } } }, "operationId": "post_whatsapp_list_groups" } }, "/whatsapp/list-instances": { "get": { "summary": "Listar instâncias", "tags": [ "WhatsApp" ], "responses": { "200": { "description": "Resultado da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "operationId": "get_whatsapp_list_instances" } }, "/whatsapp/pay-instance": { "post": { "summary": "Pagar instância", "tags": [ "WhatsApp" ], "responses": { "200": { "description": "Resultado da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" } }, "additionalProperties": true, "required": [ "name" ] } } } }, "operationId": "post_whatsapp_pay_instance" } }, "/whatsapp/qrcode-instance": { "post": { "summary": "Obter QR Code", "tags": [ "WhatsApp" ], "responses": { "200": { "description": "Resultado da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "session": { "type": "string" } }, "additionalProperties": true, "required": [ "session" ] } } } }, "operationId": "post_whatsapp_qrcode_instance" } }, "/whatsapp/reset-instance": { "post": { "summary": "Resetar instância", "tags": [ "WhatsApp" ], "responses": { "200": { "description": "Resultado da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "session": { "type": "string" } }, "additionalProperties": true, "required": [ "session" ] } } } }, "operationId": "post_whatsapp_reset_instance" } }, "/whatsapp/restart-session": { "post": { "summary": "Reiniciar sessão", "tags": [ "WhatsApp" ], "responses": { "200": { "description": "Resultado da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "session": { "type": "string" } }, "additionalProperties": true, "required": [ "session" ] } } } }, "operationId": "post_whatsapp_restart_session" } }, "/whatsapp/send-file": { "post": { "summary": "Enviar arquivo", "tags": [ "WhatsApp" ], "responses": { "200": { "description": "Resultado da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "session": { "type": "string" }, "number": { "type": "string" }, "text": { "type": "string" }, "file": { "type": "string" }, "base64": { "type": "string" }, "mimetype": { "type": "string" } }, "additionalProperties": true, "required": [ "session", "number" ], "anyOf": [ { "required": [ "file" ] }, { "required": [ "base64" ] } ] } } } }, "operationId": "post_whatsapp_send_file" } }, "/whatsapp/send-image": { "post": { "summary": "Enviar imagem", "tags": [ "WhatsApp" ], "responses": { "200": { "description": "Resultado da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "session": { "type": "string" }, "number": { "type": "string" }, "text": { "type": "string" }, "file": { "type": "string" }, "base64": { "type": "string" } }, "additionalProperties": true, "required": [ "session", "number" ], "anyOf": [ { "required": [ "file" ] }, { "required": [ "base64" ] } ] } } } }, "operationId": "post_whatsapp_send_image" } }, "/whatsapp/send-message": { "post": { "summary": "Enviar mensagem", "tags": [ "WhatsApp" ], "responses": { "200": { "description": "Resultado da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "session": { "type": "string" }, "number": { "type": "string" }, "text": { "type": "string" }, "isGroup": { "type": "boolean", "default": false } }, "additionalProperties": true, "required": [ "session", "number", "text" ] } } } }, "operationId": "post_whatsapp_send_message" } }, "/whatsapp/status-session": { "post": { "summary": "Status da sessão", "tags": [ "WhatsApp" ], "responses": { "200": { "description": "Resultado da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "session": { "type": "string" } }, "additionalProperties": true, "required": [ "session" ] } } } }, "operationId": "post_whatsapp_status_session" } }, "/whatsapp/verify-number": { "post": { "summary": "Verificar número", "tags": [ "WhatsApp" ], "responses": { "200": { "description": "Resultado da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "session": { "type": "string" }, "number": { "type": "string" } }, "additionalProperties": true, "required": [ "session", "number" ] } } } }, "operationId": "post_whatsapp_verify_number" } }, "/wl/get-balance": { "get": { "summary": "Saldo de clientes White Label", "tags": [ "White Label" ], "responses": { "200": { "description": "Resultado da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "default": { "description": "Falha na operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "operationId": "get_wl_get_balance" } } }, "components": { "securitySchemes": { "BearerAuth": { "type": "http", "scheme": "bearer", "description": "Token da conta API Full." } }, "schemas": { "APIFullSuccessResponse": { "type": "object", "properties": { "status": { "type": "string", "example": "sucesso" }, "API Full": { "type": "string", "format": "uri" }, "dados": { "type": "object", "additionalProperties": true }, "aux": {} } }, "APIFullErrorResponse": { "type": "object", "properties": { "status": { "type": "string", "example": "error" }, "message": { "type": "string" }, "details": {} } }, "AIAgentRequest": { "type": "object", "properties": { "type": { "type": "integer", "example": 1 }, "name": { "type": "string", "example": "Atendimento Comercial" }, "tom": { "type": "integer", "example": 1 }, "avatar": { "type": "integer", "example": 1 }, "persona": { "type": "string" }, "rules": { "type": "string" }, "status": { "type": "integer", "enum": [ 0, 1 ] }, "strict_scope_enabled": { "type": "integer", "enum": [ 0, 1 ] } }, "required": [ "type", "name", "tom" ] }, "AIPromptRequest": { "type": "object", "properties": { "prompt": { "type": "string" }, "promptInput": { "type": "string" }, "type": { "type": "string", "enum": [ "persona", "rules" ] } } }, "AITrainingSiteRequest": { "type": "object", "properties": { "url": { "type": "string", "format": "uri" } }, "required": [ "url" ] }, "AIVoiceRequest": { "type": "object", "properties": { "type_response": { "type": "integer", "enum": [ 0, 1, 2 ] }, "voice": { "type": "string", "example": "nova" } } }, "AIHandoffSettingsRequest": { "type": "object", "properties": { "allow_handoff": { "type": "integer", "enum": [ 0, 1 ] }, "handoff_mode": { "type": "string", "example": "on_demand" }, "handoff_keywords": { "type": "string" }, "resume_keywords": { "type": "string" }, "handoff_message": { "type": "string" }, "waiting_message": { "type": "string" }, "resume_message": { "type": "string" }, "agent_name_prefix_enabled": { "type": "integer", "enum": [ 0, 1 ] }, "strict_scope_enabled": { "type": "integer", "enum": [ 0, 1 ] }, "human_takeover_on_outbound": { "type": "integer", "enum": [ 0, 1 ] }, "web_search_enabled": { "type": "integer", "enum": [ 0, 1 ] }, "max_ai_interactions_enabled": { "type": "integer", "enum": [ 0, 1 ] }, "max_ai_interactions": { "type": "integer" }, "crm_slug": { "type": "string" }, "crm_initial_stage": { "type": "string" } } }, "AIAgentIntegrationRequest": { "type": "object", "properties": { "id_instance": { "type": "integer" }, "is_primary": { "type": "boolean" }, "router_enabled": { "type": "boolean" }, "routing_context": { "type": "string" } } }, "AIChatRequest": { "type": "object", "properties": { "agent_hash": { "type": "string" }, "agent_id": { "type": "string" }, "message": { "type": "string" }, "channel": { "type": "string", "example": "api" }, "external_id": { "type": "string" }, "client_id": { "type": "string" }, "session_name": { "type": "string" }, "thread_id": { "type": "string" }, "conversation_id": { "type": "integer" }, "file": { "type": "object", "additionalProperties": true } }, "required": [ "message" ] }, "AITriggerRequest": { "type": "object", "properties": { "agent_hash": { "type": "string" }, "name": { "type": "string" }, "text": { "type": "string" }, "function": { "type": "string", "enum": [ "handoff", "reply", "close" ] }, "response_text": { "type": "string" }, "active": { "type": "integer", "enum": [ 0, 1 ] }, "priority": { "type": "integer" }, "metadata": { "type": "object", "additionalProperties": true } }, "required": [ "name", "text" ] }, "AIConversationStatusRequest": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "ai_active", "human_active", "closed" ] }, "assigned_to": { "type": "string" }, "notify_client": { "type": "boolean" } }, "required": [ "status" ] }, "AIConversationMessageRequest": { "type": "object", "properties": { "message": { "type": "string" }, "actor": { "type": "string" } }, "required": [ "message" ] }, "AICRMPipelineRequest": { "type": "object", "properties": { "name": { "type": "string" }, "slug": { "type": "string" }, "color": { "type": "string", "example": "#2563EB" }, "position": { "type": "integer" } }, "required": [ "name" ] }, "AICRMPipelinePermissionsRequest": { "type": "object", "properties": { "permissions": { "type": "array", "items": { "type": "object", "properties": { "sub_user_id": { "type": "integer" }, "access": { "type": "string", "enum": [ "none", "view", "edit" ] }, "can_view": { "type": "integer", "enum": [ 0, 1 ] }, "can_edit": { "type": "integer", "enum": [ 0, 1 ] } } } } } }, "AICRMStageRequest": { "type": "object", "properties": { "crm_slug": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "color": { "type": "string", "example": "#8B5CF6" }, "position": { "type": "integer" } }, "required": [ "name" ] }, "AICRMStageDeleteRequest": { "type": "object", "properties": { "crm_slug": { "type": "string" } } }, "AICRMContactRequest": { "type": "object", "properties": { "crm_slug": { "type": "string" }, "agent_hash": { "type": "string" }, "channel": { "type": "string", "example": "api" }, "external_id": { "type": "string" }, "session_name": { "type": "string" }, "name": { "type": "string" }, "phone": { "type": "string" }, "email": { "type": "string", "format": "email" }, "stage": { "type": "string" }, "status": { "type": "string" }, "score": { "type": "integer" }, "owner_name": { "type": "string" }, "tags": { "type": "string" }, "notes": { "type": "string" } } }, "AICRMNoteRequest": { "type": "object", "properties": { "note": { "type": "string" }, "author": { "type": "string" } }, "required": [ "note" ] }, "AICRMTaskRequest": { "type": "object", "properties": { "id": { "type": "integer" }, "title": { "type": "string" }, "description": { "type": "string" }, "due_at": { "type": "string" }, "priority": { "type": "string" }, "status": { "type": "string" }, "assigned_to": { "type": "string" } }, "required": [ "title" ] }, "AICRMTaskStatusRequest": { "type": "object", "properties": { "status": { "type": "string" } }, "required": [ "status" ] }, "AICRMDealRequest": { "type": "object", "properties": { "id": { "type": "integer" }, "title": { "type": "string" }, "value": { "type": "number" }, "stage": { "type": "string" }, "status": { "type": "string" }, "expected_close_at": { "type": "string" } }, "required": [ "title" ] }, "ApiResponse": { "type": "object", "properties": { "status": { "type": "string" }, "API Full": { "type": "string" }, "dados": { "description": "Resultado específico da consulta. Os campos disponíveis dependem da base consultada." }, "aux": { "description": "Metadados e relatório, quando disponíveis." } } }, "ApiError": { "type": "object", "properties": { "status": { "type": "string" }, "message": { "type": "string" } } } } }, "externalDocs": { "url": "https://doc.apifull.com.br/guides" }, "x-mcp": { "url": "https://doc.apifull.com.br/mcp", "transport": "streamable-http" }, "x-contract-revision": "9297a6deda9c047449325607e81a065d8c3acbbc59cd121e2f5fa024127247fd" }