{ "openapi": "3.0.4", "info": { "title": "APIs REST da Direct Data", "description": "Swagger de integração das APIs da Direct Data. Em caso de dúvidas, entre em contato com o nosso suporte: suporte@directd.com.br

Autenticação:

O seu Token da plataforma pode ser enviado de três formas — escolha uma:
1. Authorization: Bearer {seu-token} (recomendado) - header padrão de mercado, mantém o token fora da URL.
2. X-API-Token: {seu-token} - alias, para integrações que não podem usar o header Authorization.
3. ?TOKEN={seu-token} (legado) - continua funcionando normalmente, mas será descontinuado. Token na query string fica registrado em log de servidor, proxy e histórico de browser.

Se você enviar o token no header e na query ao mesmo tempo, o header prevalece — assim você pode adicionar o header primeiro e remover o ?TOKEN= depois, sem janela de indisponibilidade.

Parâmetros que são possíveis de serem enviados em uma requisição GET:

GerarComprovante=habilitar - Habilita a possibilidade de obter a URL do comprovante da consulta no retorno (propriedade: urlComprovante). Verificar as 'Obs' de cada consulta.
Async=habilitar - Executa a consulta de forma assíncrona. Ao executar, gerará um GUID no qual pode ser inserido no endpoint: 'ObterRetornoConsultaAsync' (visto mais abaixo).
Webhook - Para receber o resultado automaticamente ao concluir uma consulta assíncrona, configure um endpoint na plataforma em Integrações → Webhook. O disparo ocorre em toda consulta assíncrona quando há um endpoint ativo inscrito no evento consulta.concluida.

Possíveis mensagens referentes ao Contrato/Saldo:

Não existe um plano ativo - O cliente não possui planos ativos, ou o saldo acabou ou está fora da validade.
Não existe um plano ativo compatível com o usuário - O plano atual está ativo, mas o usuário não tem permissão para consultar.
Não existe um plano ativo compatível com a API requisitada - O plano atual está ativo, o usuário tem permissão, mas o plano não contempla esta APIs.
Saldo insuficiente para realizar esta consulta - O cliente está na precificação anterior, é pré-pago e está sem saldo.
", "version": "v3" }, "paths": { "/api/Historico": { "get": { "tags": [ "* API - Recuperar consulta pelo UID" ], "summary": "Endpoint para recuperar o retorno de uma consulta efetuada.", "parameters": [ { "name": "ConsultaUid", "in": "query", "description": "Informe o UID referente a consulta desejada.", "schema": { "type": "string" } }, { "name": "Extensao", "in": "query", "description": "Informe a extensão de retorno.", "schema": { "$ref": "#/components/schemas/OpcaoExtensaoArquivo" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta." }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/Historico/ObterRetornoConsultaAsync": { "get": { "tags": [ "* API - Recuperar consulta pelo UID" ], "summary": "Endpoint para obter o resultado de uma consulta assíncrona efetuada.", "operationId": "Obter resultado de consulta async por Uid", "parameters": [ { "name": "ConsultaUid", "in": "query", "description": "Informe o UID referente a consulta desejada.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta." }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/AcordosLeniencia": { "get": { "tags": [ "Acordos de Leniência" ], "summary": "Endpoint para realizar a consulta Acordos de Leniência. Obs: esta consulta não possui comprovante.", "description": "", "parameters": [ { "name": "CNPJ", "in": "query", "description": "O parâmetro CNPJ pode ser enviado com ou sem formatação.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AcordosLenienciaRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/AML": { "get": { "tags": [ "AML - Anti Money Laundering (Vínculos Societários)" ], "summary": "Endpoint para realizar a consulta AML - Anti Money Laundering (Vínculos Societários). Obs: esta consulta não possui comprovante.", "description": "🌐 Fornecedor Externo", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AMLRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } }, "x-badges": [ { "name": "🌐 Fornecedor Externo", "color": "#1976d2" } ] } }, "/api/AntifraudePix": { "get": { "tags": [ "Antifraude Chave PIX" ], "summary": "Endpoint para realizar a consulta Antifraude Chave PIX. Obs: esta consulta não possui comprovante.", "description": "O(s) parâmetro(s) DOCUMENTO e CHAVE é(são) obrigatório(s) para esta consulta. Envie juntamente com TIPO.\n\n⚠️ Em manutenção | 🌐 Fornecedor Externo", "parameters": [ { "name": "DOCUMENTO", "in": "query", "description": "O parâmetro DOCUMENTO pode ser enviado com ou sem formatação.", "required": true, "schema": { "type": "string" } }, { "name": "CHAVE", "in": "query", "description": "O parâmetro CHAVE pode ser enviado com qualquer outro.", "required": true, "schema": { "type": "string" } }, { "name": "TIPO", "in": "query", "description": "O parâmetro TIPO deve ser enviado.", "schema": { "$ref": "#/components/schemas/OpcaoTipoPIX" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AntifraudePixRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } }, "x-badges": [ { "name": "⚠️ Em manutenção", "color": "#d32f2f" }, { "name": "🌐 Fornecedor Externo", "color": "#1976d2" } ] } }, "/api/ANTTConsultaCodigoIdentificadorOperacaoTransporte": { "get": { "tags": [ "ANTT - Código Identificador Operação Transporte" ], "summary": "Endpoint para realizar a consulta ANTT - Código Identificador Operação Transporte. Obs: esta consulta não possui comprovante.", "description": "Informe apenas um único documento por requisição.", "parameters": [ { "name": "RNTRC", "in": "query", "description": "O parâmetro RNTRC é um conjunto de 9 números.", "schema": { "type": "string" } }, { "name": "RENAVAM", "in": "query", "description": "O parâmetro RENAVAM deve ser informado juntamente com seus 11 dígitos numéricos.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ANTTConsultaCodigoIdentificadorOperacaoTransporteRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/ANTTConsultaRegularidadeTransportadora": { "get": { "tags": [ "ANTT - Consulta de Regularidade da Transportadora" ], "summary": "Endpoint para realizar a consulta ANTT - Consulta de Regularidade da Transportadora.", "description": "Informe apenas um único documento por requisição.", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "CNPJ", "in": "query", "description": "O parâmetro CNPJ pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "RNTRC", "in": "query", "description": "O parâmetro RNTRC é um conjunto de 9 números.", "schema": { "type": "string" } }, { "name": "GERARCOMPROVANTE", "in": "query", "description": "Este parâmetro possibilita gerar o comprovante em PDF desta consulta.", "schema": { "$ref": "#/components/schemas/OpcaoGerarComprovante" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ANTTConsultaRegularidadeTransportadoraRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/APFRural": { "get": { "tags": [ "APF Rural - Autorização Provisória de Funcionamento Rural" ], "summary": "Endpoint para realizar a consulta APF Rural - Autorização Provisória de Funcionamento Rural.", "description": "Informe apenas um único documento por requisição.", "parameters": [ { "name": "CNPJ", "in": "query", "description": "O parâmetro CNPJ pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "NumeroAPF", "in": "query", "description": "O parâmetro NumeroAPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "NumeroCAR", "in": "query", "description": "O parâmetro NumeroCAR pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "GERARCOMPROVANTE", "in": "query", "description": "Este parâmetro possibilita gerar o comprovante em PDF desta consulta.", "schema": { "$ref": "#/components/schemas/OpcaoGerarComprovante" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APFRuralRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/AustraliaDFAT": { "get": { "tags": [ "Austrália DFAT - Sanções Internacionais" ], "summary": "Endpoint para realizar a consulta Austrália DFAT - Sanções Internacionais. Obs: esta consulta não possui comprovante.", "description": "", "parameters": [ { "name": "NOME", "in": "query", "description": "O parâmetro NOME pode ser enviado com qualquer outro.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AustraliaDFATRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/AuxilioEmergencial": { "get": { "tags": [ "Auxílio Emergencial" ], "summary": "Endpoint para realizar a consulta Auxílio Emergencial. Obs: esta consulta não possui comprovante.", "description": "Informe apenas um único documento por requisição.", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "NIS", "in": "query", "description": "O parâmetro NIS pode ser enviado com ou sem formatação.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuxilioEmergencialRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/AuxilioReconstrucao": { "get": { "tags": [ "Auxílio Reconstrução" ], "summary": "Endpoint para realizar a consulta Auxílio Reconstrução. Obs: esta consulta não possui comprovante.", "description": "Informe apenas um único documento por requisição.", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "NIS", "in": "query", "description": "O parâmetro NIS pode ser enviado com ou sem formatação.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuxilioReconstrucaoRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/BancoCentralInabilitados": { "get": { "tags": [ "Banco Central - Quadro Geral de Inabilitados" ], "summary": "Endpoint para realizar a consulta Banco Central - Quadro Geral de Inabilitados. Obs: esta consulta não possui comprovante.", "description": "", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BancoCentralInabilitadosRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/BancoCentralProibidos": { "get": { "tags": [ "Banco Central - Quadro Geral de Proibidos" ], "summary": "Endpoint para realizar a consulta Banco Central - Quadro Geral de Proibidos. Obs: esta consulta não possui comprovante.", "description": "Informe apenas um único documento por requisição.", "parameters": [ { "name": "CNPJ", "in": "query", "description": "O parâmetro CNPJ pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BancoCentralProibidosRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/BeneficiarioFinal": { "get": { "tags": [ "Beneficiário Final" ], "summary": "Endpoint para realizar a consulta Beneficiário Final. Obs: esta consulta não possui comprovante.", "description": "Informe apenas um único documento por requisição.", "parameters": [ { "name": "CNPJ", "in": "query", "description": "O parâmetro CNPJ pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BeneficiarioFinalRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/BeneficioPrestacaoContinuada": { "get": { "tags": [ "Benefício de Prestação Continuada - BPC" ], "summary": "Endpoint para realizar a consulta Benefício de Prestação Continuada - BPC. Obs: esta consulta não possui comprovante.", "description": "Informe apenas um único documento por requisição.", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "NIS", "in": "query", "description": "O parâmetro NIS pode ser enviado com ou sem formatação.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BeneficioPrestacaoContinuadaRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/BeneficiosSociais": { "get": { "tags": [ "Benefícios Sociais - Pessoa Física" ], "summary": "Endpoint para realizar a consulta Benefícios Sociais - Pessoa Física. Obs: esta consulta não possui comprovante.", "description": "", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BeneficiosSociaisRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/BetSafeCompliance": { "get": { "tags": [ "Bet Safe Compliance " ], "summary": "Endpoint para realizar a consulta Bet Safe Compliance . Obs: esta consulta não possui comprovante.", "description": "🌐 Fornecedor Externo", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BetSafeComplianceRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } }, "x-badges": [ { "name": "🌐 Fornecedor Externo", "color": "#1976d2" } ] } }, "/api/BoaVistaAcertaCompletoPositivoPF": { "get": { "tags": [ "Boa Vista - Acerta Completo Positivo Pessoa Física" ], "summary": "Endpoint para realizar a consulta Boa Vista - Acerta Completo Positivo Pessoa Física.", "description": "🌐 Fornecedor Externo", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "GERARCOMPROVANTE", "in": "query", "description": "Este parâmetro possibilita gerar o comprovante em PDF desta consulta.", "schema": { "$ref": "#/components/schemas/OpcaoGerarComprovante" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoaVistaAcertaCompletoPositivoPessoaFisicaRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } }, "x-badges": [ { "name": "🌐 Fornecedor Externo", "color": "#1976d2" } ] } }, "/api/BoaVistaAcertaMaisPositivoPF": { "get": { "tags": [ "Boa Vista - Acerta Mais Positivo Pessoa Física" ], "summary": "Endpoint para realizar a consulta Boa Vista - Acerta Mais Positivo Pessoa Física.", "description": "🌐 Fornecedor Externo", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "GERARCOMPROVANTE", "in": "query", "description": "Este parâmetro possibilita gerar o comprovante em PDF desta consulta.", "schema": { "$ref": "#/components/schemas/OpcaoGerarComprovante" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoaVistaAcertaMaisPositivoPessoaFisicaRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } }, "x-badges": [ { "name": "🌐 Fornecedor Externo", "color": "#1976d2" } ] } }, "/api/BoaVistaDefineLimitePositivoPJ": { "get": { "tags": [ "Boa Vista - Define Limite Positivo Pessoa Jurídica" ], "summary": "Endpoint para realizar a consulta Boa Vista - Define Limite Positivo Pessoa Jurídica.", "description": "🌐 Fornecedor Externo", "parameters": [ { "name": "CNPJ", "in": "query", "description": "O parâmetro CNPJ pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "GERARCOMPROVANTE", "in": "query", "description": "Este parâmetro possibilita gerar o comprovante em PDF desta consulta.", "schema": { "$ref": "#/components/schemas/OpcaoGerarComprovante" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DefineLimitePositivoRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } }, "x-badges": [ { "name": "🌐 Fornecedor Externo", "color": "#1976d2" } ] } }, "/api/BoaVistaRiscoPositivoPJ": { "get": { "tags": [ "Boa Vista - Risco Positivo Pessoa Jurídica" ], "summary": "Endpoint para realizar a consulta Boa Vista - Risco Positivo Pessoa Jurídica.", "description": "🌐 Fornecedor Externo", "parameters": [ { "name": "CNPJ", "in": "query", "description": "O parâmetro CNPJ pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "GERARCOMPROVANTE", "in": "query", "description": "Este parâmetro possibilita gerar o comprovante em PDF desta consulta.", "schema": { "$ref": "#/components/schemas/OpcaoGerarComprovante" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RiscoPositivoRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } }, "x-badges": [ { "name": "🌐 Fornecedor Externo", "color": "#1976d2" } ] } }, "/api/BolsaFamilia": { "get": { "tags": [ "Bolsa Família" ], "summary": "Endpoint para realizar a consulta Bolsa Família. Obs: esta consulta não possui comprovante.", "description": "", "parameters": [ { "name": "NIS", "in": "query", "description": "O parâmetro NIS pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "MESREFERENCIA", "in": "query", "description": "O parâmetro MESREFERENCIA deve ser de 01 até 12.", "schema": { "type": "string" } }, { "name": "ANOREFERENCIA", "in": "query", "description": "O parâmetro ANOREFERENCIA deve conter os 4 dígitos. Ex: 2024.", "schema": { "type": "string" } }, { "name": "MESCOMPETENCIA", "in": "query", "description": "O parâmetro MESCOMPETENCIA deve ser de 01 até 12.", "schema": { "type": "string" } }, { "name": "ANOCOMPETENCIA", "in": "query", "description": "O parâmetro ANOCOMPETENCIA deve conter os 4 dígitos. Ex: 2024.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BolsaFamiliaRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/CadastroPessoaFisica": { "get": { "tags": [ "Cadastro - Pessoa Física - Básica" ], "summary": "Endpoint para realizar a consulta Cadastro - Pessoa Física - Básica. Obs: esta consulta não possui comprovante.", "description": "🌐 Fornecedor Externo", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CadastroPessoaFisicaRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } }, "x-badges": [ { "name": "🌐 Fornecedor Externo", "color": "#1976d2" } ] } }, "/api/CadastroPessoaFisicaPlus": { "get": { "tags": [ "Cadastro - Pessoa Física - Plus" ], "summary": "Endpoint para realizar a consulta Cadastro - Pessoa Física - Plus. Obs: esta consulta não possui comprovante.", "description": "🌐 Fornecedor Externo", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CadastroPessoaFisicaPlusRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } }, "x-badges": [ { "name": "🌐 Fornecedor Externo", "color": "#1976d2" } ] } }, "/api/CadastroPessoaJuridica": { "get": { "tags": [ "Cadastro - Pessoa Jurídica - Básica" ], "summary": "Endpoint para realizar a consulta Cadastro - Pessoa Jurídica - Básica. Obs: esta consulta não possui comprovante.", "description": "🌐 Fornecedor Externo", "parameters": [ { "name": "CNPJ", "in": "query", "description": "O parâmetro CNPJ pode ser enviado com ou sem formatação.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CadastroPessoaJuridicaRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } }, "x-badges": [ { "name": "🌐 Fornecedor Externo", "color": "#1976d2" } ] } }, "/api/CadastroPessoaJuridicaPlus": { "get": { "tags": [ "Cadastro - Pessoa Jurídica - Plus" ], "summary": "Endpoint para realizar a consulta Cadastro - Pessoa Jurídica - Plus. Obs: esta consulta não possui comprovante.", "description": "🌐 Fornecedor Externo", "parameters": [ { "name": "CNPJ", "in": "query", "description": "O parâmetro CNPJ pode ser enviado com ou sem formatação.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CadastroPessoaJuridicaPlusRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } }, "x-badges": [ { "name": "🌐 Fornecedor Externo", "color": "#1976d2" } ] } }, "/api/CadastroReceitaPessoaFisica": { "get": { "tags": [ "Cadastro + Receita Federal - Pessoa Física" ], "summary": "Endpoint para realizar a consulta Cadastro + Receita Federal - Pessoa Física.", "description": "Informe apenas um único documento por requisição.", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "DATANASCIMENTO", "in": "query", "description": "O parâmetro DATANASCIMENTO deve ser fornecido, com ou sem formatação.", "schema": { "type": "string" } }, { "name": "GERARCOMPROVANTE", "in": "query", "description": "Este parâmetro possibilita gerar o comprovante em PDF desta consulta.", "schema": { "$ref": "#/components/schemas/OpcaoGerarComprovante" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CadastroReceitaPessoaFisicaRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/CADINSecretariaFazendaSP": { "get": { "tags": [ "CADIN - Secretaria da Fazenda - São Paulo" ], "summary": "Endpoint para realizar a consulta CADIN - Secretaria da Fazenda - São Paulo.", "description": "Informe apenas um único documento por requisição.", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "CNPJ", "in": "query", "description": "O parâmetro CNPJ pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "GERARCOMPROVANTE", "in": "query", "description": "Este parâmetro possibilita gerar o comprovante em PDF desta consulta.", "schema": { "$ref": "#/components/schemas/OpcaoGerarComprovante" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CADINSecretariaFazendaSPRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/CADINSecretariaFazendaEstaduais": { "get": { "tags": [ "CADIN - Secretaria da Fazenda" ], "summary": "Endpoint para realizar a consulta CADIN - Secretaria da Fazenda.", "description": "Informe apenas um único documento por requisição.", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "CNPJ", "in": "query", "description": "O parâmetro CNPJ pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "UF", "in": "query", "description": "", "schema": { "$ref": "#/components/schemas/OpcaoUF" } }, { "name": "GERARCOMPROVANTE", "in": "query", "description": "Este parâmetro possibilita gerar o comprovante em PDF desta consulta.", "schema": { "$ref": "#/components/schemas/OpcaoGerarComprovante" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CADINSecretariaFazendaEstaduaisRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/CAFCadastroNacionalAgriculturaPF": { "get": { "tags": [ "CAF - Cadastro Nacional de Agricultura Familiar - PF" ], "summary": "Endpoint para realizar a consulta CAF - Cadastro Nacional de Agricultura Familiar - PF.", "description": "", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "GERARCOMPROVANTE", "in": "query", "description": "Este parâmetro possibilita gerar o comprovante em PDF desta consulta.", "schema": { "$ref": "#/components/schemas/OpcaoGerarComprovante" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CAFCadastroNacionalAgriculturaPFRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/CAFCadastroNacionalAgriculturaPJ": { "get": { "tags": [ "CAF - Cadastro Nacional de Agricultura Familiar - PJ" ], "summary": "Endpoint para realizar a consulta CAF - Cadastro Nacional de Agricultura Familiar - PJ.", "description": "", "parameters": [ { "name": "CNPJ", "in": "query", "description": "O parâmetro CNPJ pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "GERARCOMPROVANTE", "in": "query", "description": "Este parâmetro possibilita gerar o comprovante em PDF desta consulta.", "schema": { "$ref": "#/components/schemas/OpcaoGerarComprovante" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CAFCadastroNacionalAgriculturaPJRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/CadastroImoveisRurais": { "get": { "tags": [ "CAFIR - Cadastros de Imóveis Rurais" ], "summary": "Endpoint para realizar a consulta CAFIR - Cadastros de Imóveis Rurais.", "description": "", "parameters": [ { "name": "CIB", "in": "query", "description": "O parâmetro CIB pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "GERARCOMPROVANTE", "in": "query", "description": "Este parâmetro possibilita gerar o comprovante em PDF desta consulta.", "schema": { "$ref": "#/components/schemas/OpcaoGerarComprovante" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CAFIRCadastroImoveisRuraisRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/CanadaSEMA": { "get": { "tags": [ "Canada SEMA - Sanções Internacionais" ], "summary": "Endpoint para realizar a consulta Canada SEMA - Sanções Internacionais. Obs: esta consulta não possui comprovante.", "description": "", "parameters": [ { "name": "NOME", "in": "query", "description": "O parâmetro NOME pode ser enviado com qualquer outro.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanadaSEMARetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/CadastroAmbientalRural": { "get": { "tags": [ "CAR - Cadastro Ambiental Rural" ], "summary": "Endpoint para realizar a consulta CAR - Cadastro Ambiental Rural.", "description": "", "parameters": [ { "name": "NumeroCAR", "in": "query", "description": "O parâmetro NumeroCAR pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "GERARCOMPROVANTE", "in": "query", "description": "Este parâmetro possibilita gerar o comprovante em PDF desta consulta.", "schema": { "$ref": "#/components/schemas/OpcaoGerarComprovante" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CARCadastroAmbientalRuralRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/CARFConselhoAdministrativodeRecursosFiscais": { "get": { "tags": [ "CARF - Conselho Administrativo de Recursos Fiscais" ], "summary": "Endpoint para realizar a consulta CARF - Conselho Administrativo de Recursos Fiscais. Obs: esta consulta não possui comprovante.", "description": "Informe apenas um único documento por requisição.", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "CNPJ", "in": "query", "description": "O parâmetro CNPJ pode ser enviado com ou sem formatação.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CARFConselhoAdministrativodeRecursosFiscaisRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/CertidaoConjuntaDebitosPessoaFisica": { "get": { "tags": [ "CCD - Certidão Conjunta de Débitos - Pessoa Física" ], "summary": "Endpoint para realizar a consulta CCD - Certidão Conjunta de Débitos - Pessoa Física.", "description": "Informe apenas um único documento por requisição.", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "DATANASCIMENTO", "in": "query", "description": "O parâmetro DATANASCIMENTO deve ser fornecido, com ou sem formatação.", "schema": { "type": "string" } }, { "name": "GERARCOMPROVANTE", "in": "query", "description": "Este parâmetro possibilita gerar o comprovante em PDF desta consulta.", "schema": { "$ref": "#/components/schemas/OpcaoGerarComprovante" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CertidaoConjuntaDebitosPessoaFisicaRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/CertidaoConjuntaDebitosPessoaJuridica": { "get": { "tags": [ "CCD - Certidão Conjunta de Débitos - Pessoa Jurídica" ], "summary": "Endpoint para realizar a consulta CCD - Certidão Conjunta de Débitos - Pessoa Jurídica.", "description": "", "parameters": [ { "name": "CNPJ", "in": "query", "description": "O parâmetro CNPJ pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "GERARCOMPROVANTE", "in": "query", "description": "Este parâmetro possibilita gerar o comprovante em PDF desta consulta.", "schema": { "$ref": "#/components/schemas/OpcaoGerarComprovante" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CertidaoConjuntaDebitosPessoaJuridicaRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/CadastroExpulsoesAdministracaoFederal": { "get": { "tags": [ "CEAF - Cadastro de Expulsões da Administração Federal" ], "summary": "Endpoint para realizar a consulta CEAF - Cadastro de Expulsões da Administração Federal. Obs: esta consulta não possui comprovante.", "description": "", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CadastroExpulsoesAdministracaoFederalRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/CadastroEmpresasInidoneasSuspensas": { "get": { "tags": [ "CEIS - Cadastro de Empresas Inidôneas e Suspensas" ], "summary": "Endpoint para realizar a consulta CEIS - Cadastro de Empresas Inidôneas e Suspensas. Obs: esta consulta não possui comprovante.", "description": "Informe apenas um único documento por requisição.", "parameters": [ { "name": "CNPJ", "in": "query", "description": "O parâmetro CNPJ pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CadastroEmpresasInidoneasSuspensasRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/CadastroEntidadesPrivadasImpedidas": { "get": { "tags": [ "CEPIM - Cadastro de Entidades Privadas Sem Fins Lucrativos Impedidas" ], "summary": "Endpoint para realizar a consulta CEPIM - Cadastro de Entidades Privadas Sem Fins Lucrativos Impedidas. Obs: esta consulta não possui comprovante.", "description": "", "parameters": [ { "name": "CNPJ", "in": "query", "description": "O parâmetro CNPJ pode ser enviado com ou sem formatação.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CadastroEntidadesPrivadasImpedidasRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/AnbimaCertificadoEDU": { "get": { "tags": [ "Certificado Anbima EDU" ], "summary": "Endpoint para realizar a consulta Certificado Anbima EDU. Obs: esta consulta não possui comprovante.", "description": "", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnbimaCertificadoEDURetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/ConselhoFederalMedicina": { "get": { "tags": [ "CFM - Conselho Federal de Medicina" ], "summary": "Endpoint para realizar a consulta CFM - Conselho Federal de Medicina.", "description": "Informe apenas um único documento por requisição.", "parameters": [ { "name": "NOME", "in": "query", "description": "Pelo menos um dos parâmetros NOME, CRM ou UF deve ser enviado. Quanto mais parâmetros informados, mais fácil localizar o médico.", "schema": { "type": "string" } }, { "name": "CRM", "in": "query", "description": "Pelo menos um dos parâmetros NOME, CRM ou UF deve ser enviado.", "schema": { "type": "string" } }, { "name": "UF", "in": "query", "description": "Pelo menos um dos parâmetros NOME, CRM ou UF deve ser enviado. Caso a busca retorne mais de 10 médicos, são exibidos apenas os 10 primeiros — utilize mais filtros para refinar.", "schema": { "$ref": "#/components/schemas/OpcaoUF" } }, { "name": "GERARCOMPROVANTE", "in": "query", "description": "Este parâmetro possibilita gerar o comprovante em PDF desta consulta.", "schema": { "$ref": "#/components/schemas/OpcaoGerarComprovante" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConselhoFederalMedicinaRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/CertidaoNegativaDebitos": { "get": { "tags": [ "CND - Certidão Negativa de Débitos Estaduais" ], "summary": "Endpoint para realizar a consulta CND - Certidão Negativa de Débitos Estaduais.", "description": "O(s) parâmetro(s) UF é(são) obrigatório(s) para esta consulta. Envie juntamente com CPF ou CNPJ ou IE (Inscrição Estadual).", "parameters": [ { "name": "CNPJ", "in": "query", "description": "O parâmetro CNPJ pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "IE", "in": "query", "description": "O parâmetro IE pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "UF", "in": "query", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/OpcaoUF" } }, { "name": "GERARCOMPROVANTE", "in": "query", "description": "Este parâmetro possibilita gerar o comprovante em PDF desta consulta.", "schema": { "$ref": "#/components/schemas/OpcaoGerarComprovante" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CertidaoNegativaDebitosRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/CertidaoNegativaDebitosImovelRural": { "get": { "tags": [ "CNDIR - Certidão Negativa de Débitos e Dívida Ativa da União de Imóvel Rural" ], "summary": "Endpoint para realizar a consulta CNDIR - Certidão Negativa de Débitos e Dívida Ativa da União de Imóvel Rural.", "description": "", "parameters": [ { "name": "CIB", "in": "query", "description": "O parâmetro CIB pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "GERARCOMPROVANTE", "in": "query", "description": "Este parâmetro possibilita gerar o comprovante em PDF desta consulta.", "schema": { "$ref": "#/components/schemas/OpcaoGerarComprovante" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CertidaoNegativaDebitosImovelRuralRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/CertidaoNegativaDebitosMunicipal": { "get": { "tags": [ "CNDM - Certidão Negativa de Débitos Municipal" ], "summary": "Endpoint para realizar a consulta CNDM - Certidão Negativa de Débitos Municipal.", "description": "O(s) parâmetro(s) MUNICIPIO é(são) obrigatório(s) para esta consulta. Envie juntamente com CPF ou CNPJ ou IM (Inscrição Municipal).", "parameters": [ { "name": "CNPJ", "in": "query", "description": "O parâmetro CNPJ pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "IM", "in": "query", "description": "O parâmetro IM (Inscrição Municipal) pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "MUNICIPIO", "in": "query", "description": "O parâmetro MUNICIPIO deve ser informado juntamente com a Unidade Federativa (MUNICIPIO-UF).", "required": true, "schema": { "type": "string" } }, { "name": "GERARCOMPROVANTE", "in": "query", "description": "Este parâmetro possibilita gerar o comprovante em PDF desta consulta.", "schema": { "$ref": "#/components/schemas/OpcaoGerarComprovante" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CertidaoNegativaDebitosMunicipalRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/CadastroNacionalEmpresasPunidas": { "get": { "tags": [ "CNEP - Cadastro Nacional de Empresas Punidas" ], "summary": "Endpoint para realizar a consulta CNEP - Cadastro Nacional de Empresas Punidas. Obs: esta consulta não possui comprovante.", "description": "Informe apenas um único documento por requisição.", "parameters": [ { "name": "CNPJ", "in": "query", "description": "O parâmetro CNPJ pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CadastroNacionalEmpresasPunidasRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/CnhCompleta": { "get": { "tags": [ "CNH - Carteira Nacional de Habilitação Completa" ], "summary": "Endpoint para realizar a consulta CNH - Carteira Nacional de Habilitação Completa. Obs: esta consulta não possui comprovante.", "description": "🌐 Fornecedor Externo", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CnhCompletaRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } }, "x-badges": [ { "name": "🌐 Fornecedor Externo", "color": "#1976d2" } ] } }, "/api/CnhPlus": { "get": { "tags": [ "CNH - Carteira Nacional de Habilitação Plus" ], "summary": "Endpoint para realizar a consulta CNH - Carteira Nacional de Habilitação Plus. Obs: esta consulta não possui comprovante.", "description": "🌐 Fornecedor Externo", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CnhPlusRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } }, "x-badges": [ { "name": "🌐 Fornecedor Externo", "color": "#1976d2" } ] } }, "/api/CarteiraNacionalHabilitacao": { "get": { "tags": [ "CNH - Carteira Nacional de Habilitação" ], "summary": "Endpoint para realizar a consulta CNH - Carteira Nacional de Habilitação. Obs: esta consulta não possui comprovante.", "description": "🌐 Fornecedor Externo", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarteiraNacionalHabilitacaoRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } }, "x-badges": [ { "name": "🌐 Fornecedor Externo", "color": "#1976d2" } ] } }, "/api/CadastroNacionalImprobidadeAdministrativa": { "get": { "tags": [ "CNIA - Cadastro Nacional de Condenações Cíveis por Ato de Improbidade Administrativa e Inelegibilidade" ], "summary": "Endpoint para realizar a consulta CNIA - Cadastro Nacional de Condenações Cíveis por Ato de Improbidade Administrativa e Inelegibilidade.", "description": "Informe apenas um único documento por requisição.", "parameters": [ { "name": "CNPJ", "in": "query", "description": "O parâmetro CNPJ pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CadastroNacionalImprobidadeAdministrativaRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/CNJMandadosPrisao": { "get": { "tags": [ "CNJ - Mandados de Prisão" ], "summary": "Endpoint para realizar a consulta CNJ - Mandados de Prisão.", "description": "", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "NOME", "in": "query", "description": "O parâmetro NOME pode ser enviado com qualquer outro.", "schema": { "type": "string" } }, { "name": "NOMEMAE", "in": "query", "description": "O parâmetro NOMEMAE pode ser enviado com qualquer outro.", "schema": { "type": "string" } }, { "name": "NOMEPAI", "in": "query", "description": "O parâmetro NOMEPAI pode ser enviado com qualquer outro.", "schema": { "type": "string" } }, { "name": "ALCUNHA", "in": "query", "description": "O parâmetro ALCUNHA pode ser enviado com qualquer outro.", "schema": { "type": "string" } }, { "name": "GERARCOMPROVANTE", "in": "query", "description": "Este parâmetro possibilita gerar o comprovante em PDF desta consulta.", "schema": { "$ref": "#/components/schemas/OpcaoGerarComprovante" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CNJMandadosPrisaoRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/CONFEA": { "get": { "tags": [ "CONFEA/CREA - Conselho Federal de Engenharia e Agronomia" ], "summary": "Endpoint para realizar a consulta CONFEA/CREA - Conselho Federal de Engenharia e Agronomia.", "description": "Informe apenas um único documento por requisição.", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "REGISTRONACIONAL", "in": "query", "description": "O parâmetro REGISTRONACIONAL pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "GERARCOMPROVANTE", "in": "query", "description": "Este parâmetro possibilita gerar o comprovante em PDF desta consulta.", "schema": { "$ref": "#/components/schemas/OpcaoGerarComprovante" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CONFEARetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/ConsultaVeicularCrlvSP": { "get": { "tags": [ "Consulta Veicular - CRLV-e SP" ], "summary": "Endpoint para realizar a consulta Consulta Veicular - CRLV-e SP.", "description": "🌐 Fornecedor Externo", "parameters": [ { "name": "PLACA", "in": "query", "description": "O parâmetro PLACA pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "GERARCOMPROVANTE", "in": "query", "description": "Este parâmetro possibilita gerar o comprovante em PDF desta consulta.", "schema": { "$ref": "#/components/schemas/OpcaoGerarComprovante" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultaVeicularCrlvSPRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } }, "x-badges": [ { "name": "🌐 Fornecedor Externo", "color": "#1976d2" } ] } }, "/api/ConsultaVeicularEstadual": { "get": { "tags": [ "Consulta Veicular - Estadual" ], "summary": "Endpoint para realizar a consulta Consulta Veicular - Estadual. Obs: esta consulta não possui comprovante.", "description": "Informe apenas um único documento por requisição.\n\n🌐 Fornecedor Externo", "parameters": [ { "name": "PLACA", "in": "query", "description": "O parâmetro PLACA pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "CHASSI", "in": "query", "description": "O parâmetro CHASSI pode ser enviado com ou sem formatação.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultaVeicularEstadualRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } }, "x-badges": [ { "name": "🌐 Fornecedor Externo", "color": "#1976d2" } ] } }, "/api/ConsultaVeicularFrotasNacional": { "get": { "tags": [ "Consulta Veicular - Frotas Nacional" ], "summary": "Endpoint para realizar a consulta Consulta Veicular - Frotas Nacional. Obs: esta consulta não possui comprovante.", "description": "Informe apenas um único documento por requisição.\n\n🌐 Fornecedor Externo", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "CNPJ", "in": "query", "description": "O parâmetro CNPJ pode ser enviado com ou sem formatação.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultaVeicularFrotasNacionalRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } }, "x-badges": [ { "name": "🌐 Fornecedor Externo", "color": "#1976d2" } ] } }, "/api/ConsultaVeicularGravame": { "get": { "tags": [ "Consulta Veicular - Gravame" ], "summary": "Endpoint para realizar a consulta Consulta Veicular - Gravame. Obs: esta consulta não possui comprovante.", "description": "Informe apenas um único documento por requisição.\n\n🌐 Fornecedor Externo", "parameters": [ { "name": "PLACA", "in": "query", "description": "O parâmetro PLACA pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "CHASSI", "in": "query", "description": "O parâmetro CHASSI pode ser enviado com ou sem formatação.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultaVeicularGravameRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } }, "x-badges": [ { "name": "🌐 Fornecedor Externo", "color": "#1976d2" } ] } }, "/api/ConsultaVeicularHistoricoProprietarios": { "get": { "tags": [ "Consulta Veicular - Histórico de Proprietários" ], "summary": "Endpoint para realizar a consulta Consulta Veicular - Histórico de Proprietários. Obs: esta consulta não possui comprovante.", "description": "🌐 Fornecedor Externo", "parameters": [ { "name": "PLACA", "in": "query", "description": "O parâmetro PLACA pode ser enviado com ou sem formatação.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultaVeicularHistoricoProprietariosRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } }, "x-badges": [ { "name": "🌐 Fornecedor Externo", "color": "#1976d2" } ] } }, "/api/ConsultaLeilaoVeicular": { "get": { "tags": [ "Consulta Veicular - Leilão Veicular" ], "summary": "Endpoint para realizar a consulta Consulta Veicular - Leilão Veicular. Obs: esta consulta não possui comprovante.", "description": "Informe apenas um único documento por requisição.\n\n🌐 Fornecedor Externo", "parameters": [ { "name": "PLACA", "in": "query", "description": "O parâmetro PLACA pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "CHASSI", "in": "query", "description": "O parâmetro CHASSI pode ser enviado com ou sem formatação.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultaLeilaoVeicularRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } }, "x-badges": [ { "name": "🌐 Fornecedor Externo", "color": "#1976d2" } ] } }, "/api/ConsultaVeicular": { "get": { "tags": [ "Consulta Veicular - Nacional" ], "summary": "Endpoint para realizar a consulta Consulta Veicular - Nacional. Obs: esta consulta não possui comprovante.", "description": "🌐 Fornecedor Externo", "parameters": [ { "name": "PLACA", "in": "query", "description": "O parâmetro PLACA pode ser enviado com ou sem formatação.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultaVeicularRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } }, "x-badges": [ { "name": "🌐 Fornecedor Externo", "color": "#1976d2" } ] } }, "/api/ConsultaVeicularProprietarioAtual": { "get": { "tags": [ "Consulta Veicular - Proprietário Atual" ], "summary": "Endpoint para realizar a consulta Consulta Veicular - Proprietário Atual. Obs: esta consulta não possui comprovante.", "description": "🌐 Fornecedor Externo", "parameters": [ { "name": "PLACA", "in": "query", "description": "O parâmetro PLACA pode ser enviado com ou sem formatação.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultaVeicularProprietarioAtualRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } }, "x-badges": [ { "name": "🌐 Fornecedor Externo", "color": "#1976d2" } ] } }, "/api/ConsultaVeicularRecall": { "get": { "tags": [ "Consulta Veicular - Recall" ], "summary": "Endpoint para realizar a consulta Consulta Veicular - Recall. Obs: esta consulta não possui comprovante.", "description": "🌐 Fornecedor Externo", "parameters": [ { "name": "PLACA", "in": "query", "description": "O parâmetro PLACA pode ser enviado com ou sem formatação.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultaVeicularRecallRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } }, "x-badges": [ { "name": "🌐 Fornecedor Externo", "color": "#1976d2" } ] } }, "/api/ConsultaVeicularRenainf": { "get": { "tags": [ "Consulta Veicular - Renainf" ], "summary": "Endpoint para realizar a consulta Consulta Veicular - Renainf. Obs: esta consulta não possui comprovante.", "description": "", "parameters": [ { "name": "PLACA", "in": "query", "description": "O parâmetro PLACA pode ser enviado com ou sem formatação.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultaVeicularRenainfRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/ConsultaVeicularRenajud": { "get": { "tags": [ "Consulta Veicular - Renajud" ], "summary": "Endpoint para realizar a consulta Consulta Veicular - Renajud. Obs: esta consulta não possui comprovante.", "description": "🌐 Fornecedor Externo", "parameters": [ { "name": "PLACA", "in": "query", "description": "O parâmetro PLACA pode ser enviado com ou sem formatação.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultaVeicularRenajudRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } }, "x-badges": [ { "name": "🌐 Fornecedor Externo", "color": "#1976d2" } ] } }, "/api/ConsultaVeicularRouboFurto": { "get": { "tags": [ "Consulta Veicular - Roubo e Furto" ], "summary": "Endpoint para realizar a consulta Consulta Veicular - Roubo e Furto. Obs: esta consulta não possui comprovante.", "description": "Informe apenas um único documento por requisição.\n\n🌐 Fornecedor Externo", "parameters": [ { "name": "PLACA", "in": "query", "description": "O parâmetro PLACA pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "CHASSI", "in": "query", "description": "O parâmetro CHASSI pode ser enviado com ou sem formatação.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultaVeicularRouboFurtoRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } }, "x-badges": [ { "name": "🌐 Fornecedor Externo", "color": "#1976d2" } ] } }, "/api/ConsultaVeicularMultasRadar": { "get": { "tags": [ "Consulta Veicular Serpro - Multas Radar" ], "summary": "Endpoint para realizar a consulta Consulta Veicular Serpro - Multas Radar.", "description": "Informe apenas um único documento por requisição.", "parameters": [ { "name": "PLACA", "in": "query", "description": "O parâmetro PLACA pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "RENAVAM", "in": "query", "description": "O parâmetro RENAVAM pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "GERARCOMPROVANTE", "in": "query", "description": "Este parâmetro possibilita gerar o comprovante em PDF desta consulta.", "schema": { "$ref": "#/components/schemas/OpcaoGerarComprovante" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultaVeicularMultasRadarRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/CGUConsultoriaGeralUniao": { "get": { "tags": [ "Consultoria Geral da União - CGU" ], "summary": "Endpoint para realizar a consulta Consultoria Geral da União - CGU.", "description": "O(s) parâmetro(s) TIPO é(são) obrigatório(s) para esta consulta. Envie juntamente com CPF ou CNPJ.", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "CNPJ", "in": "query", "description": "O parâmetro CNPJ pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "TIPO", "in": "query", "description": "O parâmetro TIPO deve ser escolhido.", "required": true, "schema": { "$ref": "#/components/schemas/OpcaoTipoCGU" } }, { "name": "GERARCOMPROVANTE", "in": "query", "description": "Este parâmetro possibilita gerar o comprovante em PDF desta consulta.", "schema": { "$ref": "#/components/schemas/OpcaoGerarComprovante" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CGUConsultoriaGeralUniaoRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/CorreiosBuscaCEP": { "get": { "tags": [ "Correios - Busca CEP" ], "summary": "Endpoint para realizar a consulta Correios - Busca CEP. Obs: esta consulta não possui comprovante.", "description": "", "parameters": [ { "name": "ENDERECO", "in": "query", "description": "Digite um CEP ou um Endereço. Não utilize nº de casa/apto/lote/prédio ou abreviação.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CorreiosBuscaCEPRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/CVMComissaodeValoresMobiliarios": { "get": { "tags": [ "CVM - Comissão de Valores Mobiliários" ], "summary": "Endpoint para realizar a consulta CVM - Comissão de Valores Mobiliários. Obs: esta consulta não possui comprovante.", "description": "Informe apenas um único documento por requisição.", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "CNPJ", "in": "query", "description": "O parâmetro CNPJ pode ser enviado com ou sem formatação.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CVMComissaodeValoresMobiliariosRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/CVMProcessosAdministrativosSancionadores": { "get": { "tags": [ "CVM - Processos Administrativos Sancionadores" ], "summary": "Endpoint para realizar a consulta CVM - Processos Administrativos Sancionadores. Obs: esta consulta não possui comprovante.", "description": "Informe apenas um único documento por requisição.", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "CNPJ", "in": "query", "description": "O parâmetro CNPJ pode ser enviado com ou sem formatação.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CVMProcessosAdministrativosSancionadoresRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/DAPPessoaFisica": { "get": { "tags": [ "DAP - Declaração de Aptidão ao Pronaf - Pessoa Física" ], "summary": "Endpoint para realizar a consulta DAP - Declaração de Aptidão ao Pronaf - Pessoa Física.", "description": "", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "GERARCOMPROVANTE", "in": "query", "description": "Este parâmetro possibilita gerar o comprovante em PDF desta consulta.", "schema": { "$ref": "#/components/schemas/OpcaoGerarComprovante" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DAPPessoaFisicaRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/DAPPessoaJuridica": { "get": { "tags": [ "DAP - Declaração de Aptidão ao Pronaf - Pessoa Jurídica" ], "summary": "Endpoint para realizar a consulta DAP - Declaração de Aptidão ao Pronaf - Pessoa Jurídica.", "description": "", "parameters": [ { "name": "CNPJ", "in": "query", "description": "O parâmetro CNPJ pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "GERARCOMPROVANTE", "in": "query", "description": "Este parâmetro possibilita gerar o comprovante em PDF desta consulta.", "schema": { "$ref": "#/components/schemas/OpcaoGerarComprovante" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DAPPessoaJuridicaRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/DetalhamentoNegativo": { "get": { "tags": [ "Detalhamento Negativo QUOD" ], "summary": "Endpoint para realizar a consulta Detalhamento Negativo QUOD. Obs: esta consulta não possui comprovante.", "description": "Informe apenas um único documento por requisição.", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "CNPJ", "in": "query", "description": "O parâmetro CNPJ pode ser enviado com ou sem formatação.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DetalhamentoNegativoRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/DossieCreditoCompleto": { "get": { "tags": [ "Dossiê QUOD - Completo" ], "summary": "Endpoint para realizar a consulta Dossiê QUOD - Completo. Obs: esta consulta não possui comprovante.", "description": "Informe apenas um único documento por requisição.", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "CNPJ", "in": "query", "description": "O parâmetro CNPJ pode ser enviado com ou sem formatação.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DossieCreditoCompletoRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/EnriquecimentoLead": { "get": { "tags": [ "Enriquecimento de Lead" ], "summary": "Endpoint para realizar a consulta Enriquecimento de Lead. Obs: esta consulta não possui comprovante.", "description": "Informe apenas um único documento por requisição.", "parameters": [ { "name": "CELULAR", "in": "query", "description": "O parâmetro CELULAR pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "EMAIL", "in": "query", "description": "O parâmetro EMAIL deve possuir formatação válida.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnriquecimentoLeadRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/EUFinancialList": { "get": { "tags": [ "EU Financial Sanctions List " ], "summary": "Endpoint para realizar a consulta EU Financial Sanctions List . Obs: esta consulta não possui comprovante.", "description": "", "parameters": [ { "name": "NOME", "in": "query", "description": "O parâmetro NOME pode ser enviado em maiúsculo ou minúsculo.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListaSancoesEURetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/FBIMostWanted": { "get": { "tags": [ "FBI - Most Wanted" ], "summary": "Endpoint para realizar a consulta FBI - Most Wanted. Obs: esta consulta não possui comprovante.", "description": "", "parameters": [ { "name": "NOME", "in": "query", "description": "O parâmetro NOME pode ser enviado em maiúsculo ou minúsculo.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FBIMostWantedRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/CaixaRegularidadeEmpregadorFGTS": { "get": { "tags": [ "FGTS - Regularidade do Empregador " ], "summary": "Endpoint para realizar a consulta FGTS - Regularidade do Empregador .", "description": "Informe apenas um único documento por requisição.", "parameters": [ { "name": "CNPJ", "in": "query", "description": "O parâmetro CNPJ pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "GERARCOMPROVANTE", "in": "query", "description": "Este parâmetro possibilita gerar o comprovante em PDF desta consulta.", "schema": { "$ref": "#/components/schemas/OpcaoGerarComprovante" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaixaRegularidadeEmpregadorFGTSRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/FinCEN": { "get": { "tags": [ "FINCEN - Financial Crimes Enforcement Network" ], "summary": "Endpoint para realizar a consulta FINCEN - Financial Crimes Enforcement Network.", "description": "", "parameters": [ { "name": "NOME", "in": "query", "description": "O parâmetro NOME pode ser enviado em maiúsculo ou minúsculo.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinCENRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/GarantiaSafra": { "get": { "tags": [ "Garantia Safra" ], "summary": "Endpoint para realizar a consulta Garantia Safra. Obs: esta consulta não possui comprovante.", "description": "Informe apenas um único documento por requisição.", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "NIS", "in": "query", "description": "O parâmetro NIS pode ser enviado com ou sem formatação.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GarantiaSafraRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/GasDoPovo": { "get": { "tags": [ "Gás do Povo" ], "summary": "Endpoint para realizar a consulta Gás do Povo. Obs: esta consulta não possui comprovante.", "description": "", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GasDoPovoRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/HistoricoVeiculosNacional": { "get": { "tags": [ "Histórico Veicular PF e PJ - Nacional" ], "summary": "Endpoint para realizar a consulta Histórico Veicular PF e PJ - Nacional. Obs: esta consulta não possui comprovante.", "description": "Informe apenas um único documento por requisição.\n\n🌐 Fornecedor Externo", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "CNPJ", "in": "query", "description": "O parâmetro CNPJ pode ser enviado com ou sem formatação.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HistoricoVeiculosNacionalRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } }, "x-badges": [ { "name": "🌐 Fornecedor Externo", "color": "#1976d2" } ] } }, "/api/HistoricoVeiculos": { "get": { "tags": [ "Histórico Veicular PF e PJ - São Paulo" ], "summary": "Endpoint para realizar a consulta Histórico Veicular PF e PJ - São Paulo. Obs: esta consulta não possui comprovante.", "description": "Informe apenas um único documento por requisição.\n\n🌐 Fornecedor Externo", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "CNPJ", "in": "query", "description": "O parâmetro CNPJ pode ser enviado com ou sem formatação.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HistoricoVeiculosRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } }, "x-badges": [ { "name": "🌐 Fornecedor Externo", "color": "#1976d2" } ] } }, "/api/IBAMACertidaoNegativaDebitos": { "get": { "tags": [ "IBAMA - Certidão Negativa de Débitos" ], "summary": "Endpoint para realizar a consulta IBAMA - Certidão Negativa de Débitos.", "description": "Informe apenas um único documento por requisição.", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "CNPJ", "in": "query", "description": "O parâmetro CNPJ pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "GERARCOMPROVANTE", "in": "query", "description": "Este parâmetro possibilita gerar o comprovante em PDF desta consulta.", "schema": { "$ref": "#/components/schemas/OpcaoGerarComprovante" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IBAMACertidaoNegativaDebitosRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/IBAMACertidaoNegativaEmbargos": { "get": { "tags": [ "IBAMA - Certidão Negativa de Embargo" ], "summary": "Endpoint para realizar a consulta IBAMA - Certidão Negativa de Embargo.", "description": "Informe apenas um único documento por requisição.", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "CNPJ", "in": "query", "description": "O parâmetro CNPJ pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "GERARCOMPROVANTE", "in": "query", "description": "Este parâmetro possibilita gerar o comprovante em PDF desta consulta.", "schema": { "$ref": "#/components/schemas/OpcaoGerarComprovante" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IBAMACertidaoNegativaEmbargoRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/IBAMACertificadoRegularidade": { "get": { "tags": [ "IBAMA - Certificado de Regularidade" ], "summary": "Endpoint para realizar a consulta IBAMA - Certificado de Regularidade.", "description": "Informe apenas um único documento por requisição.", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "CNPJ", "in": "query", "description": "O parâmetro CNPJ pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "GERARCOMPROVANTE", "in": "query", "description": "Este parâmetro possibilita gerar o comprovante em PDF desta consulta.", "schema": { "$ref": "#/components/schemas/OpcaoGerarComprovante" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IBAMACertificadoRegularidadeRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/IBAMAConsultaAutuacoesAmbientais": { "get": { "tags": [ "IBAMA - Consulta de Autuações Ambientais" ], "summary": "Endpoint para realizar a consulta IBAMA - Consulta de Autuações Ambientais.", "description": "Informe apenas um único documento por requisição.", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "CNPJ", "in": "query", "description": "O parâmetro CNPJ pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "GERARCOMPROVANTE", "in": "query", "description": "Este parâmetro possibilita gerar o comprovante em PDF desta consulta.", "schema": { "$ref": "#/components/schemas/OpcaoGerarComprovante" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IBAMAConsultaAutuacoesAmbientaisRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/IdentityVerificationArgentina": { "get": { "tags": [ "Identity Verification - Argentina" ], "summary": "Endpoint para realizar a consulta Identity Verification - Argentina. Obs: esta consulta não possui comprovante.", "description": "Informe apenas um único documento por requisição.", "parameters": [ { "name": "DNI", "in": "query", "description": "O parâmetro DNI pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "NAME", "in": "query", "description": "O parâmetro NAME pode ser enviado com qualquer outro.", "schema": { "type": "string" } }, { "name": "SURNAME", "in": "query", "description": "O parâmetro SURNAME pode ser enviado com qualquer outro.", "schema": { "type": "string" } }, { "name": "DOB", "in": "query", "description": "O parâmetro DOB deve ser fornecido, com ou sem formatação.", "schema": { "type": "string" } }, { "name": "GENDER", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "ADDRESS", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "CITY", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "STATE", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "POSTCODE", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "PHONE", "in": "query", "description": "O parâmetro PHONE pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "COUNTRY", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityVerificationArgentinaRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/Interpol": { "get": { "tags": [ "INTERPOL" ], "summary": "Endpoint para realizar a consulta INTERPOL. Obs: esta consulta não possui comprovante.", "description": "", "parameters": [ { "name": "NOME", "in": "query", "description": "O parâmetro NOME pode ser enviado em maiúsculo ou minúsculo.", "schema": { "type": "string" } }, { "name": "SOBRENOME", "in": "query", "description": "O parâmetro SOBRENOME pode ser enviado em maiúsculo ou minúsculo.", "schema": { "type": "string" } }, { "name": "DATANASCIMENTO", "in": "query", "description": "O parâmetro DATANASCIMENTO deve ser fornecido, com ou sem formatação.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InterpolRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/MinisterioTrabalhoPIS": { "get": { "tags": [ "Ministério do Trabalho - PIS" ], "summary": "Endpoint para realizar a consulta Ministério do Trabalho - PIS. Obs: esta consulta não possui comprovante.", "description": "", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MinisterioTrabalhoPISRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/MTEInfracoesTrabalhistas": { "get": { "tags": [ "Ministério do Trabalho e do Emprego (MTE) - Infrações Trabalhistas" ], "summary": "Endpoint para realizar a consulta Ministério do Trabalho e do Emprego (MTE) - Infrações Trabalhistas.", "description": "Informe apenas um único documento por requisição.", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "CNPJ", "in": "query", "description": "O parâmetro CNPJ pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "TIPO", "in": "query", "description": "", "schema": { "$ref": "#/components/schemas/OpcaoTipoMTE" } }, { "name": "GERARCOMPROVANTE", "in": "query", "description": "Este parâmetro possibilita gerar o comprovante em PDF desta consulta.", "schema": { "$ref": "#/components/schemas/OpcaoGerarComprovante" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MTEInfracoesTrabalhistasRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/MPMTMinisterioPublicoMatoGrosso": { "get": { "tags": [ "Ministério Público do Estado de Mato Grosso (MPMT) - Procedimentos Investigatórios Extrajudiciais" ], "summary": "Endpoint para realizar a consulta Ministério Público do Estado de Mato Grosso (MPMT) - Procedimentos Investigatórios Extrajudiciais.", "description": "Informe apenas um único documento por requisição.", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "CNPJ", "in": "query", "description": "O parâmetro CNPJ pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "GERARCOMPROVANTE", "in": "query", "description": "Este parâmetro possibilita gerar o comprovante em PDF desta consulta.", "schema": { "$ref": "#/components/schemas/OpcaoGerarComprovante" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MPMTMinisterioPublicoMatoGrossoRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/MPFCertidaoNegativa": { "get": { "tags": [ "Ministério Público Federal - Certidão Negativa" ], "summary": "Endpoint para realizar a consulta Ministério Público Federal - Certidão Negativa.", "description": "Informe apenas um único documento por requisição.", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "CNPJ", "in": "query", "description": "O parâmetro CNPJ pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "GERARCOMPROVANTE", "in": "query", "description": "Este parâmetro possibilita gerar o comprovante em PDF desta consulta.", "schema": { "$ref": "#/components/schemas/OpcaoGerarComprovante" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MPFCertidaoNegativaRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/MinisterioPublicoTrabalho": { "get": { "tags": [ "MPT - Ministério Público do Trabalho " ], "summary": "Endpoint para realizar a consulta MPT - Ministério Público do Trabalho .", "description": "O(s) parâmetro(s) REGIAO é(são) obrigatório(s) para esta consulta. Envie juntamente com CPF ou CNPJ.", "parameters": [ { "name": "CNPJ", "in": "query", "description": "O parâmetro CNPJ pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "REGIAO", "in": "query", "description": "O parâmetro REGIAO deve ser enviado.", "required": true, "schema": { "$ref": "#/components/schemas/OpcaoRegiaoMPT" } }, { "name": "GERARCOMPROVANTE", "in": "query", "description": "Este parâmetro possibilita gerar o comprovante em PDF desta consulta.", "schema": { "$ref": "#/components/schemas/OpcaoGerarComprovante" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MinisterioPublicoTrabalhoRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/NotaFiscalEletronicaCompleta": { "get": { "tags": [ "NFe - Nota Fiscal Eletrônica - Completa" ], "summary": "Endpoint para realizar a consulta NFe - Nota Fiscal Eletrônica - Completa.", "description": "", "parameters": [ { "name": "CHAVE", "in": "query", "description": "O parâmetro CHAVE pode ser enviado com qualquer outro.", "schema": { "type": "string" } }, { "name": "GERARCOMPROVANTE", "in": "query", "description": "Este parâmetro possibilita gerar o comprovante em PDF desta consulta.", "schema": { "$ref": "#/components/schemas/OpcaoGerarComprovante" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotaFiscalEletronicaCompletaRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/NotaFiscalEletronicaInutilizacao": { "get": { "tags": [ "NFe - Nota Fiscal Eletrônica - Inutilizações" ], "summary": "Endpoint para realizar a consulta NFe - Nota Fiscal Eletrônica - Inutilizações.", "description": "Informe apenas um único documento por requisição.", "parameters": [ { "name": "CNPJ", "in": "query", "description": "O parâmetro CNPJ pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "ANO", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "GERARCOMPROVANTE", "in": "query", "description": "Este parâmetro possibilita gerar o comprovante em PDF desta consulta.", "schema": { "$ref": "#/components/schemas/OpcaoGerarComprovante" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotaFiscalEletronicaInutilizacaoRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/NivelSocioeconomico": { "get": { "tags": [ "Nível Socioeconômico e Renda Estimada" ], "summary": "Endpoint para realizar a consulta Nível Socioeconômico e Renda Estimada. Obs: esta consulta não possui comprovante.", "description": "", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NivelSocioeconomicoRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/NivelSocioeconomico/Crypt": { "get": { "tags": [ "Nível Socioeconômico e Renda Estimada" ], "summary": "Endpoint para realizar a consulta de Nível Socioeconômico Crypt. Obs: esta consulta não possui comprovante.", "operationId": "Realizar consulta Nível Socioeconômico encriptada.", "parameters": [ { "name": "query", "in": "query", "description": "O parâmetro query deve estar encriptado para realizar a consulta.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NivelSocioeconomicoRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/OABCadastroNacionalAdvogados": { "get": { "tags": [ "OAB - Cadastro Nacional dos Advogados" ], "summary": "Endpoint para realizar a consulta OAB - Cadastro Nacional dos Advogados.", "description": "Informe apenas um único documento por requisição.", "parameters": [ { "name": "NOME", "in": "query", "description": "O parâmetro NOME pode ser enviado com qualquer outro.", "schema": { "type": "string" } }, { "name": "INSCRICAO", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "UF", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "GERARCOMPROVANTE", "in": "query", "description": "Este parâmetro possibilita gerar o comprovante em PDF desta consulta.", "schema": { "$ref": "#/components/schemas/OpcaoGerarComprovante" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OABCadastroNacionalAdvogadosRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/Obito": { "get": { "tags": [ "Óbito" ], "summary": "Endpoint para realizar a consulta Óbito. Obs: esta consulta não possui comprovante.", "description": "🌐 Fornecedor Externo", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObitoRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } }, "x-badges": [ { "name": "🌐 Fornecedor Externo", "color": "#1976d2" } ] } }, "/api/OFAC": { "get": { "tags": [ "OFAC - Sanctions List (SND and Non-SDN)" ], "summary": "Endpoint para realizar a consulta OFAC - Sanctions List (SND and Non-SDN). Obs: esta consulta não possui comprovante.", "description": "", "parameters": [ { "name": "NOME", "in": "query", "description": "O parâmetro NOME pode ser enviado em maiúsculo ou minúsculo.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OFACSanctionsSearchRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/OffshoreLeaks": { "get": { "tags": [ "Offshore Leaks - ICIJ" ], "summary": "Endpoint para realizar a consulta Offshore Leaks - ICIJ. Obs: esta consulta não possui comprovante.", "description": "Informe apenas um único documento por requisição.", "parameters": [ { "name": "NOME", "in": "query", "description": "O parâmetro NOME pode ser enviado com qualquer outro.", "schema": { "type": "string" } }, { "name": "NODEID", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OffshoreLeaksRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/PessoaExpostaPoliticamente": { "get": { "tags": [ "PEP - Pessoa Exposta Politicamente" ], "summary": "Endpoint para realizar a consulta PEP - Pessoa Exposta Politicamente. Obs: esta consulta não possui comprovante.", "description": "", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PEPRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/PEPParentescos": { "get": { "tags": [ "PEP Estendida - Pessoa Exposta Politicamente + Parentescos" ], "summary": "Endpoint para realizar a consulta PEP Estendida - Pessoa Exposta Politicamente + Parentescos. Obs: esta consulta não possui comprovante.", "description": "", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PEPParentescosRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/PETITrabalhoInfantil": { "get": { "tags": [ "PETI - Programa de Erradicação do Trabalho Infantil" ], "summary": "Endpoint para realizar a consulta PETI - Programa de Erradicação do Trabalho Infantil. Obs: esta consulta não possui comprovante.", "description": "Informe apenas um único documento por requisição.", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "NIS", "in": "query", "description": "O parâmetro NIS pode ser enviado com ou sem formatação.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PETITrabalhoInfantilRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/PGFNListaDevedoresUniao": { "get": { "tags": [ "PGFN - Lista de Devedores da União" ], "summary": "Endpoint para realizar a consulta PGFN - Lista de Devedores da União.", "description": "Informe apenas um único documento por requisição.", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "CNPJ", "in": "query", "description": "O parâmetro CNPJ pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "GERARCOMPROVANTE", "in": "query", "description": "Este parâmetro possibilita gerar o comprovante em PDF desta consulta.", "schema": { "$ref": "#/components/schemas/OpcaoGerarComprovante" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PGFNListaDevedoresUniaoRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/PoliciaCivilAntecedentesCriminais": { "get": { "tags": [ "Polícia Civil - Antecedentes Criminais" ], "summary": "Endpoint para realizar a consulta Polícia Civil - Antecedentes Criminais.", "description": "O(s) parâmetro(s) UF é(são) obrigatório(s) para esta consulta. Envie juntamente com CPF ou RG ou NOMEMAE ou NOME ou DATANASCIMENTO.", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "RG", "in": "query", "description": "O parâmetro RG pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "NOMEMAE", "in": "query", "description": "O parâmetro NOMEMAE pode ser enviado com qualquer outro.", "schema": { "type": "string" } }, { "name": "NOME", "in": "query", "description": "O parâmetro NOME pode ser enviado com qualquer outro.", "schema": { "type": "string" } }, { "name": "DATANASCIMENTO", "in": "query", "description": "O parâmetro DATANASCIMENTO deve ser fornecido, com ou sem formatação.", "schema": { "type": "string" } }, { "name": "GENERO", "in": "query", "description": "", "schema": { "$ref": "#/components/schemas/OpcaoGenero" } }, { "name": "UF", "in": "query", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/OpcaoUF" } }, { "name": "GERARCOMPROVANTE", "in": "query", "description": "Este parâmetro possibilita gerar o comprovante em PDF desta consulta.", "schema": { "$ref": "#/components/schemas/OpcaoGerarComprovante" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PoliciaCivilAntecedentesCriminaisRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/PoliciaFederalAntecedentesCriminais": { "get": { "tags": [ "Polícia Federal - Antecedentes Criminais" ], "summary": "Endpoint para realizar a consulta Polícia Federal - Antecedentes Criminais.", "description": "", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "NOME", "in": "query", "description": "O parâmetro NOME deve ser enviado de forma completa.", "schema": { "type": "string" } }, { "name": "DATANASCIMENTO", "in": "query", "description": "O parâmetro DATANASCIMENTO deve ser enviado nestes formatos: dd/mm/aaaa ou dd-mm-aaaa.", "schema": { "type": "string" } }, { "name": "NOMEMAE", "in": "query", "description": "O parâmetro NOMEMAE deve ser enviado de forma completa.", "schema": { "type": "string" } }, { "name": "NOMEPAI", "in": "query", "description": "O parâmetro NOMEPAI deve ser enviado de forma completa.", "schema": { "type": "string" } }, { "name": "GERARCOMPROVANTE", "in": "query", "description": "Este parâmetro possibilita gerar o comprovante em PDF desta consulta.", "schema": { "$ref": "#/components/schemas/OpcaoGerarComprovante" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PoliciaFederalAntecedentesCriminaisRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/PRFInfracoes": { "get": { "tags": [ "Polícia Rodoviária Federal - Infrações" ], "summary": "Endpoint para realizar a consulta Polícia Rodoviária Federal - Infrações. Obs: esta consulta não possui comprovante.", "description": "O(s) parâmetro(s) PLACA e RENAVAM é(são) obrigatório(s) para esta consulta. Envie juntamente com TIPO.", "parameters": [ { "name": "PLACA", "in": "query", "description": "O parâmetro PLACA pode ser enviado com ou sem formatação.", "required": true, "schema": { "type": "string" } }, { "name": "RENAVAM", "in": "query", "description": "O parâmetro RENAVAM deve ser informado juntamente com seus 11 dígitos numéricos.", "required": true, "schema": { "type": "string" } }, { "name": "TIPO", "in": "query", "description": "O parâmetro TIPO deve ser escolhido.", "required": true, "schema": { "$ref": "#/components/schemas/OpcaoTipoInfracoes" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PRFInfracoesRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/PortalTransparenciaIndicadoresPessoaFisica": { "get": { "tags": [ "Portal da Transparência - Indicadores Pessoa Física" ], "summary": "Endpoint para realizar a consulta Portal da Transparência - Indicadores Pessoa Física. Obs: esta consulta não possui comprovante.", "description": "Informe apenas um único documento por requisição.", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "NIS", "in": "query", "description": "O parâmetro NIS pode ser enviado com ou sem formatação.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PortalTransparenciaIndicadoresPessoaFisicaRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/PortalTransparenciaIndicadoresPessoaJuridica": { "get": { "tags": [ "Portal da Transparência - Indicadores Pessoa Jurídica" ], "summary": "Endpoint para realizar a consulta Portal da Transparência - Indicadores Pessoa Jurídica. Obs: esta consulta não possui comprovante.", "description": "", "parameters": [ { "name": "CNPJ", "in": "query", "description": "O parâmetro CNPJ pode ser enviado com ou sem formatação.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PortalTransparenciaIndicadoresPessoaJuridicaRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/PortalTransparenciaServidoresCompleta": { "get": { "tags": [ "Portal da Transparência - Servidores - Completa" ], "summary": "Endpoint para realizar a consulta Portal da Transparência - Servidores - Completa.", "description": "", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "GERARCOMPROVANTE", "in": "query", "description": "Este parâmetro possibilita gerar o comprovante em PDF desta consulta.", "schema": { "$ref": "#/components/schemas/OpcaoGerarComprovante" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PortalTransparenciaServidoresCompletaRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/PortalTransparenciaServidoresRemuneracao": { "get": { "tags": [ "Portal da Transparência - Servidores - Remuneração" ], "summary": "Endpoint para realizar a consulta Portal da Transparência - Servidores - Remuneração. Obs: esta consulta não possui comprovante.", "description": "Informe apenas um único documento por requisição.", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "MESANO", "in": "query", "description": "O parâmetro MESANO (mês de competência da folha) é opcional e pode ser enviado nos formatos MM/yyyy, MM-yyyy ou MMyyyy. Quando informado, a consulta retorna a remuneração da competência solicitada; se omitido, retorna a competência mais recente publicada no Portal da Transparência.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PortalTransparenciaServidoresRemuneracaoRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/PortalTransparenciaServidores": { "get": { "tags": [ "Portal da Transparência - Servidores do Poder Executivo Federal" ], "summary": "Endpoint para realizar a consulta Portal da Transparência - Servidores do Poder Executivo Federal. Obs: esta consulta não possui comprovante.", "description": "", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PortalTransparenciaServidoresRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/PortalTransparenciaServidoresViagens": { "get": { "tags": [ "Portal da Transparência - Servidores Viagens e despesas" ], "summary": "Endpoint para realizar a consulta Portal da Transparência - Servidores Viagens e despesas. Obs: esta consulta não possui comprovante.", "description": "", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PortalTransparenciaServidoresViagensRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/ProcessosJudiciaisAgrupada": { "get": { "tags": [ "Processos Judiciais - Agrupada (Base)" ], "summary": "Endpoint para realizar a consulta Processos Judiciais - Agrupada (Base). Obs: esta consulta não possui comprovante.", "description": "Informe apenas um único documento por requisição.\n\n🌐 Fornecedor Externo", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "CNPJ", "in": "query", "description": "O parâmetro CNPJ pode ser enviado com ou sem formatação.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessosJudiciaisAgrupadaRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } }, "x-badges": [ { "name": "🌐 Fornecedor Externo", "color": "#1976d2" } ] } }, "/api/ProcessosJudiciaisCompleta": { "get": { "tags": [ "Processos Judiciais - Completa (Base)" ], "summary": "Endpoint para realizar a consulta Processos Judiciais - Completa (Base). Obs: esta consulta não possui comprovante.", "description": "Informe apenas um único documento por requisição.\n\n🌐 Fornecedor Externo", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "CNPJ", "in": "query", "description": "O parâmetro CNPJ pode ser enviado com ou sem formatação.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessosJudiciaisCompletaRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } }, "x-badges": [ { "name": "🌐 Fornecedor Externo", "color": "#1976d2" } ] } }, "/api/ProcessosJudiciaisSimplificada": { "get": { "tags": [ "Processos Judiciais - Simplificada (Base)" ], "summary": "Endpoint para realizar a consulta Processos Judiciais - Simplificada (Base). Obs: esta consulta não possui comprovante.", "description": "Informe apenas um único documento por requisição.\n\n🌐 Fornecedor Externo", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "CNPJ", "in": "query", "description": "O parâmetro CNPJ pode ser enviado com ou sem formatação.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessosJudiciaisSimplificadaRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } }, "x-badges": [ { "name": "🌐 Fornecedor Externo", "color": "#1976d2" } ] } }, "/api/ProtestosBasica": { "get": { "tags": [ "Protestos Nacional - IEPTB Básica" ], "summary": "Endpoint para realizar a consulta Protestos Nacional - IEPTB Básica. Obs: esta consulta não possui comprovante.", "description": "Informe apenas um único documento por requisição.\n\n🌐 Fornecedor Externo", "parameters": [ { "name": "CNPJ", "in": "query", "description": "O parâmetro CNPJ pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProtestosBasicaRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } }, "x-badges": [ { "name": "🌐 Fornecedor Externo", "color": "#1976d2" } ] } }, "/api/ProtestosCompleta": { "get": { "tags": [ "Protestos Nacional - IEPTB Completa" ], "summary": "Endpoint para realizar a consulta Protestos Nacional - IEPTB Completa. Obs: esta consulta não possui comprovante.", "description": "Informe apenas um único documento por requisição.\n\n🌐 Fornecedor Externo", "parameters": [ { "name": "CNPJ", "in": "query", "description": "O parâmetro CNPJ pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProtestosCompletaRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } }, "x-badges": [ { "name": "🌐 Fornecedor Externo", "color": "#1976d2" } ] } }, "/api/ProtestosOnline": { "get": { "tags": [ "Protestos Nacional - IEPTB Online" ], "summary": "Endpoint para realizar a consulta Protestos Nacional - IEPTB Online. Obs: esta consulta não possui comprovante.", "description": "Informe apenas um único documento por requisição.\n\n🌐 Fornecedor Externo", "parameters": [ { "name": "CNPJ", "in": "query", "description": "O parâmetro CNPJ pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProtestosOnlineRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } }, "x-badges": [ { "name": "🌐 Fornecedor Externo", "color": "#1976d2" } ] } }, "/api/ReceitaFederalPessoaFisica": { "get": { "tags": [ "Receita Federal - Pessoa Física" ], "summary": "Endpoint para realizar a consulta Receita Federal - Pessoa Física.", "description": "", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "DATANASCIMENTO", "in": "query", "description": "O parâmetro DATANASCIMENTO deve ser fornecido, com ou sem formatação.", "schema": { "type": "string" } }, { "name": "GERARCOMPROVANTE", "in": "query", "description": "Este parâmetro possibilita gerar o comprovante em PDF desta consulta.", "schema": { "$ref": "#/components/schemas/OpcaoGerarComprovante" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReceitaFederalPessoaFisicaRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/ReceitaPJParticipacaoSocietaria": { "get": { "tags": [ "Receita Federal - Pessoa Jurídica - QSA + Participação Societária" ], "summary": "Endpoint para realizar a consulta Receita Federal - Pessoa Jurídica - QSA + Participação Societária. Obs: esta consulta não possui comprovante.", "description": "", "parameters": [ { "name": "CNPJ", "in": "query", "description": "O parâmetro CNPJ pode ser enviado com ou sem formatação.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReceitaPJParticipacaoSocietariaRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/ReceitaFederalPessoaJuridica": { "get": { "tags": [ "Receita Federal - Pessoa Jurídica" ], "summary": "Endpoint para realizar a consulta Receita Federal - Pessoa Jurídica.", "description": "", "parameters": [ { "name": "CNPJ", "in": "query", "description": "O parâmetro CNPJ pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "QSA", "in": "query", "description": "O parâmetro QSA é utilizado para obter o Quadro de Sócios e Administradores.", "schema": { "$ref": "#/components/schemas/OpcaoGerarComprovante" } }, { "name": "GERARCOMPROVANTE", "in": "query", "description": "Este parâmetro possibilita gerar o comprovante em PDF desta consulta.", "schema": { "$ref": "#/components/schemas/OpcaoGerarComprovante" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReceitaFederalPessoaJuridicaRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/RegistrationDataArgentina": { "get": { "tags": [ "Registration Data - Argentina" ], "summary": "Endpoint para realizar a consulta Registration Data - Argentina. Obs: esta consulta não possui comprovante.", "description": "🌐 Fornecedor Externo", "parameters": [ { "name": "DNI", "in": "query", "description": "O parâmetro DNI pode ser enviado com ou sem formatação. Este parâmetro é obrigatório.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationDataArgentinaRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } }, "x-badges": [ { "name": "🌐 Fornecedor Externo", "color": "#1976d2" } ] } }, "/api/RegistrationDataBrazil": { "get": { "tags": [ "Registration Data - Brazil" ], "summary": "Endpoint para realizar a consulta Registration Data - Brazil. Obs: esta consulta não possui comprovante.", "description": "Informe apenas um único documento por requisição.", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação. Este parâmetro não é obrigatório, mas caso não utilizado, enviar os parâmetros 'NAME', 'SURNAME' e 'DOB'.", "schema": { "type": "string" } }, { "name": "NAME", "in": "query", "description": "O parâmetro NAME pode ser enviado com qualquer outro.", "schema": { "type": "string" } }, { "name": "SURNAME", "in": "query", "description": "O parâmetro SURNAME pode ser enviado com qualquer outro.", "schema": { "type": "string" } }, { "name": "DOB", "in": "query", "description": "DATA DE NASCIMENTO - Ex: yyyy/MM/dd.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationDataBrazilRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/RegistrationDataMexico": { "get": { "tags": [ "Registration Data - México" ], "summary": "Endpoint para realizar a consulta Registration Data - México. Obs: esta consulta não possui comprovante.", "description": "", "parameters": [ { "name": "CURP", "in": "query", "description": "O parâmetro CURP pode ser enviado com ou sem formatação. Este parâmetro não é obrigatório, mas caso não utilizado, enviar os parâmetros 'NAME', 'SURNAME' e 'DOB'.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationDataMexicoRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/RestituicaoIRPF": { "get": { "tags": [ "Restituição Imposto de Renda - IRPF" ], "summary": "Endpoint para realizar a consulta Restituição Imposto de Renda - IRPF. Obs: esta consulta não possui comprovante.", "description": "Informe apenas um único documento por requisição.", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "DATANASCIMENTO", "in": "query", "description": "O parâmetro DATANASCIMENTO deve ser fornecido, com ou sem formatação.", "schema": { "type": "string" } }, { "name": "ANOEXERCICIO", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IRPFRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/Score": { "get": { "tags": [ "Score de Crédito - QUOD" ], "summary": "Endpoint para realizar a consulta Score de Crédito - QUOD. Obs: esta consulta não possui comprovante.", "description": "Informe apenas um único documento por requisição.", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "CNPJ", "in": "query", "description": "O parâmetro CNPJ pode ser enviado com ou sem formatação.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScoreRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/SCRBacen": { "get": { "tags": [ "SCR Analítico - Resumo BACEN" ], "summary": "Endpoint para realizar a consulta SCR Analítico - Resumo BACEN. Obs: esta consulta não possui comprovante.", "description": "Informe apenas um único documento por requisição.\n\n🌐 Fornecedor Externo", "parameters": [ { "name": "CNPJ", "in": "query", "description": "O parâmetro CNPJ pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SCRBacenAnaliticaRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } }, "x-badges": [ { "name": "🌐 Fornecedor Externo", "color": "#1976d2" } ] } }, "/api/SCRBacenDetalhada": { "get": { "tags": [ "SCR Detalhada - Resumo BACEN" ], "summary": "Endpoint para realizar a consulta SCR Detalhada - Resumo BACEN.", "description": "Informe apenas um único documento por requisição.\n\n🌐 Fornecedor Externo", "parameters": [ { "name": "CNPJ", "in": "query", "description": "O parâmetro CNPJ pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "MESANO", "in": "query", "description": "O parâmetro MESANO (mês de competência) é opcional e pode ser enviado nos formatos MM/yyyy, MM-yyyy ou MMyyyy. Quando informado, a consulta retorna o SCR da competência solicitada; se omitido, retorna a competência mais recente disponível.", "schema": { "type": "string" } }, { "name": "GERARCOMPROVANTE", "in": "query", "description": "Este parâmetro possibilita gerar o comprovante em PDF desta consulta.", "schema": { "$ref": "#/components/schemas/OpcaoGerarComprovante" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SCRDetalhadaRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } }, "x-badges": [ { "name": "🌐 Fornecedor Externo", "color": "#1976d2" } ] } }, "/api/SeguroDefeso": { "get": { "tags": [ "Seguro Defeso" ], "summary": "Endpoint para realizar a consulta Seguro Defeso. Obs: esta consulta não possui comprovante.", "description": "Informe apenas um único documento por requisição.", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "NIS", "in": "query", "description": "O parâmetro NIS pode ser enviado com ou sem formatação.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SeguroDefesoRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/SimilarityArgentina": { "get": { "tags": [ "Similarity - Argentina" ], "summary": "Endpoint para realizar a consulta Similarity - Argentina. Obs: esta consulta não possui comprovante.", "description": "Informe apenas um único documento por requisição.", "parameters": [ { "name": "DNI", "in": "query", "description": "O parâmetro DNI pode ser enviado com ou sem formatação. Este parâmetro é obrigatório.", "schema": { "type": "string" } }, { "name": "NAME", "in": "query", "description": "O parâmetro NAME pode ser enviado com qualquer outro.", "schema": { "type": "string" } }, { "name": "SURNAME", "in": "query", "description": "O parâmetro SURNAME pode ser enviado com qualquer outro.", "schema": { "type": "string" } }, { "name": "DOB", "in": "query", "description": "O parâmetro DOB deve ser fornecido, com ou sem formatação.", "schema": { "type": "string" } }, { "name": "ADDRESS", "in": "query", "description": "ENDEREÇO - Ex: Av. Santa Fe, 3250.", "schema": { "type": "string" } }, { "name": "CITY", "in": "query", "description": "NOME DA CIDADE.", "schema": { "type": "string" } }, { "name": "STATE", "in": "query", "description": "ESTADO - Ex: BUE.", "schema": { "type": "string" } }, { "name": "POSTCODE", "in": "query", "description": "CEP - Ex: 1425.", "schema": { "type": "string" } }, { "name": "PHONE", "in": "query", "description": "Caso haja mais de um telefone, use “|” (sem aspas) para separá-los. Ex: 11987654321 | 11912345678.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimilarityArgentinaRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/Similarity": { "get": { "tags": [ "Similarity - Brazil" ], "summary": "Endpoint para realizar a consulta Similarity - Brazil. Obs: esta consulta não possui comprovante.", "description": "Informe apenas um único documento por requisição.", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação. Este parâmetro não é obrigatório, mas caso não utilizado, enviar os parâmetros 'NAME', 'SURNAME' e 'DOB'.", "schema": { "type": "string" } }, { "name": "NAME", "in": "query", "description": "O parâmetro NAME pode ser enviado com qualquer outro.", "schema": { "type": "string" } }, { "name": "SURNAME", "in": "query", "description": "O parâmetro SURNAME pode ser enviado com qualquer outro.", "schema": { "type": "string" } }, { "name": "DOB", "in": "query", "description": "DATA DE NASCIMENTO - Ex: yyyy/MM/dd.", "schema": { "type": "string" } }, { "name": "ADDRESS", "in": "query", "description": "ENDEREÇO - Ex: Rua Óbidos, 674.", "schema": { "type": "string" } }, { "name": "CITY", "in": "query", "description": "NOME DA CIDADE.", "schema": { "type": "string" } }, { "name": "STATE", "in": "query", "description": "ESTADO - Ex: SP.", "schema": { "type": "string" } }, { "name": "POSTCODE", "in": "query", "description": "CEP - Ex: 12345-123.", "schema": { "type": "string" } }, { "name": "PHONE", "in": "query", "description": "Caso haja mais de um telefone, use “|” (sem aspas) para separá-los. Ex: 11912345678 | 11987654321.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimilarityRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/Similarity/Crypt": { "get": { "tags": [ "Similarity - Brazil" ], "summary": "Endpoint para realizar a consulta de Similarity Crypt. Obs: esta consulta não possui comprovante.", "operationId": "Realizar consulta da Similarity encriptada.", "parameters": [ { "name": "query", "in": "query", "description": "O parâmetro query deve estar encriptado para realizar a consulta.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimilarityRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/SimilarityMexico": { "get": { "tags": [ "Similarity - México" ], "summary": "Endpoint para realizar a consulta Similarity - México. Obs: esta consulta não possui comprovante.", "description": "Informe apenas um único documento por requisição.", "parameters": [ { "name": "CURP", "in": "query", "description": "O parâmetro CURP pode ser enviado com ou sem formatação. Este parâmetro não é obrigatório, mas caso não utilizado, enviar os parâmetros 'NAME', 'SURNAME' e 'DOB'.", "schema": { "type": "string" } }, { "name": "NAME", "in": "query", "description": "O parâmetro NAME pode ser enviado com qualquer outro.", "schema": { "type": "string" } }, { "name": "SURNAME", "in": "query", "description": "O parâmetro SURNAME pode ser enviado com qualquer outro.", "schema": { "type": "string" } }, { "name": "DOB", "in": "query", "description": "O parâmetro DOB deve ser fornecido, com ou sem formatação.", "schema": { "type": "string" } }, { "name": "ADDRESS", "in": "query", "description": "ENDEREÇO - Ex: Calle Colinas Del Valle, 3150.", "schema": { "type": "string" } }, { "name": "CITY", "in": "query", "description": "NOME DA CIDADE.", "schema": { "type": "string" } }, { "name": "STATE", "in": "query", "description": "ESTADO - Ex: CHI.", "schema": { "type": "string" } }, { "name": "POSTCODE", "in": "query", "description": "CEP - Ex: 22206.", "schema": { "type": "string" } }, { "name": "PHONE", "in": "query", "description": "Caso haja mais de um telefone, use “|” (sem aspas) para separá-los. Ex: 6641769451 | 4659554184.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimilarityMexicoRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/SimplesNacional": { "get": { "tags": [ "Simples Nacional" ], "summary": "Endpoint para realizar a consulta Simples Nacional.", "description": "", "parameters": [ { "name": "CNPJ", "in": "query", "description": "O parâmetro CNPJ pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "GERARCOMPROVANTE", "in": "query", "description": "Este parâmetro possibilita gerar o comprovante em PDF desta consulta.", "schema": { "$ref": "#/components/schemas/OpcaoGerarComprovante" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimplesNacionalRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/SintegraCCC": { "get": { "tags": [ "Sintegra - Cadastro Centralizado de Contribuinte - CCC" ], "summary": "Endpoint para realizar a consulta Sintegra - Cadastro Centralizado de Contribuinte - CCC.", "description": "O(s) parâmetro(s) UF é(são) obrigatório(s) para esta consulta. Envie juntamente com CPF ou CNPJ ou IE (Inscrição Estadual).", "parameters": [ { "name": "CNPJ", "in": "query", "description": "O parâmetro CNPJ pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "IE", "in": "query", "description": "O parâmetro IE pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "UF", "in": "query", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/OpcaoUF" } }, { "name": "GERARCOMPROVANTE", "in": "query", "description": "Este parâmetro possibilita gerar o comprovante em PDF desta consulta.", "schema": { "$ref": "#/components/schemas/OpcaoGerarComprovante" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SintegraCadastroCentralizadoContribuinteRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/Sintegra": { "get": { "tags": [ "Sintegra - Cadastros Estaduais" ], "summary": "Endpoint para realizar a consulta Sintegra - Cadastros Estaduais.", "description": "O(s) parâmetro(s) UF é(são) obrigatório(s) para esta consulta. Envie juntamente com CPF ou CNPJ ou IE (Inscrição Estadual).", "parameters": [ { "name": "CNPJ", "in": "query", "description": "O parâmetro CNPJ pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "IE", "in": "query", "description": "O parâmetro IE pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "UF", "in": "query", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/OpcaoUF" } }, { "name": "GERARCOMPROVANTE", "in": "query", "description": "Este parâmetro possibilita gerar o comprovante em PDF desta consulta.", "schema": { "$ref": "#/components/schemas/OpcaoGerarComprovante" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SintegraRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/SintegraCCC-Completa": { "get": { "tags": [ "Sintegra - CCC - Completa" ], "summary": "Endpoint para realizar a consulta Sintegra - CCC - Completa.", "description": "Informe apenas um único documento por requisição.", "parameters": [ { "name": "CNPJ", "in": "query", "description": "O parâmetro CNPJ pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "IE", "in": "query", "description": "O parâmetro IE pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "UF", "in": "query", "description": "", "schema": { "$ref": "#/components/schemas/OpcaoUF" } }, { "name": "GERARCOMPROVANTE", "in": "query", "description": "Este parâmetro possibilita gerar o comprovante em PDF desta consulta.", "schema": { "$ref": "#/components/schemas/OpcaoGerarComprovante" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SintegraCCCCompletaRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/STMCertidaoNegativaUniao": { "get": { "tags": [ "STM - Certidão Negativa da União" ], "summary": "Endpoint para realizar a consulta STM - Certidão Negativa da União.", "description": "Informe apenas um único documento por requisição.", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "NOME", "in": "query", "description": "O parâmetro NOME pode ser enviado com qualquer outro.", "schema": { "type": "string" } }, { "name": "DATANASCIMENTO", "in": "query", "description": "O parâmetro DATANASCIMENTO deve ser fornecido, com ou sem formatação.", "schema": { "type": "string" } }, { "name": "NOMEMAE", "in": "query", "description": "O parâmetro NOMEMAE pode ser enviado com qualquer outro.", "schema": { "type": "string" } }, { "name": "GERARCOMPROVANTE", "in": "query", "description": "Este parâmetro possibilita gerar o comprovante em PDF desta consulta.", "schema": { "$ref": "#/components/schemas/OpcaoGerarComprovante" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/STMCertidaoNegativaUniaoRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/SuframaCNPJ": { "get": { "tags": [ "Suframa - CNPJ" ], "summary": "Endpoint para realizar a consulta Suframa - CNPJ.", "description": "", "parameters": [ { "name": "CNPJ", "in": "query", "description": "O parâmetro CNPJ pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "GERARCOMPROVANTE", "in": "query", "description": "Este parâmetro possibilita gerar o comprovante em PDF desta consulta.", "schema": { "$ref": "#/components/schemas/OpcaoGerarComprovante" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuframaCNPJRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/SuicaSECO": { "get": { "tags": [ "Suíça SECO - Sanções Internacionais" ], "summary": "Endpoint para realizar a consulta Suíça SECO - Sanções Internacionais. Obs: esta consulta não possui comprovante.", "description": "", "parameters": [ { "name": "NOME", "in": "query", "description": "O parâmetro NOME pode ser enviado com qualquer outro.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuicaSECORetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/TCUCertidaoNegativaLicitanteInidoneo": { "get": { "tags": [ "TCU - Certidão Negativa de Licitante Inidôneo" ], "summary": "Endpoint para realizar a consulta TCU - Certidão Negativa de Licitante Inidôneo.", "description": "Informe apenas um único documento por requisição.", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "CNPJ", "in": "query", "description": "O parâmetro CNPJ pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "GERARCOMPROVANTE", "in": "query", "description": "Este parâmetro possibilita gerar o comprovante em PDF desta consulta.", "schema": { "$ref": "#/components/schemas/OpcaoGerarComprovante" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TCUCertidaoNegativaLicitanteInidoneoRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/TCUCertidaoNegativaProcesso": { "get": { "tags": [ "TCU - Certidão Negativa de Processo" ], "summary": "Endpoint para realizar a consulta TCU - Certidão Negativa de Processo.", "description": "Informe apenas um único documento por requisição.", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "CNPJ", "in": "query", "description": "O parâmetro CNPJ pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "GERARCOMPROVANTE", "in": "query", "description": "Este parâmetro possibilita gerar o comprovante em PDF desta consulta.", "schema": { "$ref": "#/components/schemas/OpcaoGerarComprovante" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TCUCertidaoNegativaProcessoRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/TCUConsultaConsolidadaPessoaJuridica": { "get": { "tags": [ "TCU - Consulta Consolidada de Pessoa Jurídica - APF" ], "summary": "Endpoint para realizar a consulta TCU - Consulta Consolidada de Pessoa Jurídica - APF.", "description": "", "parameters": [ { "name": "CNPJ", "in": "query", "description": "O parâmetro CNPJ pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "GERARCOMPROVANTE", "in": "query", "description": "Este parâmetro possibilita gerar o comprovante em PDF desta consulta.", "schema": { "$ref": "#/components/schemas/OpcaoGerarComprovante" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TCUConsultaConsolidadaPessoaJuridicaRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/TJCertidaoCivelCriminalFiscal": { "get": { "tags": [ "TJ - Certidão Cível, Criminal e Fiscal - Tribunal de Justiça" ], "summary": "Endpoint para realizar a consulta TJ - Certidão Cível, Criminal e Fiscal - Tribunal de Justiça.", "description": "O(s) parâmetro(s) UF e TIPO é(são) obrigatório(s) para esta consulta. Envie juntamente com CPF ou CNPJ.", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "CNPJ", "in": "query", "description": "O parâmetro CNPJ pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "NOME", "in": "query", "description": "O parâmetro NOME deve ser enviado de forma completa.", "schema": { "type": "string" } }, { "name": "DATANASCIMENTO", "in": "query", "description": "O parâmetro DATANASCIMENTO deve ser enviado nestes formatos: dd/mm/aaaa ou dd-mm-aaaa.", "schema": { "type": "string" } }, { "name": "NOMEMAE", "in": "query", "description": "O parâmetro NOMEMAE deve ser enviado de forma completa.", "schema": { "type": "string" } }, { "name": "NOMEPAI", "in": "query", "description": "O parâmetro NOMEPAI deve ser enviado de forma completa.", "schema": { "type": "string" } }, { "name": "RG", "in": "query", "description": "O parâmetro RG pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "GENERO", "in": "query", "description": "", "schema": { "$ref": "#/components/schemas/OpcaoGenero" } }, { "name": "UF", "in": "query", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/OpcaoUF" } }, { "name": "TIPO", "in": "query", "description": "O parâmetro TIPO deve ser enviado.", "required": true, "schema": { "$ref": "#/components/schemas/OpcaoTipoCertidaoTJ" } }, { "name": "GERARCOMPROVANTE", "in": "query", "description": "Este parâmetro possibilita gerar o comprovante em PDF desta consulta.", "schema": { "$ref": "#/components/schemas/OpcaoGerarComprovante" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TJCertidaoCivelCriminalFiscalRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/TribunalJustica": { "get": { "tags": [ "TJ - Tribunal de Justiça - Processos" ], "summary": "Endpoint para realizar a consulta TJ - Tribunal de Justiça - Processos. Obs: esta consulta não possui comprovante.", "description": "O(s) parâmetro(s) UF e GRAU é(são) obrigatório(s) para esta consulta. Envie juntamente com CPF ou CNPJ ou NOMEPARTE ou NUMEROPROCESSO.", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "CNPJ", "in": "query", "description": "O parâmetro CNPJ pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "NOMEPARTE", "in": "query", "description": "O parâmetro NOMEPARTE deve ser enviado de forma completa.", "schema": { "type": "string" } }, { "name": "NUMEROPROCESSO", "in": "query", "description": "O parâmetro NUMEROPROCESSO pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "UF", "in": "query", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/OpcaoUF" } }, { "name": "GRAU", "in": "query", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/OpcaoGrauTJ" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TribunalJusticaRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/TribunalRegionalFederal": { "get": { "tags": [ "TRF - Tribunal Regional Federal (Certidão Cível, Eleitoral ou Criminal)" ], "summary": "Endpoint para realizar a consulta TRF - Tribunal Regional Federal (Certidão Cível, Eleitoral ou Criminal).", "description": "O(s) parâmetro(s) REGIAO e TIPO é(são) obrigatório(s) para esta consulta. Envie juntamente com CPF ou CNPJ.", "parameters": [ { "name": "CNPJ", "in": "query", "description": "O parâmetro CNPJ pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "REGIAO", "in": "query", "description": "O parâmetro REGIAO deve ser enviado.", "required": true, "schema": { "$ref": "#/components/schemas/OpcaoRegiaoTRF" } }, { "name": "TIPO", "in": "query", "description": "O parâmetro TIPO deve ser enviado.", "required": true, "schema": { "$ref": "#/components/schemas/OpcaoTipoTRF" } }, { "name": "GERARCOMPROVANTE", "in": "query", "description": "Este parâmetro possibilita gerar o comprovante em PDF desta consulta.", "schema": { "$ref": "#/components/schemas/OpcaoGerarComprovante" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TribunalRegionalFederalRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/TribunalRegionalTrabalho": { "get": { "tags": [ "TRT - Tribunal Regional do Trabalho" ], "summary": "Endpoint para realizar a consulta TRT - Tribunal Regional do Trabalho.", "description": "O(s) parâmetro(s) REGIAO é(são) obrigatório(s) para esta consulta. Envie juntamente com CPF ou CNPJ.", "parameters": [ { "name": "CNPJ", "in": "query", "description": "O parâmetro CNPJ pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "REGIAO", "in": "query", "description": "O parâmetro REGIAO deve ser enviado.", "required": true, "schema": { "$ref": "#/components/schemas/OpcaoRegiaoTRT" } }, { "name": "TIPO", "in": "query", "description": "O parâmetro TIPO deve ser enviado.", "schema": { "$ref": "#/components/schemas/OpcaoTipoTRT" } }, { "name": "GERARCOMPROVANTE", "in": "query", "description": "Este parâmetro possibilita gerar o comprovante em PDF desta consulta.", "schema": { "$ref": "#/components/schemas/OpcaoGerarComprovante" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TribunalRegionalTrabalhoRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/TSECertidaoCrimesEleitorais": { "get": { "tags": [ "TSE - Certidão de Crimes Eleitorais" ], "summary": "Endpoint para realizar a consulta TSE - Certidão de Crimes Eleitorais.", "description": "O(s) parâmetro(s) NOME e DATANASCIMENTO e NOMEMAE e CPF é(são) obrigatório(s) para esta consulta. Envie juntamente com NOMEPAI.", "parameters": [ { "name": "NOME", "in": "query", "description": "O parâmetro NOME deve ser enviado de forma completa.", "required": true, "schema": { "type": "string" } }, { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "required": true, "schema": { "type": "string" } }, { "name": "NOMEMAE", "in": "query", "description": "O parâmetro NOMEMAE deve ser enviado de forma completa.", "required": true, "schema": { "type": "string" } }, { "name": "NOMEPAI", "in": "query", "description": "O parâmetro NOMEPAI deve ser enviado de forma completa.", "schema": { "type": "string" } }, { "name": "NUMEROTITULOELEITORAL", "in": "query", "description": "O parâmetro NUMEROTITULOELEITORAL pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "DATANASCIMENTO", "in": "query", "description": "O parâmetro DATANASCIMENTO deve ser enviado nestes formatos: dd/mm/aaaa ou dd-mm-aaaa.", "required": true, "schema": { "type": "string" } }, { "name": "GERARCOMPROVANTE", "in": "query", "description": "Este parâmetro possibilita gerar o comprovante em PDF desta consulta.", "schema": { "$ref": "#/components/schemas/OpcaoGerarComprovante" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TSECertidaoCrimesEleitoraisRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/TSECertidaodeQuitacaoEleitoral": { "get": { "tags": [ "TSE - Certidão de Quitação Eleitoral" ], "summary": "Endpoint para realizar a consulta TSE - Certidão de Quitação Eleitoral.", "description": "O(s) parâmetro(s) NOME e DATANASCIMENTO e NOMEMAE e CPF é(são) obrigatório(s) para esta consulta. Envie juntamente com NOMEPAI.", "parameters": [ { "name": "NOME", "in": "query", "description": "O parâmetro NOME deve ser enviado de forma completa.", "required": true, "schema": { "type": "string" } }, { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "required": true, "schema": { "type": "string" } }, { "name": "NOMEMAE", "in": "query", "description": "O parâmetro NOMEMAE deve ser enviado de forma completa.", "required": true, "schema": { "type": "string" } }, { "name": "NOMEPAI", "in": "query", "description": "O parâmetro NOMEPAI deve ser enviado de forma completa.", "schema": { "type": "string" } }, { "name": "NUMEROTITULOELEITORAL", "in": "query", "description": "O parâmetro NUMEROTITULOELEITORAL pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "DATANASCIMENTO", "in": "query", "description": "O parâmetro DATANASCIMENTO deve ser enviado nestes formatos: dd/mm/aaaa ou dd-mm-aaaa.", "required": true, "schema": { "type": "string" } }, { "name": "GERARCOMPROVANTE", "in": "query", "description": "Este parâmetro possibilita gerar o comprovante em PDF desta consulta.", "schema": { "$ref": "#/components/schemas/OpcaoGerarComprovante" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TSECertidaodeQuitacaoEleitoralRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/SituacaoEleitoral": { "get": { "tags": [ "TSE - Situação Eleitoral" ], "summary": "Endpoint para realizar a consulta TSE - Situação Eleitoral. Obs: esta consulta não possui comprovante.", "description": "Informe apenas um único documento por requisição.\n\n⚠️ Em manutenção", "parameters": [ { "name": "NOME", "in": "query", "description": "O parâmetro NOME deve ser enviado de forma completa. Caso informado, enviar também DATANASCIMENTO nestes formatos: dd/mm/aaaa ou dd-mm-aaaa.", "schema": { "type": "string" } }, { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "NUMEROTITULOELEITORAL", "in": "query", "description": "O parâmetro NUMEROTITULOELEITORAL pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "DATANASCIMENTO", "in": "query", "description": "O parâmetro DATANASCIMENTO deve ser enviado nestes formatos: dd/mm/aaaa ou dd-mm-aaaa. Caso informado, enviar também NOME de forma completa.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SituacaoEleitoralRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } }, "x-badges": [ { "name": "⚠️ Em manutenção", "color": "#d32f2f" } ] } }, "/api/TituloLocalVotacao": { "get": { "tags": [ "TSE - Título e Local de Votação" ], "summary": "Endpoint para realizar a consulta TSE - Título e Local de Votação. Obs: esta consulta não possui comprovante.", "description": "O(s) parâmetro(s) NOMEMAE e DATANASCIMENTO é(são) obrigatório(s) para esta consulta. Envie juntamente com NOME ou CPF ou NUMEROTITULOELEITORAL.", "parameters": [ { "name": "NOME", "in": "query", "description": "O parâmetro NOME deve ser enviado de forma completa.", "schema": { "type": "string" } }, { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "NUMEROTITULOELEITORAL", "in": "query", "description": "O parâmetro NUMEROTITULOELEITORAL pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "DATANASCIMENTO", "in": "query", "description": "O parâmetro DATANASCIMENTO deve ser enviado nestes formatos: dd/mm/aaaa ou dd-mm-aaaa.", "required": true, "schema": { "type": "string" } }, { "name": "NOMEMAE", "in": "query", "description": "O parâmetro NOMEMAE deve ser enviado de forma completa.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TituloLocalDeVotacaoRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/TSTCertidaoNegativaDebitosTrabalhistas": { "get": { "tags": [ "TST - Certidão Negativa de Débitos Trabalhistas" ], "summary": "Endpoint para realizar a consulta TST - Certidão Negativa de Débitos Trabalhistas.", "description": "Informe apenas um único documento por requisição.", "parameters": [ { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "CNPJ", "in": "query", "description": "O parâmetro CNPJ pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "GERARCOMPROVANTE", "in": "query", "description": "Este parâmetro possibilita gerar o comprovante em PDF desta consulta.", "schema": { "$ref": "#/components/schemas/OpcaoGerarComprovante" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TSTCertidaoNegativaDebitosTrabalhistasRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/UKHmTreasury": { "get": { "tags": [ "UK Hm Treasury - Financial Sanctions" ], "summary": "Endpoint para realizar a consulta UK Hm Treasury - Financial Sanctions. Obs: esta consulta não possui comprovante.", "description": "", "parameters": [ { "name": "NOME", "in": "query", "description": "O parâmetro NOME pode ser enviado com qualquer outro.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UKSancoesRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/UnitedNationsSecurityList": { "get": { "tags": [ "UNSCCL - United Nations Security Council Consolidated List" ], "summary": "Endpoint para realizar a consulta UNSCCL - United Nations Security Council Consolidated List. Obs: esta consulta não possui comprovante.", "description": "", "parameters": [ { "name": "NOME", "in": "query", "description": "O parâmetro NOME pode ser enviado em maiúsculo ou minúsculo.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnitedNationsSecurityListRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/ConsultaVeicularFipe": { "get": { "tags": [ "Veículos - FIPE" ], "summary": "Endpoint para realizar a consulta Veículos - FIPE. Obs: esta consulta não possui comprovante.", "description": "Informe apenas um único documento por requisição.\n\n🌐 Fornecedor Externo", "parameters": [ { "name": "PLACA", "in": "query", "description": "O parâmetro PLACA pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "CHASSI", "in": "query", "description": "O parâmetro CHASSI pode ser enviado com ou sem formatação.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultaVeicularFipeRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } }, "x-badges": [ { "name": "🌐 Fornecedor Externo", "color": "#1976d2" } ] } }, "/api/VerificacaoEmpregadorTrabalhoForcado": { "get": { "tags": [ "Verificação de Empregador - Trabalho Forçado" ], "summary": "Endpoint para realizar a consulta Verificação de Empregador - Trabalho Forçado. Obs: esta consulta não possui comprovante.", "description": "Informe apenas um único documento por requisição.", "parameters": [ { "name": "CNPJ", "in": "query", "description": "O parâmetro CNPJ pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerificacaoEmpregadorTrabalhoForcadoRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } }, "/api/VinculoEmpregaticio": { "get": { "tags": [ "Vínculo Empregatício" ], "summary": "Endpoint para realizar a consulta Vínculo Empregatício. Obs: esta consulta não possui comprovante.", "description": "🌐 Fornecedor Externo", "parameters": [ { "name": "CNPJ", "in": "query", "description": "O parâmetro CNPJ pode ser enviado com ou sem formatação.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VinculoEmpregaticioRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } }, "x-badges": [ { "name": "🌐 Fornecedor Externo", "color": "#1976d2" } ] } }, "/api/VinculosSocietarios": { "get": { "tags": [ "Vínculos Societários" ], "summary": "Endpoint para realizar a consulta Vínculos Societários. Obs: esta consulta não possui comprovante.", "description": "Informe apenas um único documento por requisição.", "parameters": [ { "name": "CNPJ", "in": "query", "description": "O parâmetro CNPJ pode ser enviado com ou sem formatação.", "schema": { "type": "string" } }, { "name": "CPF", "in": "query", "description": "O parâmetro CPF pode ser enviado com ou sem formatação.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso: retorna um JSON com os dados da consulta.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VinculosSocietariosRetorno" } } } }, "201": { "description": "Sucesso: a requisição async foi criada com sucesso e está em processamento." }, "202": { "description": "Em Processamento: a requisição async ainda está em processamento." }, "400": { "description": "Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos." }, "401": { "description": "Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso." }, "403": { "description": "Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível." }, "404": { "description": "Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado." }, "408": { "description": "Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido." }, "500": { "description": "Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte." }, "503": { "description": "Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte." } } } } }, "components": { "schemas": { "AML": { "type": "object", "properties": { "cpf": { "type": "string", "nullable": true }, "nome": { "type": "string", "nullable": true }, "dataNascimento": { "type": "string", "nullable": true }, "genero": { "type": "string", "nullable": true }, "obito": { "type": "boolean", "nullable": true }, "dataObito": { "type": "string", "nullable": true }, "pep": { "type": "boolean", "nullable": true }, "parentescos": { "type": "array", "items": { "$ref": "#/components/schemas/Parentesco" }, "nullable": true }, "sociedades": { "type": "array", "items": { "$ref": "#/components/schemas/Sociedade" }, "nullable": true } }, "additionalProperties": false }, "AMLRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/AML" } }, "additionalProperties": false }, "ANTTConsultaCodigoIdentificadorOperacaoTransporte": { "type": "object", "properties": { "rntrc": { "type": "string", "nullable": true }, "renavam": { "type": "string", "nullable": true }, "dataConsulta": { "type": "string", "nullable": true }, "totalCIOT": { "type": "string", "nullable": true }, "retornoCIOT": { "type": "array", "items": { "$ref": "#/components/schemas/RetornoCIOT" }, "nullable": true } }, "additionalProperties": false }, "ANTTConsultaCodigoIdentificadorOperacaoTransporteRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/ANTTConsultaCodigoIdentificadorOperacaoTransporte" } }, "additionalProperties": false }, "ANTTConsultaRegularidadeTransportadora": { "type": "object", "properties": { "transportador": { "type": "string", "nullable": true }, "documento": { "type": "string", "nullable": true }, "rntrc": { "type": "integer", "format": "int64", "nullable": true }, "dataEmissao": { "type": "string", "nullable": true }, "dataConsulta": { "type": "string", "nullable": true }, "localizacao": { "$ref": "#/components/schemas/Localizacao" }, "categoria": { "type": "string", "nullable": true }, "situacao": { "type": "string", "nullable": true }, "apto": { "type": "boolean", "nullable": true }, "status": { "type": "string", "nullable": true }, "observacao": { "type": "string", "nullable": true }, "protocolo": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ANTTConsultaRegularidadeTransportadoraRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/ANTTConsultaRegularidadeTransportadora" } }, "additionalProperties": false }, "APFAutorizacoes": { "type": "object", "properties": { "imovel": { "type": "string", "nullable": true }, "proprietario": { "$ref": "#/components/schemas/APFProprietario" }, "responsavel": { "$ref": "#/components/schemas/APFProprietario" }, "car": { "type": "string", "nullable": true }, "situacaoCAR": { "type": "string", "nullable": true }, "apf": { "type": "string", "nullable": true }, "dataEmissao": { "type": "string", "nullable": true }, "dataValidade": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "municipio": { "type": "string", "nullable": true }, "atividade": { "type": "string", "nullable": true }, "informacoesAdicionais": { "$ref": "#/components/schemas/APFImovel" } }, "additionalProperties": false }, "APFImovel": { "type": "object", "properties": { "coordenadas": { "type": "string", "nullable": true }, "areaTotal": { "type": "string", "nullable": true }, "areaUtilizada": { "type": "string", "nullable": true } }, "additionalProperties": false }, "APFProprietario": { "type": "object", "properties": { "nome": { "type": "string", "nullable": true }, "documento": { "type": "string", "nullable": true } }, "additionalProperties": false }, "APFRural": { "type": "object", "properties": { "documentoConsultado": { "type": "string", "nullable": true }, "dataConsulta": { "type": "string", "nullable": true }, "quantidadeAutorizacoes": { "type": "integer", "format": "int32", "nullable": true }, "observacoes": { "type": "string", "nullable": true }, "autorizacoes": { "type": "array", "items": { "$ref": "#/components/schemas/APFAutorizacoes" }, "nullable": true } }, "additionalProperties": false }, "APFRuralRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/APFRural" } }, "additionalProperties": false }, "AcaoCivelDetalhe": { "type": "object", "properties": { "requerido": { "type": "string", "nullable": true }, "valor": { "type": "string", "nullable": true }, "acao": { "type": "string", "nullable": true }, "documento": { "type": "string", "nullable": true }, "foro": { "type": "string", "nullable": true }, "origem": { "type": "string", "nullable": true }, "vara": { "type": "string", "nullable": true }, "comarca": { "type": "string", "nullable": true }, "autor": { "type": "string", "nullable": true }, "processo": { "type": "string", "nullable": true }, "dataDistribuicao": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AcaoCivelDetalheDefineLimitePositivoPJ": { "type": "object", "properties": { "requerido": { "type": "string", "nullable": true }, "valor": { "type": "string", "nullable": true }, "acao": { "type": "string", "nullable": true }, "documento": { "type": "string", "nullable": true }, "foro": { "type": "string", "nullable": true }, "origem": { "type": "string", "nullable": true }, "vara": { "type": "string", "nullable": true }, "comarca": { "type": "string", "nullable": true }, "autor": { "type": "string", "nullable": true }, "processo": { "type": "string", "nullable": true }, "dataDistribuicao": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AcaoCivelOcorrenciaAcertaCompletoPF": { "type": "object", "properties": { "requerido": { "type": "string", "nullable": true }, "valor": { "type": "string", "nullable": true }, "acao": { "type": "string", "nullable": true }, "documento": { "type": "string", "nullable": true }, "foro": { "type": "string", "nullable": true }, "origem": { "type": "string", "nullable": true }, "vara": { "type": "string", "nullable": true }, "comarca": { "type": "string", "nullable": true }, "autor": { "type": "string", "nullable": true }, "processo": { "type": "string", "nullable": true }, "dataDistribuicao": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AcaoCivelOcorrenciaPF": { "type": "object", "properties": { "requerido": { "type": "string", "nullable": true }, "valor": { "type": "string", "nullable": true }, "acao": { "type": "string", "nullable": true }, "documento": { "type": "string", "nullable": true }, "foro": { "type": "string", "nullable": true }, "origem": { "type": "string", "nullable": true }, "vara": { "type": "string", "nullable": true }, "comarca": { "type": "string", "nullable": true }, "autor": { "type": "string", "nullable": true }, "processo": { "type": "string", "nullable": true }, "dataDistribuicao": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AcaoJudicial": { "type": "object", "properties": { "numeroProcessoPrincipal": { "type": "string", "nullable": true }, "numeroProcessoAntigo": { "type": "string", "nullable": true }, "comarca": { "type": "string", "nullable": true }, "forum": { "type": "string", "nullable": true }, "vara": { "type": "string", "nullable": true }, "parteAcusada": { "type": "string", "nullable": true }, "dataAjuizamento": { "type": "string", "nullable": true }, "tipoProcesso": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "valor": { "type": "number", "format": "double", "nullable": true }, "autorProcesso": { "type": "string", "nullable": true }, "cidade": { "type": "string", "nullable": true }, "tipoTribunal": { "type": "string", "nullable": true }, "documento": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AcaoJudicialDCC": { "type": "object", "properties": { "numeroProcessoPrincipal": { "type": "string", "nullable": true }, "numeroProcessoAntigo": { "type": "string", "nullable": true }, "comarca": { "type": "string", "nullable": true }, "forum": { "type": "string", "nullable": true }, "vara": { "type": "string", "nullable": true }, "parteAcusada": { "type": "string", "nullable": true }, "dataAjuizamento": { "type": "string", "nullable": true }, "tipoProcesso": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "valor": { "type": "number", "format": "double", "nullable": true }, "autorProcesso": { "type": "string", "nullable": true }, "cidade": { "type": "string", "nullable": true }, "tipoTribunal": { "type": "string", "nullable": true }, "documento": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AcoesCiveisAcertaCompletoPF": { "type": "object", "properties": { "quantidadeOcorrencia": { "type": "string", "nullable": true }, "valorTotal": { "type": "string", "nullable": true }, "valorPrimeiro": { "type": "string", "nullable": true }, "valorUltimo": { "type": "string", "nullable": true }, "dataPrimeiro": { "type": "string", "nullable": true }, "dataUltimo": { "type": "string", "nullable": true }, "valorMaior": { "type": "string", "nullable": true }, "valorMenor": { "type": "string", "nullable": true }, "dataMaior": { "type": "string", "nullable": true }, "dataMenor": { "type": "string", "nullable": true }, "ocorrencias": { "type": "array", "items": { "$ref": "#/components/schemas/AcaoCivelOcorrenciaAcertaCompletoPF" }, "nullable": true } }, "additionalProperties": false }, "AcoesCiveisPF": { "type": "object", "properties": { "quantidadeOcorrencia": { "type": "string", "nullable": true }, "valorTotal": { "type": "string", "nullable": true }, "valorPrimeiro": { "type": "string", "nullable": true }, "valorUltimo": { "type": "string", "nullable": true }, "dataPrimeiro": { "type": "string", "nullable": true }, "dataUltimo": { "type": "string", "nullable": true }, "valorMaior": { "type": "string", "nullable": true }, "valorMenor": { "type": "string", "nullable": true }, "dataMaior": { "type": "string", "nullable": true }, "dataMenor": { "type": "string", "nullable": true }, "ocorrencias": { "type": "array", "items": { "$ref": "#/components/schemas/AcaoCivelOcorrenciaPF" }, "nullable": true } }, "additionalProperties": false }, "AcoesCiveisResumo": { "type": "object", "properties": { "quantidade": { "type": "string", "nullable": true }, "valorTotal": { "type": "string", "nullable": true }, "valorPrimeiro": { "type": "string", "nullable": true }, "valorUltimo": { "type": "string", "nullable": true }, "valorMaior": { "type": "string", "nullable": true }, "valorMenor": { "type": "string", "nullable": true }, "dataPrimeira": { "type": "string", "nullable": true }, "dataUltimo": { "type": "string", "nullable": true }, "dataMaior": { "type": "string", "nullable": true }, "dataMenor": { "type": "string", "nullable": true }, "ocorrencias": { "type": "array", "items": { "$ref": "#/components/schemas/AcaoCivelDetalhe" }, "nullable": true } }, "additionalProperties": false }, "AcoesCiveisResumoDefineLimitePositivoPJ": { "type": "object", "properties": { "quantidade": { "type": "string", "nullable": true }, "valorTotal": { "type": "string", "nullable": true }, "valorPrimeiro": { "type": "string", "nullable": true }, "valorUltimo": { "type": "string", "nullable": true }, "valorMaior": { "type": "string", "nullable": true }, "valorMenor": { "type": "string", "nullable": true }, "dataPrimeira": { "type": "string", "nullable": true }, "dataUltimo": { "type": "string", "nullable": true }, "dataMaior": { "type": "string", "nullable": true }, "dataMenor": { "type": "string", "nullable": true }, "ocorrencias": { "type": "array", "items": { "$ref": "#/components/schemas/AcaoCivelDetalheDefineLimitePositivoPJ" }, "nullable": true } }, "additionalProperties": false }, "Acordo": { "type": "object", "properties": { "numeroRegistro": { "type": "integer", "format": "int32", "nullable": true }, "detalhamentoAcordo": { "$ref": "#/components/schemas/DetalhamentoAcordo" }, "sancoes": { "type": "array", "items": { "$ref": "#/components/schemas/SancaoAcordo" }, "nullable": true }, "quantidadeSancoes": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "AcordosLeniencia": { "type": "object", "properties": { "documentoConsultado": { "type": "string", "nullable": true }, "razaoSocial": { "type": "string", "nullable": true }, "observacoes": { "type": "string", "nullable": true }, "constamAcordos": { "type": "boolean", "nullable": true }, "acordos": { "type": "array", "items": { "$ref": "#/components/schemas/Acordo" }, "nullable": true }, "quantidadeAcordos": { "type": "integer", "format": "int32", "nullable": true }, "totalSancoes": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "AcordosLenienciaRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/AcordosLeniencia" } }, "additionalProperties": false }, "Address": { "type": "object", "properties": { "street": { "type": "string", "nullable": true }, "number": { "type": "string", "nullable": true }, "complement": { "type": "string", "nullable": true }, "neighborhood": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "postalCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AddressEntity": { "type": "object", "properties": { "address": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "distance": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "Administrador": { "type": "object", "properties": { "nome": { "type": "string", "nullable": true }, "documento": { "type": "string", "nullable": true }, "cargo": { "type": "string", "nullable": true }, "dataEntrada": { "type": "string", "nullable": true }, "situacaoDocumento": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AdministradorDefineLimitePositivoPJ": { "type": "object", "properties": { "nome": { "type": "string", "nullable": true }, "documento": { "type": "string", "nullable": true }, "cargo": { "type": "string", "nullable": true }, "dataEntrada": { "type": "string", "nullable": true }, "situacaoDocumento": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Advogado": { "type": "object", "properties": { "nome": { "type": "string", "nullable": true }, "nomeSocial": { "type": "string", "nullable": true }, "inscricao": { "type": "string", "nullable": true }, "tipoInscricao": { "type": "string", "nullable": true }, "uf": { "type": "string", "nullable": true }, "situacao": { "type": "string", "nullable": true }, "organizacao": { "type": "string", "nullable": true }, "telefone": { "type": "string", "nullable": true }, "endereco": { "$ref": "#/components/schemas/EnderecoProfissional" }, "foto": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Advogados": { "type": "object", "properties": { "nomeCompleto": { "type": "string", "nullable": true }, "documento": { "type": "string", "nullable": true }, "oab": { "$ref": "#/components/schemas/OAB" } }, "additionalProperties": false }, "AlertaInfo": { "type": "object", "properties": { "titulo": { "type": "string", "nullable": true }, "observacao": { "type": "string", "nullable": true }, "tipo": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AlertaInfoDefineLimitePositivoPJ": { "type": "object", "properties": { "titulo": { "type": "string", "nullable": true }, "observacao": { "type": "string", "nullable": true }, "tipo": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AnbimaCertificadoEDU": { "type": "object", "properties": { "cpf": { "type": "string", "nullable": true }, "nomeEntidade": { "type": "string", "nullable": true }, "possuiCertificacoes": { "type": "boolean" }, "observacoes": { "type": "string", "nullable": true }, "certificacoes": { "type": "array", "items": { "$ref": "#/components/schemas/Certificacoes" }, "nullable": true } }, "additionalProperties": false }, "AnbimaCertificadoEDURetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/AnbimaCertificadoEDU" } }, "additionalProperties": false }, "Andamentos": { "type": "object", "properties": { "data": { "type": "string", "nullable": true }, "ocorrencia": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AntifraudePix": { "type": "object", "properties": { "chavePix": { "type": "string", "nullable": true }, "documento": { "type": "string", "nullable": true }, "nomeEntidade": { "type": "string", "nullable": true }, "tipo": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "probabilidadeTitularidade": { "type": "string", "nullable": true }, "riscoFraude": { "type": "string", "nullable": true }, "riscoLaranja": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AntifraudePixRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/AntifraudePix" } }, "additionalProperties": false }, "Apenso": { "type": "object", "properties": { "numero": { "type": "string", "nullable": true }, "classe": { "type": "string", "nullable": true }, "dataApensamento": { "type": "string", "nullable": true }, "motivo": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AreaPreservacaoPermanente": { "type": "object", "properties": { "area": { "type": "string", "nullable": true }, "recompor": { "type": "string", "nullable": true }, "ruralConsolidada": { "type": "string", "nullable": true }, "remanescenteVegetacaoNativa": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AssuntoProcesso": { "type": "object", "properties": { "codigoAssunto": { "type": "string", "nullable": true }, "assunto": { "type": "string", "nullable": true }, "assuntoPrincipal": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "Atividades": { "type": "object", "properties": { "listaAtividades": { "type": "array", "items": { "type": "string" }, "nullable": true }, "observacaoAtividade": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Audiencia1Grau": { "type": "object", "properties": { "data": { "type": "string", "nullable": true }, "audiencia": { "type": "string", "nullable": true }, "situacao": { "type": "string", "nullable": true }, "quantidadePessoas": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "AustraliaDFAT": { "type": "object", "properties": { "nomeConsultado": { "type": "string", "nullable": true }, "resultadosEncontrados": { "type": "integer", "format": "int32" }, "observacoes": { "type": "string", "nullable": true }, "dataLista": { "type": "string", "nullable": true }, "sancoes": { "type": "array", "items": { "$ref": "#/components/schemas/AustraliaDFATSancoes" }, "nullable": true } }, "additionalProperties": false }, "AustraliaDFATApelidos": { "type": "object", "properties": { "tipo": { "type": "string", "nullable": true }, "qualidade": { "type": "string", "nullable": true }, "nome": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AustraliaDFATAtributos": { "type": "object", "properties": { "chave": { "type": "string", "nullable": true }, "valor": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AustraliaDFATEnderecos": { "type": "object", "properties": { "endereco": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AustraliaDFATIdentificacoes": { "type": "object", "properties": { "tipo": { "type": "string", "nullable": true }, "documento": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AustraliaDFATRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/AustraliaDFAT" } }, "additionalProperties": false }, "AustraliaDFATSancoes": { "type": "object", "properties": { "nome": { "type": "string", "nullable": true }, "tipoRegistro": { "type": "string", "nullable": true }, "dataNascimento": { "type": "string", "nullable": true }, "localNascimento": { "type": "string", "nullable": true }, "nacionalidade": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "dataInclusaoLista": { "type": "string", "nullable": true }, "programas": { "type": "string", "nullable": true }, "apelidos": { "type": "array", "items": { "$ref": "#/components/schemas/AustraliaDFATApelidos" }, "nullable": true }, "identificacoes": { "type": "array", "items": { "$ref": "#/components/schemas/AustraliaDFATIdentificacoes" }, "nullable": true }, "enderecos": { "type": "array", "items": { "$ref": "#/components/schemas/AustraliaDFATEnderecos" }, "nullable": true }, "atributos": { "type": "array", "items": { "$ref": "#/components/schemas/AustraliaDFATAtributos" }, "nullable": true } }, "additionalProperties": false }, "AutoInfracao": { "type": "object", "properties": { "numero": { "type": "string", "nullable": true }, "serie": { "type": "string", "nullable": true }, "tipoInfracao": { "type": "string", "nullable": true }, "dataInfracao": { "type": "string", "nullable": true }, "numeroProcesso": { "type": "string", "nullable": true }, "bioma": { "type": "string", "nullable": true }, "estado": { "type": "string", "nullable": true }, "municipio": { "type": "string", "nullable": true }, "valorMulta": { "type": "string", "nullable": true }, "statusDebito": { "type": "string", "nullable": true }, "sancoesAplicadas": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AuxilioEmergencial": { "type": "object", "properties": { "nome": { "type": "string", "nullable": true }, "nis": { "type": "string", "nullable": true }, "cpf": { "type": "string", "nullable": true }, "beneficios": { "type": "array", "items": { "$ref": "#/components/schemas/Auxilios" }, "nullable": true } }, "additionalProperties": false }, "AuxilioEmergencialRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/AuxilioEmergencial" } }, "additionalProperties": false }, "AuxilioRec": { "type": "object", "properties": { "data": { "type": "string", "nullable": true }, "valor": { "type": "string", "nullable": true }, "municipio": { "type": "string", "nullable": true }, "uf": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AuxilioReconstrucao": { "type": "object", "properties": { "nome": { "type": "string", "nullable": true }, "nis": { "type": "string", "nullable": true }, "cpf": { "type": "string", "nullable": true }, "quantidadePessoasFamilia": { "type": "integer", "format": "int32", "nullable": true }, "beneficios": { "type": "array", "items": { "$ref": "#/components/schemas/AuxilioRec" }, "nullable": true } }, "additionalProperties": false }, "AuxilioReconstrucaoRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/AuxilioReconstrucao" } }, "additionalProperties": false }, "AuxilioSD": { "type": "object", "properties": { "data": { "type": "string", "nullable": true }, "valor": { "type": "string", "nullable": true }, "municipio": { "type": "string", "nullable": true }, "uf": { "type": "string", "nullable": true }, "numeroParcela": { "type": "integer", "format": "int32", "nullable": true }, "portaria": { "type": "string", "nullable": true }, "situacao": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Auxilios": { "type": "object", "properties": { "numeroRegistro": { "type": "integer", "format": "int64", "nullable": true }, "data": { "type": "string", "nullable": true }, "situacao": { "type": "string", "nullable": true }, "enquadramento": { "type": "string", "nullable": true }, "valor": { "type": "string", "nullable": true }, "numeroParcela": { "type": "integer", "format": "int32", "nullable": true }, "municipio": { "type": "string", "nullable": true }, "uf": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BancoCentralInabilitados": { "type": "object", "properties": { "nome": { "type": "string", "nullable": true }, "cpf": { "type": "string", "nullable": true }, "observacoes": { "type": "string", "nullable": true }, "constamPenalidades": { "type": "boolean", "nullable": true }, "penalidades": { "type": "array", "items": { "$ref": "#/components/schemas/Penalidade" }, "nullable": true } }, "additionalProperties": false }, "BancoCentralInabilitadosRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/BancoCentralInabilitados" } }, "additionalProperties": false }, "BancoCentralProibidos": { "type": "object", "properties": { "nomeEntidade": { "type": "string", "nullable": true }, "documento": { "type": "string", "nullable": true }, "observacoes": { "type": "string", "nullable": true }, "constamPenalidades": { "type": "boolean", "nullable": true }, "penalidades": { "type": "array", "items": { "$ref": "#/components/schemas/Penalidade" }, "nullable": true } }, "additionalProperties": false }, "BancoCentralProibidosRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/BancoCentralProibidos" } }, "additionalProperties": false }, "BeneficiarioFinal": { "type": "object", "properties": { "documentoConsultado": { "type": "string", "nullable": true }, "nomeRazaoSocial": { "type": "string", "nullable": true }, "dataCadastro": { "type": "string", "nullable": true }, "dataUpdate": { "type": "string", "nullable": true }, "pepMatriz": { "type": "boolean", "nullable": true }, "sociedades": { "type": "array", "items": { "$ref": "#/components/schemas/BeneficiarioSociedade" }, "nullable": true } }, "additionalProperties": false }, "BeneficiarioFinalRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/BeneficiarioFinal" } }, "additionalProperties": false }, "BeneficiarioHistoricoSociedade": { "type": "object", "properties": { "dataInicio": { "type": "string", "nullable": true }, "dataFim": { "type": "string", "nullable": true }, "status": { "type": "boolean", "nullable": true }, "cargo": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BeneficiarioSociedade": { "type": "object", "properties": { "documento": { "type": "string", "nullable": true }, "nomeRazaoSocial": { "type": "string", "nullable": true }, "pepMatriz": { "type": "boolean", "nullable": true }, "status": { "type": "boolean", "nullable": true }, "nivel": { "type": "integer", "format": "int32", "nullable": true }, "socios": { "type": "array", "items": { "$ref": "#/components/schemas/BeneficiarioSociedade" }, "nullable": true }, "historicoSociedades": { "type": "array", "items": { "$ref": "#/components/schemas/BeneficiarioHistoricoSociedade" }, "nullable": true } }, "additionalProperties": false }, "Beneficio": { "type": "object", "properties": { "numeroRegistro": { "type": "integer", "format": "int64", "nullable": true }, "dataMesCompetencia": { "type": "string", "nullable": true }, "dataMesReferencia": { "type": "string", "nullable": true }, "valor": { "type": "string", "nullable": true }, "municipio": { "type": "string", "nullable": true }, "uf": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BeneficioPrestacaoContinuada": { "type": "object", "properties": { "nis": { "type": "string", "nullable": true }, "cpf": { "type": "string", "nullable": true }, "nome": { "type": "string", "nullable": true }, "beneficioConcedidoJudicialmente": { "type": "boolean", "nullable": true }, "beneficios": { "type": "array", "items": { "$ref": "#/components/schemas/Beneficio" }, "nullable": true } }, "additionalProperties": false }, "BeneficioPrestacaoContinuadaRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/BeneficioPrestacaoContinuada" } }, "additionalProperties": false }, "Beneficios": { "type": "object", "properties": { "nis": { "type": "string", "nullable": true }, "auxilioEmergencial": { "type": "boolean", "nullable": true }, "auxilioReconstrucao": { "type": "boolean", "nullable": true }, "bolsaFamilia": { "type": "boolean", "nullable": true }, "bpc": { "type": "boolean", "nullable": true }, "garantiaSafra": { "type": "boolean", "nullable": true }, "seguroDefeso": { "type": "boolean", "nullable": true }, "gasDoPovo": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "BeneficiosSociais": { "type": "object", "properties": { "nome": { "type": "string", "nullable": true }, "nis": { "type": "string", "nullable": true }, "cpf": { "type": "string", "nullable": true }, "dataNascimento": { "type": "string", "nullable": true }, "nomeMae": { "type": "string", "nullable": true }, "obito": { "type": "boolean", "nullable": true }, "auxilioEmergencial": { "type": "boolean", "nullable": true }, "auxilioReconstrucao": { "type": "boolean", "nullable": true }, "bolsaFamilia": { "type": "boolean", "nullable": true }, "bpc": { "type": "boolean", "nullable": true }, "garantiaSafra": { "type": "boolean", "nullable": true }, "seguroDefeso": { "type": "boolean", "nullable": true }, "gasDoPovo": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "BeneficiosSociaisRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/BeneficiosSociais" } }, "additionalProperties": false }, "BetSafeCompliance": { "type": "object", "properties": { "cpf": { "type": "string", "nullable": true }, "nome": { "type": "string", "nullable": true }, "genero": { "type": "string", "nullable": true }, "dataNascimento": { "type": "string", "nullable": true }, "idade": { "type": "integer", "format": "int32", "nullable": true }, "codigoCBO": { "type": "string", "nullable": true }, "cbo": { "type": "string", "nullable": true }, "relacionadoEsporte": { "type": "boolean", "nullable": true }, "obito": { "type": "boolean", "nullable": true }, "pep": { "type": "boolean", "nullable": true }, "personalidadePublica": { "type": "boolean", "nullable": true }, "beneficios": { "$ref": "#/components/schemas/Beneficios" }, "parentescos": { "type": "array", "items": { "$ref": "#/components/schemas/ParentescosBET" }, "nullable": true } }, "additionalProperties": false }, "BetSafeComplianceRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/BetSafeCompliance" } }, "additionalProperties": false }, "BoaVistaAcertaCompletoPositivoPessoaFisica": { "type": "object", "properties": { "cpf": { "type": "string", "nullable": true }, "cpfSituacao": { "type": "string", "nullable": true }, "cpfOrigem": { "type": "string", "nullable": true }, "cpfDataAtualizacaoReceita": { "type": "string", "nullable": true }, "rg": { "type": "string", "nullable": true }, "rguf": { "type": "string", "nullable": true }, "rgDataEmissao": { "type": "string", "nullable": true }, "nome": { "type": "string", "nullable": true }, "nomeSocial": { "type": "string", "nullable": true }, "nomePai": { "type": "string", "nullable": true }, "mae": { "type": "string", "nullable": true }, "nascimento": { "type": "string", "nullable": true }, "sexo": { "type": "string", "nullable": true }, "nacionalidade": { "type": "string", "nullable": true }, "naturalidade": { "type": "string", "nullable": true }, "grauInstrucao": { "type": "string", "nullable": true }, "estadoCivil": { "type": "string", "nullable": true }, "numeroDependentes": { "type": "string", "nullable": true }, "indicacaoObito": { "type": "string", "nullable": true }, "tituloEleitor": { "type": "string", "nullable": true }, "numeroPIS": { "type": "string", "nullable": true }, "cartaoNacionalSaude": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "faixaRenda": { "type": "string", "nullable": true }, "classeSocial": { "type": "string", "nullable": true }, "poderAquisitivo": { "type": "string", "nullable": true }, "ultimoImpostoRenda": { "type": "string", "nullable": true }, "qtdDependentesBolsaFamilia": { "type": "string", "nullable": true }, "telefones": { "type": "array", "items": { "$ref": "#/components/schemas/TelefoneBase" }, "nullable": true }, "enderecos": { "type": "array", "items": { "$ref": "#/components/schemas/Endereco" }, "nullable": true }, "restricoes": { "$ref": "#/components/schemas/RestricoesAcertaCompletoPF" }, "participacaoEmEmpresas": { "$ref": "#/components/schemas/ParticipacaoEmpresasAcertaCompletoPF" }, "pendenciasFinanceiras": { "$ref": "#/components/schemas/PendenciasFinanceirasAcertaCompletoPF" }, "protestos": { "$ref": "#/components/schemas/ProtestosAcertaCompletoPF" }, "chequeSemFundoVarejo": { "$ref": "#/components/schemas/ChequesSemFundosAcertaCompletoPF" }, "chequeSemFundoBacen": { "$ref": "#/components/schemas/ChequesSemFundosAcertaCompletoPF" }, "falenciasAcoesRecuperacoes": { "$ref": "#/components/schemas/FalenciasAcoesRecuperacoesAcertaCompletoPF" }, "scores": { "$ref": "#/components/schemas/ScoresAcertaCompletoPF" }, "passagensComerciais": { "$ref": "#/components/schemas/PassagensComerciaisAcertaCompletoPF" }, "acoesCiveis": { "$ref": "#/components/schemas/AcoesCiveisAcertaCompletoPF" }, "decisao": { "$ref": "#/components/schemas/DecisaoAcertaCompletoPF" }, "rendaPresumida": { "$ref": "#/components/schemas/RendaPresumidaAcertaCompletoPF" }, "controlePositivo": { "$ref": "#/components/schemas/ControlePositivoAcertaCompletoPF" } }, "additionalProperties": false }, "BoaVistaAcertaCompletoPositivoPessoaFisicaRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/BoaVistaAcertaCompletoPositivoPessoaFisica" } }, "additionalProperties": false }, "BoaVistaAcertaMaisPositivoPessoaFisica": { "type": "object", "properties": { "cpf": { "type": "string", "nullable": true }, "cpfSituacao": { "type": "string", "nullable": true }, "cpfOrigem": { "type": "string", "nullable": true }, "cpfDataAtualizacaoReceita": { "type": "string", "nullable": true }, "rg": { "type": "string", "nullable": true }, "rguf": { "type": "string", "nullable": true }, "rgDataEmissao": { "type": "string", "nullable": true }, "nome": { "type": "string", "nullable": true }, "nomeSocial": { "type": "string", "nullable": true }, "nomePai": { "type": "string", "nullable": true }, "mae": { "type": "string", "nullable": true }, "nascimento": { "type": "string", "nullable": true }, "sexo": { "type": "string", "nullable": true }, "nacionalidade": { "type": "string", "nullable": true }, "naturalidade": { "type": "string", "nullable": true }, "grauInstrucao": { "type": "string", "nullable": true }, "estadoCivil": { "type": "string", "nullable": true }, "numeroDependentes": { "type": "string", "nullable": true }, "indicacaoObito": { "type": "string", "nullable": true }, "tituloEleitor": { "type": "string", "nullable": true }, "numeroPIS": { "type": "string", "nullable": true }, "cartaoNacionalSaude": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "faixaRenda": { "type": "string", "nullable": true }, "classeSocial": { "type": "string", "nullable": true }, "poderAquisitivo": { "type": "string", "nullable": true }, "ultimoImpostoRenda": { "type": "string", "nullable": true }, "qtdDependentesBolsaFamilia": { "type": "string", "nullable": true }, "telefones": { "type": "array", "items": { "$ref": "#/components/schemas/TelefoneBase" }, "nullable": true }, "enderecos": { "type": "array", "items": { "$ref": "#/components/schemas/Endereco" }, "nullable": true }, "restricoes": { "$ref": "#/components/schemas/InformacoesAlertasRestricoesPF" }, "participacaoEmEmpresas": { "$ref": "#/components/schemas/ParticipacaoEmEmpresasPF" }, "pendenciasFinanceiras": { "$ref": "#/components/schemas/PendenciasFinanceirasPF" }, "protestos": { "$ref": "#/components/schemas/ProtestosPF" }, "chequeSemFundoVarejo": { "$ref": "#/components/schemas/ChequesSemFundosPF" }, "chequeSemFundoBacen": { "$ref": "#/components/schemas/ChequesSemFundosPF" }, "falenciasAcoesRecuperacoes": { "$ref": "#/components/schemas/FalenciasAcoesRecuperacoesPF" }, "scores": { "$ref": "#/components/schemas/ScoresPF" }, "passagensComerciais": { "$ref": "#/components/schemas/PassagensComerciaisPF" }, "acoesCiveis": { "$ref": "#/components/schemas/AcoesCiveisPF" }, "decisao": { "$ref": "#/components/schemas/DecisaoPF" }, "rendaPresumida": { "$ref": "#/components/schemas/RendaPresumidaPF" }, "controlePositivo": { "$ref": "#/components/schemas/ControlePositivoPF" } }, "additionalProperties": false }, "BoaVistaAcertaMaisPositivoPessoaFisicaRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/BoaVistaAcertaMaisPositivoPessoaFisica" } }, "additionalProperties": false }, "BoaVistaDefineLimitePositivoPessoaJuridica": { "type": "object", "properties": { "cnpj": { "type": "string", "nullable": true }, "razaoSocial": { "type": "string", "nullable": true }, "razaoSocialAnterior": { "type": "string", "nullable": true }, "nomeFantasia": { "type": "string", "nullable": true }, "situacao": { "type": "string", "nullable": true }, "situacaoSintegra": { "type": "string", "nullable": true }, "dataSituacao": { "type": "string", "nullable": true }, "dataConsulta": { "type": "string", "nullable": true }, "dataFundacao": { "type": "string", "nullable": true }, "dataEncerramento": { "type": "string", "nullable": true }, "dataSituacaoSintegra": { "type": "string", "nullable": true }, "dataConsultaSintegra": { "type": "string", "nullable": true }, "inscricaoEstadual": { "type": "string", "nullable": true }, "inscricaoEstadualUf": { "type": "string", "nullable": true }, "naturezaJuridica": { "type": "string", "nullable": true }, "faixaFuncionarios": { "type": "string", "nullable": true }, "quantidadeFiliais": { "type": "string", "nullable": true }, "cidadesFiliais": { "type": "string", "nullable": true }, "nire": { "type": "string", "nullable": true }, "nireUf": { "type": "string", "nullable": true }, "ramoAtividadePrimario": { "type": "string", "nullable": true }, "ramoAtividadeSecundario": { "type": "string", "nullable": true }, "cnaePrimario": { "type": "string", "nullable": true }, "cnaeSecundario": { "type": "string", "nullable": true }, "capitalSocial": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "tipoSociedade": { "type": "string", "nullable": true }, "opcaoTributaria": { "type": "string", "nullable": true }, "porte": { "type": "string", "nullable": true }, "telefones": { "type": "array", "items": { "$ref": "#/components/schemas/TelefoneBase" }, "nullable": true }, "enderecos": { "type": "array", "items": { "$ref": "#/components/schemas/Endereco" }, "nullable": true }, "decisoes": { "$ref": "#/components/schemas/DecisaoDefineLimitePositivoPJ" }, "score": { "$ref": "#/components/schemas/ScoreResumoDefineLimitePositivoPJ" }, "indicadores": { "$ref": "#/components/schemas/IndicadoresPositivosDefineLimitePositivoPJ" }, "restricoes": { "$ref": "#/components/schemas/RestricoesResumoDefineLimitePositivoPJ" }, "governancas": { "$ref": "#/components/schemas/GovernancaDefineLimitePositivoPJ" }, "alertas": { "type": "array", "items": { "$ref": "#/components/schemas/AlertaInfoDefineLimitePositivoPJ" }, "nullable": true }, "historicoConsulta": { "$ref": "#/components/schemas/HistoricoConsultasDefineLimitePositivoPJ" }, "participacoes": { "$ref": "#/components/schemas/ParticipacoesSocietariasDefineLimitePositivoPJ" } }, "additionalProperties": false }, "BoaVistaRiscoPositivoPessoaJuridica": { "type": "object", "properties": { "cnpj": { "type": "string", "nullable": true }, "razaoSocial": { "type": "string", "nullable": true }, "razaoSocialAnterior": { "type": "string", "nullable": true }, "nomeFantasia": { "type": "string", "nullable": true }, "situacao": { "type": "string", "nullable": true }, "situacaoSintegra": { "type": "string", "nullable": true }, "dataSituacao": { "type": "string", "nullable": true }, "dataConsulta": { "type": "string", "nullable": true }, "dataFundacao": { "type": "string", "nullable": true }, "dataEncerramento": { "type": "string", "nullable": true }, "dataSituacaoSintegra": { "type": "string", "nullable": true }, "dataConsultaSintegra": { "type": "string", "nullable": true }, "inscricaoEstadual": { "type": "string", "nullable": true }, "inscricaoEstadualUf": { "type": "string", "nullable": true }, "naturezaJuridica": { "type": "string", "nullable": true }, "faixaFuncionarios": { "type": "string", "nullable": true }, "quantidadeFiliais": { "type": "string", "nullable": true }, "cidadesFiliais": { "type": "string", "nullable": true }, "nire": { "type": "string", "nullable": true }, "nireUf": { "type": "string", "nullable": true }, "ramoAtividadePrimario": { "type": "string", "nullable": true }, "ramoAtividadeSecundario": { "type": "string", "nullable": true }, "cnaePrimario": { "type": "string", "nullable": true }, "cnaeSecundario": { "type": "string", "nullable": true }, "capitalSocial": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "tipoSociedade": { "type": "string", "nullable": true }, "opcaoTributaria": { "type": "string", "nullable": true }, "porte": { "type": "string", "nullable": true }, "telefones": { "type": "array", "items": { "$ref": "#/components/schemas/TelefoneBase" }, "nullable": true }, "enderecos": { "type": "array", "items": { "$ref": "#/components/schemas/Endereco" }, "nullable": true }, "decisoes": { "$ref": "#/components/schemas/Decisao" }, "score": { "$ref": "#/components/schemas/ScoreResumo" }, "indicadores": { "$ref": "#/components/schemas/IndicadoresPositivos" }, "restricoes": { "$ref": "#/components/schemas/RestricoesResumo" }, "governancas": { "$ref": "#/components/schemas/Governanca" }, "alertas": { "type": "array", "items": { "$ref": "#/components/schemas/AlertaInfo" }, "nullable": true }, "historicoConsulta": { "$ref": "#/components/schemas/HistoricoConsultas" } }, "additionalProperties": false }, "BolsaFamilia": { "type": "object", "properties": { "nis": { "type": "string", "nullable": true }, "cpf": { "type": "string", "nullable": true }, "nome": { "type": "string", "nullable": true }, "beneficios": { "type": "array", "items": { "$ref": "#/components/schemas/Beneficio" }, "nullable": true } }, "additionalProperties": false }, "BolsaFamiliaRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/BolsaFamilia" } }, "additionalProperties": false }, "CADINSecretariaFazendaEstaduais": { "type": "object", "properties": { "documentoConsultado": { "type": "string", "nullable": true }, "nome": { "type": "string", "nullable": true }, "uf": { "type": "string", "nullable": true }, "codigoDeclaracao": { "type": "string", "nullable": true }, "numeroCertidao": { "type": "string", "nullable": true }, "possuiPendencias": { "type": "boolean", "nullable": true }, "dataConsulta": { "type": "string", "nullable": true }, "dataValidade": { "type": "string", "nullable": true }, "totalPendencias": { "type": "integer", "format": "int32", "nullable": true }, "valorTotal": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "pendencias": { "type": "array", "items": { "$ref": "#/components/schemas/Pendencias" }, "nullable": true } }, "additionalProperties": false }, "CADINSecretariaFazendaEstaduaisRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/CADINSecretariaFazendaEstaduais" } }, "additionalProperties": false }, "CADINSecretariaFazendaSP": { "type": "object", "properties": { "documentoConsultado": { "type": "string", "nullable": true }, "nome": { "type": "string", "nullable": true }, "codigoDeclaracao": { "type": "string", "nullable": true }, "possuiPendencias": { "type": "boolean", "nullable": true }, "dataConsulta": { "type": "string", "nullable": true }, "totalPendencias": { "type": "integer", "format": "int32", "nullable": true }, "status": { "type": "string", "nullable": true }, "pendencias": { "type": "array", "items": { "$ref": "#/components/schemas/Pendencia" }, "nullable": true } }, "additionalProperties": false }, "CADINSecretariaFazendaSPRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/CADINSecretariaFazendaSP" } }, "additionalProperties": false }, "CAFCadastroNacionalAgriculturaPF": { "type": "object", "properties": { "cpf": { "type": "string", "nullable": true }, "numeroCaf": { "type": "string", "nullable": true }, "situacao": { "type": "string", "nullable": true }, "dataInscricao": { "type": "string", "nullable": true }, "ultimaAtualizacao": { "type": "string", "nullable": true }, "dataValidade": { "type": "string", "nullable": true }, "dataEmissao": { "type": "string", "nullable": true }, "enquadramentoPRONAF": { "type": "string", "nullable": true }, "atividadePrincipal": { "type": "string", "nullable": true }, "caracterizacaoUFPA": { "type": "string", "nullable": true }, "municipio": { "type": "string", "nullable": true }, "uf": { "type": "string", "nullable": true }, "numImoveisExplorados": { "type": "integer", "format": "int32", "nullable": true }, "condicaoPosseUso": { "type": "string", "nullable": true }, "tamanhoImovelPrincipal": { "type": "string", "nullable": true }, "totalEstabelecimentoHA": { "type": "number", "format": "double", "nullable": true }, "totalEstabelecimentoM2": { "type": "number", "format": "double", "nullable": true }, "entidadeResponsavel": { "type": "string", "nullable": true }, "cnpjEntidade": { "type": "string", "nullable": true }, "cadastrador": { "type": "string", "nullable": true }, "composicaoFamiliar": { "type": "array", "items": { "$ref": "#/components/schemas/CAFMembroFamiliar" }, "nullable": true }, "formasAssociativas": { "type": "array", "items": { "$ref": "#/components/schemas/CAFFormaAssociativa" }, "nullable": true } }, "additionalProperties": false }, "CAFCadastroNacionalAgriculturaPFRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/CAFCadastroNacionalAgriculturaPF" } }, "additionalProperties": false }, "CAFCadastroNacionalAgriculturaPJ": { "type": "object", "properties": { "cnpj": { "type": "string", "nullable": true }, "razaoSocial": { "type": "string", "nullable": true }, "numeroCaf": { "type": "string", "nullable": true }, "situacao": { "type": "string", "nullable": true }, "dataInscricao": { "type": "string", "nullable": true }, "ultimaAtualizacao": { "type": "string", "nullable": true }, "dataEmissao": { "type": "string", "nullable": true }, "dataValidade": { "type": "string", "nullable": true }, "dataUltimoExtrato": { "type": "string", "nullable": true }, "dataUltimoUploadAssociados": { "type": "string", "nullable": true }, "tipoPessoaJuridica": { "type": "string", "nullable": true }, "dataConstituicao": { "type": "string", "nullable": true }, "municipio": { "type": "string", "nullable": true }, "uf": { "type": "string", "nullable": true }, "representanteLegal": { "type": "string", "nullable": true }, "cpfRepresentante": { "type": "string", "nullable": true }, "entidadeResponsavel": { "type": "string", "nullable": true }, "cnpjEntidade": { "type": "string", "nullable": true }, "cadastrador": { "type": "string", "nullable": true }, "emissor": { "$ref": "#/components/schemas/CAFEmissor" }, "composicaoSocietaria": { "type": "array", "items": { "$ref": "#/components/schemas/ComposicaoSocietaria" }, "nullable": true }, "sociosPorMunicipio": { "type": "array", "items": { "$ref": "#/components/schemas/CAFMunicipio" }, "nullable": true } }, "additionalProperties": false }, "CAFCadastroNacionalAgriculturaPJRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/CAFCadastroNacionalAgriculturaPJ" } }, "additionalProperties": false }, "CAFEmissor": { "type": "object", "properties": { "nome": { "type": "string", "nullable": true }, "cpf": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CAFFormaAssociativa": { "type": "object", "properties": { "membro": { "type": "string", "nullable": true }, "razaoSocial": { "type": "string", "nullable": true }, "cnpj": { "type": "string", "nullable": true }, "responsavelLegal": { "type": "string", "nullable": true }, "entidadeEmissora": { "type": "string", "nullable": true }, "tecnicoEmissor": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CAFIRCadastroImoveisRurais": { "type": "object", "properties": { "cib": { "type": "string", "nullable": true }, "nomeImovel": { "type": "string", "nullable": true }, "area": { "type": "string", "nullable": true }, "localizacao": { "type": "string", "nullable": true }, "cep": { "type": "string", "nullable": true }, "municipio": { "type": "string", "nullable": true }, "uf": { "type": "string", "nullable": true }, "dataEmissao": { "type": "string", "nullable": true }, "situacao": { "type": "string", "nullable": true }, "cadeiaCIB": { "type": "string", "nullable": true }, "codigoINCRA": { "type": "string", "nullable": true }, "dataConsulta": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CAFIRCadastroImoveisRuraisRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/CAFIRCadastroImoveisRurais" } }, "additionalProperties": false }, "CAFMembroFamiliar": { "type": "object", "properties": { "nome": { "type": "string", "nullable": true }, "cpf": { "type": "string", "nullable": true }, "relacaoParentesco": { "type": "string", "nullable": true }, "maoDeObraFamiliar": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "CAFMunicipio": { "type": "object", "properties": { "municipio": { "type": "string", "nullable": true }, "uf": { "type": "string", "nullable": true }, "quantidade": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "CARCadastroAmbientalRural": { "type": "object", "properties": { "inscricaoCAR": { "type": "string", "nullable": true }, "situacaoCadastro": { "type": "string", "nullable": true }, "condicaoExterna": { "type": "string", "nullable": true }, "dataConsulta": { "type": "string", "nullable": true }, "dadosImovel": { "$ref": "#/components/schemas/DadosImovelRural" }, "coberturaSolo": { "$ref": "#/components/schemas/CoberturaSolo" }, "reservaLegal": { "$ref": "#/components/schemas/ReservaLegal" }, "app": { "$ref": "#/components/schemas/AreaPreservacaoPermanente" }, "usoRestrito": { "$ref": "#/components/schemas/UsoRestrito" }, "informacoesAdicionais": { "type": "array", "items": { "$ref": "#/components/schemas/InformacaoAdcional" }, "nullable": true } }, "additionalProperties": false }, "CARCadastroAmbientalRuralRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/CARCadastroAmbientalRural" } }, "additionalProperties": false }, "CARFConselhoAdministrativodeRecursosFiscais": { "type": "object", "properties": { "documentoConsultado": { "type": "string", "nullable": true }, "nomeEntidade": { "type": "string", "nullable": true }, "processos": { "type": "array", "items": { "$ref": "#/components/schemas/ProcessosCarf" }, "nullable": true }, "totalProcessos": { "type": "integer", "format": "int32", "nullable": true }, "observacoes": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CARFConselhoAdministrativodeRecursosFiscaisRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/CARFConselhoAdministrativodeRecursosFiscais" } }, "additionalProperties": false }, "CEPCorreios": { "type": "object", "properties": { "logradouro": { "type": "string", "nullable": true }, "complemento": { "type": "string", "nullable": true }, "bairro": { "type": "string", "nullable": true }, "cidade": { "type": "string", "nullable": true }, "uf": { "type": "string", "nullable": true }, "cep": { "type": "string", "nullable": true }, "tipoCEP": { "type": "string", "nullable": true }, "observacaoCEP": { "type": "string", "nullable": true }, "nomeUnidade": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CGUConsultoriaGeralUniao": { "type": "object", "properties": { "nome": { "type": "string", "nullable": true }, "documentoConsultado": { "type": "string", "nullable": true }, "dataEmissao": { "type": "string", "nullable": true }, "dataValidade": { "type": "string", "nullable": true }, "tipoConsultado": { "type": "string", "nullable": true }, "restricoesCGU": { "type": "array", "items": { "$ref": "#/components/schemas/RestricoesCGU" }, "nullable": true }, "codigoControle": { "type": "string", "nullable": true }, "constamCorrecionais": { "type": "boolean", "nullable": true }, "status": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CGUConsultoriaGeralUniaoRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/CGUConsultoriaGeralUniao" } }, "additionalProperties": false }, "CNAESecundario": { "type": "object", "properties": { "cnaeCodigoSecundario": { "type": "integer", "format": "int32", "nullable": true }, "cnaeDescricaoSecundario": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CNJMandadosPrisaoRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/MandadoPrisao" } }, "additionalProperties": false }, "CONFEA": { "type": "object", "properties": { "nome": { "type": "string", "nullable": true }, "registroNacional": { "type": "string", "nullable": true }, "dataRegistro": { "type": "string", "nullable": true }, "crea": { "type": "string", "nullable": true }, "situacao": { "type": "string", "nullable": true }, "vistos": { "type": "array", "items": { "type": "string" }, "nullable": true }, "titulosGraduacao": { "type": "array", "items": { "type": "string" }, "nullable": true }, "cursosPosGraduacao": { "type": "array", "items": { "type": "string" }, "nullable": true }, "atribuicoesGraduacao": { "type": "string", "nullable": true }, "atribuicoesPosGraduacao": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CONFEARetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/CONFEA" } }, "additionalProperties": false }, "CPFEntity": { "type": "object", "properties": { "cpf": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "distance": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "CURPEntity": { "type": "object", "properties": { "curp": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "distance": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "CVMAcusado": { "type": "object", "properties": { "nome": { "type": "string", "nullable": true }, "situacao": { "type": "string", "nullable": true }, "dataSituacao": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CVMComissaodeValoresMobiliarios": { "type": "object", "properties": { "documentoConsultado": { "type": "string", "nullable": true }, "nomeEntidade": { "type": "string", "nullable": true }, "endereco": { "type": "string", "nullable": true }, "bairro": { "type": "string", "nullable": true }, "cidade": { "type": "string", "nullable": true }, "uf": { "type": "string", "nullable": true }, "cep": { "type": "string", "nullable": true }, "telefone": { "type": "string", "nullable": true }, "dataRegistro": { "type": "string", "nullable": true }, "patrimonioLiquido": { "type": "string", "nullable": true }, "dataPatrimonioLiquido": { "type": "string", "nullable": true }, "situacao": { "type": "string", "nullable": true }, "dataSituacao": { "type": "string", "nullable": true }, "codigoCVM": { "type": "string", "nullable": true }, "categoriaRegistro": { "type": "string", "nullable": true }, "dataInicioNaCategoria": { "type": "string", "nullable": true }, "companhiaDeMenorPorte": { "type": "string", "nullable": true }, "website": { "type": "string", "nullable": true }, "categoria": { "type": "string", "nullable": true }, "tiposParticipante": { "type": "array", "items": { "type": "string" }, "nullable": true }, "diretores": { "type": "array", "items": { "$ref": "#/components/schemas/CVMDiretor" }, "nullable": true } }, "additionalProperties": false }, "CVMComissaodeValoresMobiliariosRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/CVMComissaodeValoresMobiliarios" } }, "additionalProperties": false }, "CVMDiretor": { "type": "object", "properties": { "nome": { "type": "string", "nullable": true }, "dataInicio": { "type": "string", "nullable": true }, "instrucao": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CVMMovimentacao": { "type": "object", "properties": { "dataMovimentacao": { "type": "string", "nullable": true }, "subfase": { "type": "string", "nullable": true }, "local": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CVMProcessoAdministrativo": { "type": "object", "properties": { "numeroProcesso": { "type": "string", "nullable": true }, "processoEncerrado": { "type": "boolean", "nullable": true }, "assuntoObjeto": { "type": "string", "nullable": true }, "ementa": { "type": "string", "nullable": true }, "dataAbertura": { "type": "string", "nullable": true }, "dataRelatorioInquerito": { "type": "string", "nullable": true }, "encarregadoInstrucao": { "type": "string", "nullable": true }, "faseAtual": { "type": "string", "nullable": true }, "subfaseAtual": { "type": "string", "nullable": true }, "dataUltimaMudancaFase": { "type": "string", "nullable": true }, "localAtual": { "type": "string", "nullable": true }, "dataUltimaMovimentacaoLocal": { "type": "string", "nullable": true }, "totalAcusados": { "type": "integer", "format": "int32", "nullable": true }, "movimentacoes": { "type": "array", "items": { "$ref": "#/components/schemas/CVMMovimentacao" }, "nullable": true }, "acusados": { "type": "array", "items": { "$ref": "#/components/schemas/CVMAcusado" }, "nullable": true } }, "additionalProperties": false }, "CVMProcessosAdministrativosSancionadores": { "type": "object", "properties": { "documentoConsultado": { "type": "string", "nullable": true }, "nomeEntidade": { "type": "string", "nullable": true }, "processos": { "type": "array", "items": { "$ref": "#/components/schemas/CVMProcessoAdministrativo" }, "nullable": true }, "totalProcessos": { "type": "integer", "format": "int32", "nullable": true }, "observacoes": { "type": "string", "nullable": true }, "possuiProcesso": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "CVMProcessosAdministrativosSancionadoresRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/CVMProcessosAdministrativosSancionadores" } }, "additionalProperties": false }, "CadastroEmpresasInidoneasSuspensas": { "type": "object", "properties": { "nomeEntidade": { "type": "string", "nullable": true }, "documentoConsultado": { "type": "string", "nullable": true }, "constamSancoes": { "type": "boolean", "nullable": true }, "observacoes": { "type": "string", "nullable": true }, "sancoes": { "type": "array", "items": { "$ref": "#/components/schemas/SancaoCEIS" }, "nullable": true } }, "additionalProperties": false }, "CadastroEmpresasInidoneasSuspensasRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/CadastroEmpresasInidoneasSuspensas" } }, "additionalProperties": false }, "CadastroEntidadesPrivadasImpedidas": { "type": "object", "properties": { "cnpj": { "type": "string", "nullable": true }, "razaoSocial": { "type": "string", "nullable": true }, "constamSancoes": { "type": "boolean", "nullable": true }, "observacoes": { "type": "string", "nullable": true }, "sancoes": { "type": "array", "items": { "$ref": "#/components/schemas/SancaoCEPIM" }, "nullable": true } }, "additionalProperties": false }, "CadastroEntidadesPrivadasImpedidasRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/CadastroEntidadesPrivadasImpedidas" } }, "additionalProperties": false }, "CadastroExpulsoesAdministracaoFederal": { "type": "object", "properties": { "nome": { "type": "string", "nullable": true }, "cpf": { "type": "string", "nullable": true }, "numeroIdentificacao": { "type": "integer", "format": "int32", "nullable": true }, "constamSancoes": { "type": "boolean", "nullable": true }, "observacoes": { "type": "string", "nullable": true }, "sancoes": { "type": "array", "items": { "$ref": "#/components/schemas/SancaoCEAF" }, "nullable": true } }, "additionalProperties": false }, "CadastroExpulsoesAdministracaoFederalRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/CadastroExpulsoesAdministracaoFederal" } }, "additionalProperties": false }, "CadastroNacionalEmpresasPunidas": { "type": "object", "properties": { "nomeEntidade": { "type": "string", "nullable": true }, "documentoConsultado": { "type": "string", "nullable": true }, "constamSancoes": { "type": "boolean", "nullable": true }, "observacoes": { "type": "string", "nullable": true }, "sancoes": { "type": "array", "items": { "$ref": "#/components/schemas/SancaoCNEP" }, "nullable": true } }, "additionalProperties": false }, "CadastroNacionalEmpresasPunidasRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/CadastroNacionalEmpresasPunidas" } }, "additionalProperties": false }, "CadastroNacionalImprobidadeAdministrativa": { "type": "object", "properties": { "nomeEntidade": { "type": "string", "nullable": true }, "documento": { "type": "string", "nullable": true }, "dataEmissao": { "type": "string", "nullable": true }, "possuiCondenacao": { "type": "boolean", "nullable": true }, "condenacoes": { "type": "array", "items": { "$ref": "#/components/schemas/Condenacao" }, "nullable": true }, "codigoValidacao": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CadastroNacionalImprobidadeAdministrativaRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/CadastroNacionalImprobidadeAdministrativa" } }, "additionalProperties": false }, "CadastroPessoaFisica": { "type": "object", "properties": { "cpf": { "type": "string", "nullable": true }, "nome": { "type": "string", "nullable": true }, "sexo": { "type": "string", "nullable": true }, "dataNascimento": { "type": "string", "nullable": true }, "nomeMae": { "type": "string", "nullable": true }, "idade": { "type": "integer", "format": "int32", "nullable": true }, "signo": { "type": "string", "nullable": true }, "telefones": { "type": "array", "items": { "$ref": "#/components/schemas/Telefone" }, "nullable": true }, "enderecos": { "type": "array", "items": { "$ref": "#/components/schemas/Endereco" }, "nullable": true }, "emails": { "type": "array", "items": { "$ref": "#/components/schemas/Email" }, "nullable": true }, "rendaEstimada": { "type": "string", "nullable": true }, "rendaFaixaSalarial": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CadastroPessoaFisicaPlus": { "type": "object", "properties": { "cpf": { "type": "string", "nullable": true }, "nome": { "type": "string", "nullable": true }, "sexo": { "type": "string", "nullable": true }, "dataNascimento": { "type": "string", "nullable": true }, "nomeMae": { "type": "string", "nullable": true }, "idade": { "type": "integer", "format": "int32", "nullable": true }, "signo": { "type": "string", "nullable": true }, "telefones": { "type": "array", "items": { "$ref": "#/components/schemas/Telefone" }, "nullable": true }, "enderecos": { "type": "array", "items": { "$ref": "#/components/schemas/Endereco" }, "nullable": true }, "emails": { "type": "array", "items": { "$ref": "#/components/schemas/Email" }, "nullable": true }, "rendaEstimada": { "type": "string", "nullable": true }, "rendaFaixaSalarial": { "type": "string", "nullable": true }, "obito": { "type": "boolean", "nullable": true }, "nomePai": { "type": "string", "nullable": true }, "codigoCBO": { "type": "string", "nullable": true }, "cbo": { "type": "string", "nullable": true }, "classeSocial": { "type": "string", "nullable": true }, "situacaoCadastral": { "type": "string", "nullable": true }, "dataSituacaoCadastral": { "type": "string", "nullable": true }, "parentescos": { "type": "array", "items": { "$ref": "#/components/schemas/Parentesco" }, "nullable": true }, "perfilDomiciliar": { "$ref": "#/components/schemas/PerfilDomiciliar" } }, "additionalProperties": false }, "CadastroPessoaFisicaPlusRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/CadastroPessoaFisicaPlus" } }, "additionalProperties": false }, "CadastroPessoaFisicaRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/CadastroPessoaFisica" } }, "additionalProperties": false }, "CadastroPessoaJuridica": { "type": "object", "properties": { "cnpj": { "type": "string", "nullable": true }, "razaoSocial": { "type": "string", "nullable": true }, "nomeFantasia": { "type": "string", "nullable": true }, "dataFundacao": { "type": "string", "nullable": true }, "cnaeCodigo": { "type": "integer", "format": "int32", "nullable": true }, "cnaeDescricao": { "type": "string", "nullable": true }, "cnaEsSecundarios": { "type": "array", "items": { "$ref": "#/components/schemas/CNAESecundario" }, "nullable": true }, "quantidadeFuncionarios": { "type": "integer", "format": "int32", "nullable": true }, "situacaoCadastral": { "type": "string", "nullable": true }, "naturezaJuridicaCodigo": { "type": "integer", "format": "int32", "nullable": true }, "naturezaJuridicaDescricao": { "type": "string", "nullable": true }, "naturezaJuridicaTipo": { "type": "string", "nullable": true }, "porte": { "type": "string", "nullable": true }, "faixaFuncionarios": { "type": "string", "nullable": true }, "faixaFaturamento": { "type": "string", "nullable": true }, "matriz": { "type": "boolean", "nullable": true }, "orgaoPublico": { "type": "string", "nullable": true }, "ramo": { "type": "string", "nullable": true }, "tipoEmpresa": { "type": "string", "nullable": true }, "telefones": { "type": "array", "items": { "$ref": "#/components/schemas/Telefone" }, "nullable": true }, "enderecos": { "type": "array", "items": { "$ref": "#/components/schemas/Endereco" }, "nullable": true }, "emails": { "type": "array", "items": { "$ref": "#/components/schemas/Email" }, "nullable": true }, "ultimaAtualizacaoPJ": { "type": "string", "nullable": true }, "socios": { "type": "array", "items": { "$ref": "#/components/schemas/Socio" }, "nullable": true } }, "additionalProperties": false }, "CadastroPessoaJuridicaPlus": { "type": "object", "properties": { "cnpj": { "type": "string", "nullable": true }, "razaoSocial": { "type": "string", "nullable": true }, "nomeFantasia": { "type": "string", "nullable": true }, "dataFundacao": { "type": "string", "nullable": true }, "cnaeCodigo": { "type": "integer", "format": "int32", "nullable": true }, "cnaeDescricao": { "type": "string", "nullable": true }, "cnaEsSecundarios": { "type": "array", "items": { "$ref": "#/components/schemas/CNAESecundario" }, "nullable": true }, "situacaoCadastral": { "type": "string", "nullable": true }, "situacaoEspecial": { "type": "string", "nullable": true }, "naturezaJuridicaCodigo": { "type": "integer", "format": "int32", "nullable": true }, "naturezaJuridicaDescricao": { "type": "string", "nullable": true }, "naturezaJuridicaTipo": { "type": "string", "nullable": true }, "porte": { "type": "string", "nullable": true }, "faixaFuncionarios": { "type": "string", "nullable": true }, "quantidadeFuncionarios": { "type": "integer", "format": "int32", "nullable": true }, "faixaFaturamento": { "type": "string", "nullable": true }, "faturamentoMedioCNAE": { "type": "string", "nullable": true }, "faturamentoPresumido": { "type": "string", "nullable": true }, "matriz": { "type": "boolean", "nullable": true }, "orgaoPublico": { "type": "string", "nullable": true }, "ramo": { "type": "string", "nullable": true }, "tipoEmpresa": { "type": "string", "nullable": true }, "tributacao": { "type": "string", "nullable": true }, "opcaoMEI": { "type": "string", "nullable": true }, "opcaoSimples": { "type": "string", "nullable": true }, "quantidadeFiliais": { "type": "string", "nullable": true }, "filiais": { "type": "array", "items": { "$ref": "#/components/schemas/Filial" }, "nullable": true }, "telefones": { "type": "array", "items": { "$ref": "#/components/schemas/Telefone" }, "nullable": true }, "enderecos": { "type": "array", "items": { "$ref": "#/components/schemas/Endereco" }, "nullable": true }, "emails": { "type": "array", "items": { "$ref": "#/components/schemas/Email" }, "nullable": true }, "ultimaAtualizacaoPJ": { "type": "string", "nullable": true }, "socios": { "type": "array", "items": { "$ref": "#/components/schemas/Socio" }, "nullable": true } }, "additionalProperties": false }, "CadastroPessoaJuridicaPlusRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/CadastroPessoaJuridicaPlus" } }, "additionalProperties": false }, "CadastroPessoaJuridicaRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/CadastroPessoaJuridica" } }, "additionalProperties": false }, "CadastroReceitaPessoaFisica": { "type": "object", "properties": { "cadastro": { "$ref": "#/components/schemas/CadastroPessoaFisica" }, "receita": { "$ref": "#/components/schemas/ReceitaPessoaFisica" } }, "additionalProperties": false }, "CadastroReceitaPessoaFisicaRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/CadastroReceitaPessoaFisica" } }, "additionalProperties": false }, "CaixaRegularidadeEmpregadorFGTS": { "type": "object", "properties": { "inscricao": { "type": "string", "nullable": true }, "razaoSocial": { "type": "string", "nullable": true }, "nomeFantasia": { "type": "string", "nullable": true }, "nome": { "type": "string", "nullable": true }, "dataNascimento": { "type": "string", "nullable": true }, "possuiIrregularidade": { "type": "boolean", "nullable": true }, "status": { "type": "string", "nullable": true }, "dataEmissao": { "type": "string", "nullable": true }, "numeroCertificado": { "type": "string", "nullable": true }, "endereco": { "$ref": "#/components/schemas/Endereco" }, "periodoValidade": { "$ref": "#/components/schemas/Periodo" }, "historico": { "type": "array", "items": { "$ref": "#/components/schemas/HistoricoEmpregador" }, "nullable": true } }, "additionalProperties": false }, "CaixaRegularidadeEmpregadorFGTSRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/CaixaRegularidadeEmpregadorFGTS" } }, "additionalProperties": false }, "CanadaSEMA": { "type": "object", "properties": { "nomeConsultado": { "type": "string", "nullable": true }, "resultadosEncontrados": { "type": "integer", "format": "int32" }, "observacoes": { "type": "string", "nullable": true }, "dataLista": { "type": "string", "nullable": true }, "sancoes": { "type": "array", "items": { "$ref": "#/components/schemas/CanadaSEMASancoes" }, "nullable": true } }, "additionalProperties": false }, "CanadaSEMAApelidos": { "type": "object", "properties": { "tipo": { "type": "string", "nullable": true }, "idioma": { "type": "string", "nullable": true }, "nome": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CanadaSEMAAtributos": { "type": "object", "properties": { "chave": { "type": "string", "nullable": true }, "valor": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CanadaSEMAIdentificacoes": { "type": "object", "properties": { "tipo": { "type": "string", "nullable": true }, "documento": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CanadaSEMARetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/CanadaSEMA" } }, "additionalProperties": false }, "CanadaSEMASancoes": { "type": "object", "properties": { "nome": { "type": "string", "nullable": true }, "tipoRegistro": { "type": "string", "nullable": true }, "dataNascimento": { "type": "string", "nullable": true }, "titulo": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "dataInclusaoLista": { "type": "string", "nullable": true }, "programas": { "type": "string", "nullable": true }, "apelidos": { "type": "array", "items": { "$ref": "#/components/schemas/CanadaSEMAApelidos" }, "nullable": true }, "identificacoes": { "type": "array", "items": { "$ref": "#/components/schemas/CanadaSEMAIdentificacoes" }, "nullable": true }, "atributos": { "type": "array", "items": { "$ref": "#/components/schemas/CanadaSEMAAtributos" }, "nullable": true } }, "additionalProperties": false }, "CartaoCredito": { "type": "object", "properties": { "tipoRelacionamento": { "type": "string", "nullable": true }, "numeroContrato": { "type": "string", "nullable": true }, "dataContratacao": { "type": "string", "nullable": true }, "tipoContrato": { "type": "string", "nullable": true }, "dataReferencia": { "type": "string", "nullable": true }, "detalheEmprestimo": { "$ref": "#/components/schemas/DetalheEmprestimo" }, "numeroCartao": { "type": "string", "nullable": true }, "saldoTotal": { "type": "number", "format": "double", "nullable": true }, "parcelasAnteriores": { "type": "array", "items": { "$ref": "#/components/schemas/ParcelaAnterior" }, "nullable": true }, "parcelaFutura": { "$ref": "#/components/schemas/ParcelaFutura" } }, "additionalProperties": false }, "CarteiraNacionalHabilitacao": { "type": "object", "properties": { "cpf": { "type": "string", "nullable": true }, "nome": { "type": "string", "nullable": true }, "cnh": { "type": "string", "nullable": true }, "uf": { "type": "string", "nullable": true }, "dataPrimeiraCNH": { "type": "string", "nullable": true }, "nacionalidade": { "type": "string", "nullable": true }, "permissionario": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "CarteiraNacionalHabilitacaoRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/CarteiraNacionalHabilitacao" } }, "additionalProperties": false }, "CartorioCompleta": { "type": "object", "properties": { "estado": { "type": "string", "nullable": true }, "codigoCidade": { "type": "string", "nullable": true }, "cidade": { "type": "string", "nullable": true }, "codigoCartorio": { "type": "string", "nullable": true }, "nomeCartorio": { "type": "string", "nullable": true }, "telefone": { "type": "string", "nullable": true }, "endereco": { "type": "string", "nullable": true }, "numeroProtestos": { "type": "integer", "format": "int32", "nullable": true }, "valorTotalProtestosCartorio": { "type": "string", "nullable": true }, "titulos": { "type": "array", "items": { "$ref": "#/components/schemas/TituloCompleta" }, "nullable": true } }, "additionalProperties": false }, "CartorioDCC": { "type": "object", "properties": { "codigoCidade": { "type": "string", "nullable": true }, "codigoCartorio": { "type": "string", "nullable": true }, "nome": { "type": "string", "nullable": true }, "telefone": { "type": "string", "nullable": true }, "endereco": { "type": "string", "nullable": true }, "cidade": { "type": "string", "nullable": true }, "quantidadeProtestos": { "type": "integer", "format": "int32", "nullable": true }, "valorProtestado": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "CartorioDN": { "type": "object", "properties": { "codigoCidade": { "type": "string", "nullable": true }, "codigoCartorio": { "type": "string", "nullable": true }, "nome": { "type": "string", "nullable": true }, "telefone": { "type": "string", "nullable": true }, "endereco": { "type": "string", "nullable": true }, "cidade": { "type": "string", "nullable": true }, "quantidadeProtestos": { "type": "integer", "format": "int32", "nullable": true }, "valorProtestado": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "CartorioOnline": { "type": "object", "properties": { "codigoCidade": { "type": "string", "nullable": true }, "cidade": { "type": "string", "nullable": true }, "numeroProtestos": { "type": "integer", "format": "int32", "nullable": true }, "valorTotalProtestosCartorio": { "type": "string", "nullable": true }, "titulos": { "type": "array", "items": { "$ref": "#/components/schemas/TituloOnline" }, "nullable": true } }, "additionalProperties": false }, "Categorias": { "type": "object", "properties": { "listaCategorias": { "type": "array", "items": { "$ref": "#/components/schemas/ListaCategorias" }, "nullable": true }, "observacaoCategoria": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Certidao": { "type": "object", "properties": { "emissor": { "type": "string", "nullable": true }, "tipo": { "type": "string", "nullable": true }, "dataEmissao": { "type": "string", "nullable": true }, "descricao": { "type": "string", "nullable": true }, "possuiSancao": { "type": "boolean", "nullable": true }, "status": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CertidaoConjuntaDebitosPessoaFisica": { "type": "object", "properties": { "titulo": { "type": "string", "nullable": true }, "cpf": { "type": "string", "nullable": true }, "nome": { "type": "string", "nullable": true }, "portaria": { "type": "string", "nullable": true }, "emitidaAs": { "type": "string", "nullable": true }, "validaAte": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "possuiDividas": { "type": "boolean", "nullable": true }, "listaDividas": { "type": "array", "items": { "type": "string" }, "nullable": true }, "codigoControleCertidao": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CertidaoConjuntaDebitosPessoaFisicaRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/CertidaoConjuntaDebitosPessoaFisica" } }, "additionalProperties": false }, "CertidaoConjuntaDebitosPessoaJuridica": { "type": "object", "properties": { "titulo": { "type": "string", "nullable": true }, "cnpj": { "type": "string", "nullable": true }, "nome": { "type": "string", "nullable": true }, "portaria": { "type": "string", "nullable": true }, "emitidaAs": { "type": "string", "nullable": true }, "validaAte": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "possuiDividas": { "type": "boolean", "nullable": true }, "listaDividas": { "type": "array", "items": { "type": "string" }, "nullable": true }, "codigoControleCertidao": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CertidaoConjuntaDebitosPessoaJuridicaRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/CertidaoConjuntaDebitosPessoaJuridica" } }, "additionalProperties": false }, "CertidaoNegativaDebitos": { "type": "object", "properties": { "nomeEntidade": { "type": "string", "nullable": true }, "documentoConsultado": { "type": "string", "nullable": true }, "uf": { "type": "string", "nullable": true }, "inscricaoEstadual": { "type": "string", "nullable": true }, "dataEmissao": { "type": "string", "nullable": true }, "dataValidade": { "type": "string", "nullable": true }, "possuiDebito": { "type": "boolean", "nullable": true }, "debitos": { "type": "array", "items": { "type": "string" }, "nullable": true }, "efeitoNegativa": { "type": "boolean", "nullable": true }, "numeroCertidao": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "codigoValidacao": { "type": "string", "nullable": true }, "observacao": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CertidaoNegativaDebitosImovelRural": { "type": "object", "properties": { "nomeImovel": { "type": "string", "nullable": true }, "cib": { "type": "string", "nullable": true }, "municipio": { "type": "string", "nullable": true }, "uf": { "type": "string", "nullable": true }, "contribuinte": { "type": "string", "nullable": true }, "cpf": { "type": "string", "nullable": true }, "areaTotal": { "type": "string", "nullable": true }, "dataEmissao": { "type": "string", "nullable": true }, "dataValidade": { "type": "string", "nullable": true }, "possuiDebito": { "type": "boolean", "nullable": true }, "efeitoNegativa": { "type": "boolean", "nullable": true }, "debitos": { "type": "array", "items": { "type": "string" }, "nullable": true }, "status": { "type": "string", "nullable": true }, "codigoControleCertidao": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CertidaoNegativaDebitosImovelRuralRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/CertidaoNegativaDebitosImovelRural" } }, "additionalProperties": false }, "CertidaoNegativaDebitosMunicipal": { "type": "object", "properties": { "nomeEntidade": { "type": "string", "nullable": true }, "documentoConsultado": { "type": "string", "nullable": true }, "inscricaoMunicipal": { "type": "string", "nullable": true }, "uf": { "type": "string", "nullable": true }, "cidade": { "type": "string", "nullable": true }, "dataEmissao": { "type": "string", "nullable": true }, "dataValidade": { "type": "string", "nullable": true }, "possuiDebito": { "type": "boolean", "nullable": true }, "efeitoNegativa": { "type": "boolean", "nullable": true }, "debitos": { "type": "array", "items": { "type": "string" }, "nullable": true }, "numeroCertidao": { "type": "string", "nullable": true }, "codigoValidacao": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "observacao": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CertidaoNegativaDebitosMunicipalRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/CertidaoNegativaDebitosMunicipal" } }, "additionalProperties": false }, "CertidaoNegativaDebitosRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/CertidaoNegativaDebitos" } }, "additionalProperties": false }, "Certificacoes": { "type": "object", "properties": { "titulo": { "type": "string", "nullable": true }, "primeiraCertificacao": { "type": "string", "nullable": true }, "ultimaAtualizacao": { "type": "string", "nullable": true }, "vencimento": { "type": "string", "nullable": true }, "formaObtencao": { "type": "string", "nullable": true }, "situacao": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ChequeSemFundo": { "type": "object", "properties": { "tipoPessoa": { "type": "string", "nullable": true }, "documento": { "type": "string", "nullable": true }, "codigoBanco": { "type": "string", "nullable": true }, "nomeAgencia": { "type": "string", "nullable": true }, "numeroAgencia": { "type": "string", "nullable": true }, "dataUltimaOcorrencia": { "type": "string", "nullable": true }, "quantidadeOcorrencia": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "ChequeSemFundoDCC": { "type": "object", "properties": { "entidade": { "type": "string", "nullable": true }, "documento": { "type": "string", "nullable": true }, "codigoBanco": { "type": "string", "nullable": true }, "nomeAgencia": { "type": "string", "nullable": true }, "numeroAgencia": { "type": "string", "nullable": true }, "dataUltimaOcorrencia": { "type": "string", "nullable": true }, "quantidadeOcorrencia": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "ChequesSemFundoResumo": { "type": "object", "properties": { "quantidade": { "type": "string", "nullable": true }, "correntista": { "type": "string", "nullable": true }, "tipoPessoa": { "type": "string", "nullable": true }, "documento": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ChequesSemFundoResumoDefineLimitePositivoPJ": { "type": "object", "properties": { "quantidade": { "type": "string", "nullable": true }, "correntista": { "type": "string", "nullable": true }, "tipoPessoa": { "type": "string", "nullable": true }, "documento": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ChequesSemFundosAcertaCompletoPF": { "type": "object", "properties": { "quantidadeOcorrencia": { "type": "string", "nullable": true }, "correntista": { "type": "string", "nullable": true }, "tipoPessoa": { "type": "string", "nullable": true }, "documento": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ChequesSemFundosPF": { "type": "object", "properties": { "quantidadeOcorrencia": { "type": "string", "nullable": true }, "correntista": { "type": "string", "nullable": true }, "tipoPessoa": { "type": "string", "nullable": true }, "documento": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CityEntity": { "type": "object", "properties": { "city": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "distance": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "ClassificacaoProcesso": { "type": "object", "properties": { "codigoClassificacao": { "type": "string", "nullable": true }, "descricao": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CnhCompleta": { "type": "object", "properties": { "cpf": { "type": "string", "nullable": true }, "nome": { "type": "string", "nullable": true }, "nomeMae": { "type": "string", "nullable": true }, "nomePai": { "type": "string", "nullable": true }, "dataNascimento": { "type": "string", "nullable": true }, "rg": { "type": "string", "nullable": true }, "ufrg": { "type": "string", "nullable": true }, "orgaoEmissorRG": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "telefone": { "type": "string", "nullable": true }, "endereco": { "type": "string", "nullable": true }, "numeroCNH": { "type": "string", "nullable": true }, "categoria": { "type": "string", "nullable": true }, "renach": { "type": "string", "nullable": true }, "dataPrimeiraCNH": { "type": "string", "nullable": true }, "dataEmissao": { "type": "string", "nullable": true }, "dataValidade": { "type": "string", "nullable": true }, "numeroRegistro": { "type": "string", "nullable": true }, "observacao": { "type": "string", "nullable": true }, "exameToxicologico": { "$ref": "#/components/schemas/CnhCompletaExameToxicologico" }, "bloqueios": { "type": "array", "items": { "$ref": "#/components/schemas/CnhCompletaBloqueios" }, "nullable": true }, "exames": { "type": "array", "items": { "$ref": "#/components/schemas/CnhCompletaExames" }, "nullable": true }, "cursos": { "type": "array", "items": { "$ref": "#/components/schemas/CnhCompletaCursos" }, "nullable": true } }, "additionalProperties": false }, "CnhCompletaBloqueios": { "type": "object", "properties": { "uf": { "type": "string", "nullable": true }, "data": { "type": "string", "nullable": true }, "descricao": { "type": "string", "nullable": true }, "diasPenalidade": { "type": "string", "nullable": true }, "dataInicioPenalidade": { "type": "string", "nullable": true }, "dataFimPenalidade": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CnhCompletaCursos": { "type": "object", "properties": { "nome": { "type": "string", "nullable": true }, "dataInicio": { "type": "string", "nullable": true }, "dataFim": { "type": "string", "nullable": true }, "categoria": { "type": "string", "nullable": true }, "modalidade": { "type": "string", "nullable": true }, "dataValidade": { "type": "string", "nullable": true }, "cidadeRealizacao": { "type": "string", "nullable": true }, "uf": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CnhCompletaExameToxicologico": { "type": "object", "properties": { "dataColeta": { "type": "string", "nullable": true }, "situacao": { "type": "string", "nullable": true }, "dataVencimento": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CnhCompletaExames": { "type": "object", "properties": { "nome": { "type": "string", "nullable": true }, "data": { "type": "string", "nullable": true }, "resultado": { "type": "string", "nullable": true }, "validade": { "type": "string", "nullable": true }, "categoriaPretendida": { "type": "string", "nullable": true }, "categoriaPermitida": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CnhCompletaRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/CnhCompleta" } }, "additionalProperties": false }, "CnhPlus": { "type": "object", "properties": { "cpf": { "type": "string", "nullable": true }, "nome": { "type": "string", "nullable": true }, "nomeMae": { "type": "string", "nullable": true }, "nomePai": { "type": "string", "nullable": true }, "dataNascimento": { "type": "string", "nullable": true }, "rg": { "type": "string", "nullable": true }, "ufrg": { "type": "string", "nullable": true }, "orgaoEmissorRG": { "type": "string", "nullable": true }, "numeroCNH": { "type": "string", "nullable": true }, "categoria": { "type": "string", "nullable": true }, "renach": { "type": "string", "nullable": true }, "dataPrimeiraCNH": { "type": "string", "nullable": true }, "dataEmissao": { "type": "string", "nullable": true }, "dataValidade": { "type": "string", "nullable": true }, "numeroRegistro": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CnhPlusRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/CnhPlus" } }, "additionalProperties": false }, "CoberturaSolo": { "type": "object", "properties": { "vegetacaoNativa": { "type": "string", "nullable": true }, "ruralConsolidada": { "type": "string", "nullable": true }, "servidaoAdministrativa": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ComposicaoJulgamento": { "type": "object", "properties": { "participacao": { "type": "string", "nullable": true }, "magistrado": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ComposicaoSocietaria": { "type": "object", "properties": { "categoria": { "type": "string", "nullable": true }, "quantidade": { "type": "integer", "format": "int32", "nullable": true }, "participacaoRelativa": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ComposicaoSocietariaDAP": { "type": "object", "properties": { "categoria": { "type": "string", "nullable": true }, "quantidade": { "type": "integer", "format": "int32", "nullable": true }, "participacaoRelativa": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ComunicacaoVendaVeiculoEstadual": { "type": "object", "properties": { "situacao": { "type": "string", "nullable": true }, "dataInclusao": { "type": "string", "nullable": true }, "tipoDocumentoComprador": { "type": "string", "nullable": true }, "documentoComprador": { "type": "string", "nullable": true }, "dataVenda": { "type": "string", "nullable": true }, "proprietarioAnterior": { "type": "string", "nullable": true }, "numeroIdentificacaoFaturado": { "type": "string", "nullable": true }, "tipoDocumentoFaturado": { "type": "string", "nullable": true }, "ufDestinoFaturamento": { "type": "string", "nullable": true }, "tipoRemarcacaoChassi": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Condenacao": { "type": "object", "properties": { "tribunal": { "type": "string", "nullable": true }, "comarca": { "type": "string", "nullable": true }, "orgao": { "type": "string", "nullable": true }, "numeroProcesso": { "type": "string", "nullable": true }, "dataTransitoJulgado": { "type": "string", "nullable": true }, "condenacaoCumprida": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "ConselhoFederalMedicina": { "type": "object", "properties": { "nomePesquisado": { "type": "string", "nullable": true }, "crm": { "type": "string", "nullable": true }, "uf": { "type": "string", "nullable": true }, "observacoes": { "type": "string", "nullable": true }, "medicos": { "type": "array", "items": { "$ref": "#/components/schemas/Medico" }, "nullable": true } }, "additionalProperties": false }, "ConselhoFederalMedicinaRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/ConselhoFederalMedicina" } }, "additionalProperties": false }, "Consorcio": { "type": "object", "properties": { "tipoRelacionamento": { "type": "string", "nullable": true }, "numeroContrato": { "type": "string", "nullable": true }, "dataContratacao": { "type": "string", "nullable": true }, "tipoContrato": { "type": "string", "nullable": true }, "dataReferencia": { "type": "string", "nullable": true }, "detalheEmprestimo": { "$ref": "#/components/schemas/DetalheEmprestimo" }, "numeroGrupo": { "type": "string", "nullable": true }, "codigoCota": { "type": "string", "nullable": true }, "sequenciaCota": { "type": "string", "nullable": true }, "statusCota": { "type": "string", "nullable": true }, "valorContrato": { "type": "number", "format": "double", "nullable": true }, "dataVencimento": { "type": "string", "nullable": true }, "quantidadeTotalParcela": { "type": "integer", "format": "int32", "nullable": true }, "totalDevedor": { "type": "number", "format": "double", "nullable": true }, "dataContemplacao": { "type": "string", "nullable": true }, "parcelasAnteriores": { "type": "array", "items": { "$ref": "#/components/schemas/ParcelaAnterior" }, "nullable": true }, "pagamentosDesanexados": { "type": "array", "items": { "$ref": "#/components/schemas/PagamentoDesanexado" }, "nullable": true }, "parcelasFuturas": { "type": "array", "items": { "$ref": "#/components/schemas/ParcelaFutura" }, "nullable": true } }, "additionalProperties": false }, "ConsultaDCC": { "type": "object", "properties": { "cnpj": { "type": "string", "nullable": true }, "ultimos30Dias": { "type": "integer", "format": "int32", "nullable": true }, "ultimos60Dias": { "type": "integer", "format": "int32", "nullable": true }, "ultimos90Dias": { "type": "integer", "format": "int32", "nullable": true }, "mais90Dias": { "type": "integer", "format": "int32", "nullable": true }, "detalhesConsulta": { "type": "array", "items": { "$ref": "#/components/schemas/DetalhesConsulta" }, "nullable": true } }, "additionalProperties": false }, "ConsultaLeilaoVeicular": { "type": "object", "properties": { "placa": { "type": "string", "nullable": true }, "chassi": { "type": "string", "nullable": true }, "marcaModelo": { "type": "string", "nullable": true }, "anoFabricacaoModelo": { "type": "string", "nullable": true }, "cor": { "type": "string", "nullable": true }, "possuiRegistro": { "type": "boolean", "nullable": true }, "totalRegistros": { "type": "integer", "format": "int32", "nullable": true }, "analiseRisco": { "type": "string", "nullable": true }, "registros": { "type": "array", "items": { "$ref": "#/components/schemas/LeilaoVeicularRegistro" }, "nullable": true }, "status": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ConsultaLeilaoVeicularRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/ConsultaLeilaoVeicular" } }, "additionalProperties": false }, "ConsultaVeicular": { "type": "object", "properties": { "proprietario": { "type": "string", "nullable": true }, "documento": { "type": "string", "nullable": true }, "anoExercicio": { "type": "string", "nullable": true }, "veiculo": { "$ref": "#/components/schemas/Veiculo" } }, "additionalProperties": false }, "ConsultaVeicularCrlvSP": { "type": "object", "properties": { "placa": { "type": "string", "nullable": true }, "chassi": { "type": "string", "nullable": true }, "renavam": { "type": "string", "nullable": true }, "marcaModelo": { "type": "string", "nullable": true }, "anoFabricacao": { "type": "string", "nullable": true }, "anoModelo": { "type": "string", "nullable": true }, "cor": { "type": "string", "nullable": true }, "combustivel": { "type": "string", "nullable": true }, "cidade": { "type": "string", "nullable": true }, "uf": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ConsultaVeicularCrlvSPRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/ConsultaVeicularCrlvSP" } }, "additionalProperties": false }, "ConsultaVeicularEstadual": { "type": "object", "properties": { "placa": { "type": "string", "nullable": true }, "chassi": { "type": "string", "nullable": true }, "renavam": { "type": "string", "nullable": true }, "situacao": { "type": "string", "nullable": true }, "municipio": { "type": "string", "nullable": true }, "uf": { "type": "string", "nullable": true }, "documento": { "type": "string", "nullable": true }, "tipoDocumento": { "type": "string", "nullable": true }, "nomeRazaoSocial": { "type": "string", "nullable": true }, "licenciamentoData": { "type": "string", "nullable": true }, "dataEmissaoCrv": { "type": "string", "nullable": true }, "veiculo": { "$ref": "#/components/schemas/VeiculoEstadual" }, "debitos": { "$ref": "#/components/schemas/DebitosVeiculoEstadual" }, "restricoes": { "$ref": "#/components/schemas/RestricoesVeiculoEstadual" }, "comunicacaoVenda": { "$ref": "#/components/schemas/ComunicacaoVendaVeiculoEstadual" } }, "additionalProperties": false }, "ConsultaVeicularEstadualRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/ConsultaVeicularEstadual" } }, "additionalProperties": false }, "ConsultaVeicularFipe": { "type": "object", "properties": { "proprietario": { "type": "string", "nullable": true }, "documento": { "type": "string", "nullable": true }, "anoExercicio": { "type": "string", "nullable": true }, "veiculo": { "$ref": "#/components/schemas/VeiculoFipe" } }, "additionalProperties": false }, "ConsultaVeicularFipeRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/ConsultaVeicularFipe" } }, "additionalProperties": false }, "ConsultaVeicularFrotasNacional": { "type": "object", "properties": { "documentoConsultado": { "type": "string", "nullable": true }, "nomeProprietario": { "type": "string", "nullable": true }, "quantidadeVeiculos": { "type": "integer", "format": "int32" }, "veiculos": { "type": "array", "items": { "$ref": "#/components/schemas/VeiculosFrotas" }, "nullable": true } }, "additionalProperties": false }, "ConsultaVeicularFrotasNacionalRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/ConsultaVeicularFrotasNacional" } }, "additionalProperties": false }, "ConsultaVeicularGravame": { "type": "object", "properties": { "placa": { "type": "string", "nullable": true }, "ufPlaca": { "type": "string", "nullable": true }, "chassi": { "type": "string", "nullable": true }, "renavam": { "type": "string", "nullable": true }, "descricaoStatus": { "type": "string", "nullable": true }, "statusDoVeiculo": { "type": "string", "nullable": true }, "veiculo": { "$ref": "#/components/schemas/VeiculoGravame" }, "gravame": { "$ref": "#/components/schemas/GravameInfo" } }, "additionalProperties": false }, "ConsultaVeicularGravameRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/ConsultaVeicularGravame" } }, "additionalProperties": false }, "ConsultaVeicularHistoricoProprietarios": { "type": "object", "properties": { "placaConsultada": { "type": "string", "nullable": true }, "totalRegistros": { "type": "integer", "format": "int32", "nullable": true }, "registros": { "type": "array", "items": { "$ref": "#/components/schemas/HistoricoProprietarioRegistro" }, "nullable": true } }, "additionalProperties": false }, "ConsultaVeicularHistoricoProprietariosRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/ConsultaVeicularHistoricoProprietarios" } }, "additionalProperties": false }, "ConsultaVeicularMultasRadar": { "type": "object", "properties": { "nomeProprietario": { "type": "string", "nullable": true }, "documentoProprietario": { "type": "string", "nullable": true }, "placa": { "type": "string", "nullable": true }, "renavam": { "type": "string", "nullable": true }, "uf": { "type": "string", "nullable": true }, "marcaModelo": { "type": "string", "nullable": true }, "quantidadeInfracoes": { "type": "integer", "format": "int32", "nullable": true }, "infracoes": { "type": "array", "items": { "$ref": "#/components/schemas/MultasRadarInfracao" }, "nullable": true }, "status": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ConsultaVeicularMultasRadarRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/ConsultaVeicularMultasRadar" } }, "additionalProperties": false }, "ConsultaVeicularProprietarioAtual": { "type": "object", "properties": { "documento": { "type": "string", "nullable": true }, "nomeEntidade": { "type": "string", "nullable": true }, "municipio": { "type": "string", "nullable": true }, "uf": { "type": "string", "nullable": true }, "placa": { "type": "string", "nullable": true }, "chassi": { "type": "string", "nullable": true }, "renavam": { "type": "string", "nullable": true }, "motor": { "type": "string", "nullable": true }, "marcaModelo": { "type": "string", "nullable": true }, "combustivel": { "type": "string", "nullable": true }, "cor": { "type": "string", "nullable": true }, "anoFabricacao": { "type": "string", "nullable": true }, "anoModelo": { "type": "string", "nullable": true }, "tipoVeiculo": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ConsultaVeicularProprietarioAtualRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/ConsultaVeicularProprietarioAtual" } }, "additionalProperties": false }, "ConsultaVeicularRecall": { "type": "object", "properties": { "placa": { "type": "string", "nullable": true }, "possuiRecallPendente": { "type": "boolean", "nullable": true }, "quantidadeRecallsPendentes": { "type": "integer", "format": "int32", "nullable": true }, "recallsPendentes": { "type": "array", "items": { "$ref": "#/components/schemas/RecallPendente" }, "nullable": true } }, "additionalProperties": false }, "ConsultaVeicularRecallRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/ConsultaVeicularRecall" } }, "additionalProperties": false }, "ConsultaVeicularRenainf": { "type": "object", "properties": { "placa": { "type": "string", "nullable": true }, "quantidadeOcorrencias": { "type": "integer", "format": "int32", "nullable": true }, "registros": { "type": "array", "items": { "$ref": "#/components/schemas/RenainfRegistro" }, "nullable": true }, "status": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ConsultaVeicularRenainfRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/ConsultaVeicularRenainf" } }, "additionalProperties": false }, "ConsultaVeicularRenajud": { "type": "object", "properties": { "placa": { "type": "string", "nullable": true }, "placaAnterior": { "type": "string", "nullable": true }, "chassi": { "type": "string", "nullable": true }, "renavam": { "type": "string", "nullable": true }, "marcaModelo": { "type": "string", "nullable": true }, "anoFabricacao": { "type": "string", "nullable": true }, "anoModelo": { "type": "string", "nullable": true }, "uf": { "type": "string", "nullable": true }, "mensagem": { "type": "string", "nullable": true }, "quantidadeOcorrenciasTotal": { "type": "integer", "format": "int32", "nullable": true }, "quantidadeBloqueioAtivo": { "type": "integer", "format": "int32", "nullable": true }, "quantidadeBaixadas": { "type": "integer", "format": "int32", "nullable": true }, "proprietario": { "$ref": "#/components/schemas/RenajudProprietario" }, "ocorrencias": { "type": "array", "items": { "$ref": "#/components/schemas/RenajudOcorrencia" }, "nullable": true }, "status": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ConsultaVeicularRenajudRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/ConsultaVeicularRenajud" } }, "additionalProperties": false }, "ConsultaVeicularRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/ConsultaVeicular" } }, "additionalProperties": false }, "ConsultaVeicularRouboFurto": { "type": "object", "properties": { "placa": { "type": "string", "nullable": true }, "chassi": { "type": "string", "nullable": true }, "renavam": { "type": "string", "nullable": true }, "situacao": { "type": "string", "nullable": true }, "ocorrenciaAtual": { "type": "string", "nullable": true }, "indicadores": { "$ref": "#/components/schemas/IndicadoresRouboFurto" }, "totalOcorrencias": { "type": "integer", "format": "int32", "nullable": true }, "ocorrencias": { "type": "array", "items": { "$ref": "#/components/schemas/OcorrenciaRouboFurto" }, "nullable": true }, "veiculo": { "$ref": "#/components/schemas/VeiculoRouboFurto" } }, "additionalProperties": false }, "ConsultaVeicularRouboFurtoRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/ConsultaVeicularRouboFurto" } }, "additionalProperties": false }, "ConsultasConglomerado": { "type": "object", "properties": { "consultas": { "type": "array", "items": { "$ref": "#/components/schemas/ConsultaDCC" }, "nullable": true } }, "additionalProperties": false }, "ContatoSancao": { "type": "object", "properties": { "web": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "fax": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ControlePositivoAcertaCompletoPF": { "type": "object", "properties": { "ocorrenciasFaturasEmAtraso": { "type": "array", "items": { "$ref": "#/components/schemas/NotaFaturaAtrasoAcertaCompletoPF" }, "nullable": true }, "ocorrenciasNotaComportamentosContratosRecentes": { "type": "array", "items": { "$ref": "#/components/schemas/NotaContratoRecenteAcertaCompletoPF" }, "nullable": true } }, "additionalProperties": false }, "ControlePositivoPF": { "type": "object", "properties": { "ocorrenciasFaturasEmAtraso": { "type": "array", "items": { "$ref": "#/components/schemas/NotaFaturaAtrasoPF" }, "nullable": true }, "ocorrenciasNotaComportamentosContratosRecentes": { "type": "array", "items": { "$ref": "#/components/schemas/NotaContratoRecentePF" }, "nullable": true } }, "additionalProperties": false }, "ContumaciaResumo": { "type": "object", "properties": { "quantidade": { "type": "string", "nullable": true }, "dataPrimeiraOcorrencia": { "type": "string", "nullable": true }, "dataUltimaOcorrencia": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ContumaciaResumoDefineLimitePositivoPJ": { "type": "object", "properties": { "quantidade": { "type": "string", "nullable": true }, "dataPrimeiraOcorrencia": { "type": "string", "nullable": true }, "dataUltimaOcorrencia": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CorreiosBuscaCEP": { "type": "object", "properties": { "enderecoConsultado": { "type": "string", "nullable": true }, "quantidadeEnderecos": { "type": "integer", "format": "int32" }, "enderecos": { "type": "array", "items": { "$ref": "#/components/schemas/CEPCorreios" }, "nullable": true } }, "additionalProperties": false }, "CorreiosBuscaCEPRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/CorreiosBuscaCEP" } }, "additionalProperties": false }, "DAPPessoaFisica": { "type": "object", "properties": { "numeroDAP": { "type": "string", "nullable": true }, "dataEmissao": { "type": "string", "nullable": true }, "dataValidade": { "type": "string", "nullable": true }, "versao": { "type": "string", "nullable": true }, "municipio": { "type": "string", "nullable": true }, "uf": { "type": "string", "nullable": true }, "caf": { "type": "string", "nullable": true }, "enquadramento": { "type": "string", "nullable": true }, "tipoDAP": { "type": "string", "nullable": true }, "motivoDesativacao": { "type": "string", "nullable": true }, "dataDesativacao": { "type": "string", "nullable": true }, "emissor": { "$ref": "#/components/schemas/EmissorDAP" }, "titulares": { "type": "array", "items": { "$ref": "#/components/schemas/TitularDAP" }, "nullable": true }, "categorias": { "type": "array", "items": { "type": "string" }, "nullable": true }, "usoTerra": { "type": "array", "items": { "type": "string" }, "nullable": true }, "caracterizacaoBeneficiario": { "type": "array", "items": { "type": "string" }, "nullable": true }, "renda": { "$ref": "#/components/schemas/RendaDAP" }, "imovel": { "$ref": "#/components/schemas/ImovelDAP" } }, "additionalProperties": false }, "DAPPessoaFisicaRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/DAPPessoaFisica" } }, "additionalProperties": false }, "DAPPessoaJuridica": { "type": "object", "properties": { "numeroDAP": { "type": "string", "nullable": true }, "dataEmissao": { "type": "string", "nullable": true }, "dataValidade": { "type": "string", "nullable": true }, "versao": { "type": "string", "nullable": true }, "municipio": { "type": "string", "nullable": true }, "uf": { "type": "string", "nullable": true }, "cnpj": { "type": "string", "nullable": true }, "razaoSocial": { "type": "string", "nullable": true }, "tipo": { "type": "string", "nullable": true }, "dataConstituicao": { "type": "string", "nullable": true }, "nomeRepresentanteLegal": { "type": "string", "nullable": true }, "cpfRepresentanteLegal": { "type": "string", "nullable": true }, "emissor": { "$ref": "#/components/schemas/EmissorDAP" }, "composicaoSocietaria": { "type": "array", "items": { "$ref": "#/components/schemas/ComposicaoSocietariaDAP" }, "nullable": true }, "daPsPorMunicipios": { "type": "array", "items": { "$ref": "#/components/schemas/DAPsPorMunicipio" }, "nullable": true }, "resultadoAssociados": { "type": "array", "items": { "$ref": "#/components/schemas/ComposicaoSocietariaDAP" }, "nullable": true } }, "additionalProperties": false }, "DAPPessoaJuridicaRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/DAPPessoaJuridica" } }, "additionalProperties": false }, "DAPsPorMunicipio": { "type": "object", "properties": { "municipio": { "type": "string", "nullable": true }, "uf": { "type": "string", "nullable": true }, "quantidade": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "DNIEntity": { "type": "object", "properties": { "dni": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "distance": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "DOBEntity": { "type": "object", "properties": { "dob": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "distance": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "DadoEmpresarial": { "type": "object", "properties": { "entidade": { "type": "string", "nullable": true }, "documento": { "type": "string", "nullable": true }, "nomeEmpresa": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "percentualParticipacao": { "type": "number", "format": "double", "nullable": true }, "valorFinanceiro": { "type": "number", "format": "double", "nullable": true }, "funcaoSocio": { "type": "string", "nullable": true }, "dataInicioSociedade": { "type": "string", "nullable": true }, "dataInicioEntrada": { "type": "string", "nullable": true }, "dataSaida": { "type": "string", "nullable": true }, "socioAdministrador": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "DadoPessoal": { "type": "object", "properties": { "status": { "type": "string", "nullable": true }, "nome": { "type": "string", "nullable": true }, "nomeMae": { "type": "string", "nullable": true }, "dataNascimento": { "type": "string", "nullable": true }, "idade": { "type": "integer", "format": "int32", "nullable": true }, "sexo": { "type": "string", "nullable": true }, "possuiObito": { "type": "boolean", "nullable": true }, "dataObito": { "type": "string", "nullable": true }, "dadosAtuais": { "$ref": "#/components/schemas/DadosAtuais" }, "outrosNomes": { "type": "array", "items": { "type": "string" }, "nullable": true }, "outrosEnderecos": { "type": "array", "items": { "$ref": "#/components/schemas/EnderecoDCC" }, "nullable": true }, "outrosEmails": { "type": "array", "items": { "type": "string" }, "nullable": true }, "outrosTelefonesFixos": { "type": "array", "items": { "type": "string" }, "nullable": true }, "outrosCelulares": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "DadosAtuais": { "type": "object", "properties": { "endereco": { "$ref": "#/components/schemas/EnderecoDCC" }, "email": { "type": "string", "nullable": true }, "telefoneFixo": { "type": "string", "nullable": true }, "celular": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DadosBancarios": { "type": "object", "properties": { "chavePix": { "type": "string", "nullable": true }, "banco": { "type": "string", "nullable": true }, "agencia": { "type": "string", "nullable": true }, "conta": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DadosCadastrais": { "type": "object", "properties": { "situacaoCadastral": { "type": "string", "nullable": true }, "razaoSocial": { "type": "string", "nullable": true }, "nomeFantasia": { "type": "string", "nullable": true }, "naturezaJuridica": { "type": "string", "nullable": true }, "quantidadeFilial": { "type": "integer", "format": "int32", "nullable": true }, "nire": { "type": "integer", "format": "int64", "nullable": true }, "codigoAtividadePrincipal": { "type": "string", "nullable": true }, "descricaoAtividadePrincipal": { "type": "string", "nullable": true }, "codigoAtividadeSecundaria": { "type": "string", "nullable": true }, "descricaoAtividadeSecundaria": { "type": "string", "nullable": true }, "dataFundacao": { "type": "string", "nullable": true }, "endereco": { "$ref": "#/components/schemas/EnderecoDCC" }, "email": { "type": "string", "nullable": true }, "telefone": { "type": "string", "nullable": true }, "outrosEnderecos": { "type": "array", "items": { "$ref": "#/components/schemas/EnderecoDCC" }, "nullable": true }, "outrosEmails": { "type": "array", "items": { "type": "string" }, "nullable": true }, "outrosTelefones": { "type": "array", "items": { "type": "string" }, "nullable": true }, "outrasEmpresas": { "type": "array", "items": { "$ref": "#/components/schemas/EmpresaDCC" }, "nullable": true } }, "additionalProperties": false }, "DadosImovelRural": { "type": "object", "properties": { "area": { "type": "string", "nullable": true }, "dataInscricao": { "type": "string", "nullable": true }, "dataUltimaRetificacao": { "type": "string", "nullable": true }, "modulosFiscais": { "type": "string", "nullable": true }, "municipio": { "type": "string", "nullable": true }, "uf": { "type": "string", "nullable": true }, "latitude": { "type": "string", "nullable": true }, "longitude": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DadosNFe": { "type": "object", "properties": { "numeroNFe": { "type": "integer", "format": "int64", "nullable": true }, "serie": { "type": "integer", "format": "int32", "nullable": true }, "dataEmissao": { "type": "string", "nullable": true }, "naturezaOperacao": { "type": "string", "nullable": true }, "tipoNFe": { "type": "string", "nullable": true }, "modelo": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "DadosPublicacao": { "type": "object", "properties": { "data": { "type": "string", "nullable": true }, "texto": { "type": "string", "nullable": true }, "link": { "type": "string", "nullable": true }, "detalhamento": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Debito": { "type": "object", "properties": { "valor": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "DebitoIbama": { "type": "object", "properties": { "numero": { "type": "integer", "format": "int64", "nullable": true }, "tipo": { "type": "string", "nullable": true }, "valorOriginal": { "type": "number", "format": "double", "nullable": true }, "situacao": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DebitosVeiculoEstadual": { "type": "object", "properties": { "situacaoIpva": { "type": "string", "nullable": true }, "situacaoMulta": { "type": "string", "nullable": true }, "situacaoLicenciamento": { "type": "string", "nullable": true }, "situacaoDpvat": { "type": "string", "nullable": true }, "valorIpva": { "type": "string", "nullable": true }, "valorMulta": { "type": "string", "nullable": true }, "valorLicenciamento": { "type": "string", "nullable": true }, "valorDpvat": { "type": "string", "nullable": true }, "valorDersa": { "type": "string", "nullable": true }, "valorDer": { "type": "string", "nullable": true }, "valorDetran": { "type": "string", "nullable": true }, "valorCetesb": { "type": "string", "nullable": true }, "valorRenainf": { "type": "string", "nullable": true }, "valorMunicipais": { "type": "string", "nullable": true }, "valorPoliciaRodoviariaFederal": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Decisao": { "type": "object", "properties": { "codigoSituacao": { "type": "string", "nullable": true }, "descricao": { "type": "string", "nullable": true }, "resultado": { "type": "string", "nullable": true }, "layout": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DecisaoAcertaCompletoPF": { "type": "object", "properties": { "codigoSituacao": { "type": "string", "nullable": true }, "descricao": { "type": "string", "nullable": true }, "resultado": { "type": "string", "nullable": true }, "layout": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DecisaoDefineLimitePositivoPJ": { "type": "object", "properties": { "codigoSituacao": { "type": "string", "nullable": true }, "descricao": { "type": "string", "nullable": true }, "resultado": { "type": "string", "nullable": true }, "layout": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DecisaoPF": { "type": "object", "properties": { "codigoSituacao": { "type": "string", "nullable": true }, "descricao": { "type": "string", "nullable": true }, "resultado": { "type": "string", "nullable": true }, "layout": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DefineLimitePositivoRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/BoaVistaDefineLimitePositivoPessoaJuridica" } }, "additionalProperties": false }, "Descricao": { "type": "object", "properties": { "cabelo": { "type": "string", "nullable": true }, "altura": { "type": "string", "nullable": true }, "peso": { "type": "string", "nullable": true }, "olhos": { "type": "string", "nullable": true }, "corPele": { "type": "string", "nullable": true }, "cicatrizes": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Destinatario": { "type": "object", "properties": { "documento": { "type": "string", "nullable": true }, "nomeEntidade": { "type": "string", "nullable": true }, "inscricaoEstadual": { "type": "string", "nullable": true }, "indicadorIE": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "endereco": { "$ref": "#/components/schemas/EnderecoNFe" } }, "additionalProperties": false }, "DetalhamentoAcordo": { "type": "object", "properties": { "dataInicioAcordo": { "type": "string", "nullable": true }, "dataFimAcordo": { "type": "string", "nullable": true }, "orgaoResponsavel": { "type": "string", "nullable": true }, "situacaoAcordo": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DetalhamentoDTO": { "type": "object", "properties": { "dataInicio": { "type": "string", "nullable": true }, "dataFim": { "type": "string", "nullable": true }, "detalhamento": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DetalhamentoNegativoEntidades": { "type": "object", "properties": { "dataConsulta": { "type": "string", "nullable": true }, "documentoConsultado": { "type": "string", "nullable": true }, "pessoaFisica": { "$ref": "#/components/schemas/DetalhamentoNegativoPF" }, "pessoaJuridica": { "$ref": "#/components/schemas/DetalhamentoNegativoPJ" }, "observacao": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DetalhamentoNegativoPF": { "type": "object", "properties": { "pendenciaFinanceira": { "$ref": "#/components/schemas/PendenciaFinanceira" } }, "additionalProperties": false }, "DetalhamentoNegativoPJ": { "type": "object", "properties": { "pendenciaFinanceira": { "$ref": "#/components/schemas/PendenciaFinanceira" } }, "additionalProperties": false }, "DetalhamentoNegativoRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/DetalhamentoNegativoEntidades" } }, "additionalProperties": false }, "DetalhamentoSancao": { "type": "object", "properties": { "categoria": { "type": "string", "nullable": true }, "dataReferencia": { "type": "string", "nullable": true }, "dataInicio": { "type": "string", "nullable": true }, "dataFim": { "type": "string", "nullable": true }, "dataTransitadoJulgado": { "type": "string", "nullable": true }, "dataOrigemInformacao": { "type": "string", "nullable": true }, "fonte": { "$ref": "#/components/schemas/Fonte" }, "numeroProcesso": { "type": "string", "nullable": true }, "abrangenciaDefinidaDecisaoJudicial": { "type": "string", "nullable": true }, "observacao": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DetalhamentoSancaoCEAF": { "type": "object", "properties": { "dataReferencia": { "type": "string", "nullable": true }, "cargoEfetivo": { "type": "string", "nullable": true }, "cargoComissao": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DetalhamentoSancaoCEPIM": { "type": "object", "properties": { "dataReferencia": { "type": "string", "nullable": true }, "motivo": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DetalhamentoSancaoCNEP": { "type": "object", "properties": { "categoria": { "type": "string", "nullable": true }, "dataReferencia": { "type": "string", "nullable": true }, "dataInicio": { "type": "string", "nullable": true }, "dataFim": { "type": "string", "nullable": true }, "dataTransitadoJulgado": { "type": "string", "nullable": true }, "dataOrigemInformacao": { "type": "string", "nullable": true }, "fonte": { "$ref": "#/components/schemas/Fonte" }, "numeroProcesso": { "type": "string", "nullable": true }, "abrangenciaDefinidaDecisaoJudicial": { "type": "string", "nullable": true }, "observacao": { "type": "string", "nullable": true }, "valorMulta": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DetalheEmprestimo": { "type": "object", "properties": { "total": { "type": "number", "format": "double", "nullable": true }, "vencimentoExpirado": { "$ref": "#/components/schemas/MontanteVencimentoContrato" }, "vencimentoDevedor": { "$ref": "#/components/schemas/MontanteVencimentoContrato" } }, "additionalProperties": false }, "DetalhesConsulta": { "type": "object", "properties": { "data": { "type": "string", "nullable": true }, "quantidadeConsultada": { "type": "integer", "format": "int32", "nullable": true }, "segmentoEmpresa": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DetalhesStatusJulgamentos": { "type": "object", "properties": { "tipoJulgamento": { "type": "string", "nullable": true }, "statusJulgamento": { "type": "string", "nullable": true }, "dataJulgamento": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DetalhesStatusPenhora": { "type": "object", "properties": { "dataPenhora": { "type": "string", "nullable": true }, "tipoPenhora": { "type": "string", "nullable": true }, "trechoDecisao": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DetalhesStatusProcesso": { "type": "object", "properties": { "statusDetalhes": { "type": "string", "nullable": true }, "dataArquivamento": { "type": "string", "nullable": true }, "dataTransitoJulgado": { "type": "string", "nullable": true }, "julgamentos": { "type": "array", "items": { "$ref": "#/components/schemas/DetalhesStatusJulgamentos" }, "nullable": true }, "penhoras": { "type": "array", "items": { "$ref": "#/components/schemas/DetalhesStatusPenhora" }, "nullable": true } }, "additionalProperties": false }, "DistribuicaoTJ": { "type": "object", "properties": { "data": { "type": "string", "nullable": true }, "distribuicao": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DocumentoBasica": { "type": "object", "properties": { "documento": { "type": "string", "nullable": true }, "numeroTotalProtestos": { "type": "integer", "format": "int32", "nullable": true }, "valorTotalProtestos": { "type": "string", "nullable": true }, "quantidadeCartoriosDistintos": { "type": "integer", "format": "int32", "nullable": true }, "quantidadeCidadesDistintas": { "type": "integer", "format": "int32", "nullable": true }, "titulos": { "type": "array", "items": { "$ref": "#/components/schemas/TituloBasica" }, "nullable": true } }, "additionalProperties": false }, "DocumentoCompleta": { "type": "object", "properties": { "documento": { "type": "string", "nullable": true }, "numeroTotalProtestos": { "type": "integer", "format": "int32", "nullable": true }, "valorTotalProtestos": { "type": "string", "nullable": true }, "quantidadeCartoriosDistintos": { "type": "integer", "format": "int32", "nullable": true }, "quantidadeCidadesDistintas": { "type": "integer", "format": "int32", "nullable": true }, "cartorios": { "type": "array", "items": { "$ref": "#/components/schemas/CartorioCompleta" }, "nullable": true } }, "additionalProperties": false }, "DomicilioEleitoral": { "type": "object", "properties": { "proximaEleicao": { "type": "string", "nullable": true }, "zona": { "type": "integer", "format": "int32", "nullable": true }, "secao": { "type": "integer", "format": "int32", "nullable": true }, "local": { "type": "string", "nullable": true }, "logradouro": { "type": "string", "nullable": true }, "numero": { "type": "string", "nullable": true }, "bairro": { "type": "string", "nullable": true }, "municipio": { "type": "string", "nullable": true }, "uf": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DossieCreditoCompleto": { "type": "object", "properties": { "documentoConsultado": { "type": "string", "nullable": true }, "entidadeJuridica": { "$ref": "#/components/schemas/EntidadeJuridica" }, "entidadeFisica": { "$ref": "#/components/schemas/EntidadeFisica" }, "observacao": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DossieCreditoCompletoRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/DossieCreditoCompleto" } }, "additionalProperties": false }, "DuplicataNFe": { "type": "object", "properties": { "indicador": { "type": "string", "nullable": true }, "formaPagamento": { "type": "string", "nullable": true }, "descricao": { "type": "string", "nullable": true }, "dataPagamento": { "type": "string", "nullable": true }, "valor": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EUFinancialList": { "type": "object", "properties": { "nomeConsultado": { "type": "string", "nullable": true }, "resultadosEncontrados": { "type": "integer", "format": "int32" }, "observacoes": { "type": "string", "nullable": true }, "sancoes": { "type": "array", "items": { "$ref": "#/components/schemas/SancaoEntidade" }, "nullable": true } }, "additionalProperties": false }, "Email": { "type": "object", "properties": { "enderecoEmail": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EmailE": { "type": "object", "properties": { "emailAddress": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Embargos": { "type": "object", "properties": { "sequenciaTAD": { "type": "string", "nullable": true }, "numeroTAD": { "type": "string", "nullable": true }, "serieTAD": { "type": "string", "nullable": true }, "areaEmbargada": { "type": "string", "nullable": true }, "dataEmbargo": { "type": "string", "nullable": true }, "dataInsercaoLista": { "type": "string", "nullable": true }, "uf": { "type": "string", "nullable": true }, "municipio": { "type": "string", "nullable": true }, "numeroAI": { "type": "string", "nullable": true }, "serieAI": { "type": "string", "nullable": true }, "areaDesmatada": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EmissorDAP": { "type": "object", "properties": { "emissor": { "type": "string", "nullable": true }, "cnpj": { "type": "string", "nullable": true }, "nome": { "type": "string", "nullable": true }, "cpf": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Emitente": { "type": "object", "properties": { "cnpj": { "type": "string", "nullable": true }, "razaoSocial": { "type": "string", "nullable": true }, "nomeFantasia": { "type": "string", "nullable": true }, "inscricaoEstadual": { "type": "string", "nullable": true }, "endereco": { "$ref": "#/components/schemas/EnderecoNFe" } }, "additionalProperties": false }, "Empresa": { "type": "object", "properties": { "dataConsulta": { "type": "string", "nullable": true }, "cnpj": { "type": "string", "nullable": true }, "razaoSocial": { "type": "string", "nullable": true }, "quantidadeFuncionarios": { "type": "integer", "format": "int32", "nullable": true }, "funcionarios": { "type": "array", "items": { "$ref": "#/components/schemas/Funcionario" }, "nullable": true } }, "additionalProperties": false }, "EmpresaDCC": { "type": "object", "properties": { "documento": { "type": "string", "nullable": true }, "dataFundacao": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EmpresaParticipacaoDefineLimitePositivoPJ": { "type": "object", "properties": { "razaoSocial": { "type": "string", "nullable": true }, "cnpj": { "type": "string", "nullable": true }, "situacaoCnpj": { "type": "string", "nullable": true }, "participacao": { "type": "string", "nullable": true }, "indicadorDebito": { "type": "string", "nullable": true }, "indicadorFraude": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Emprestimo": { "type": "object", "properties": { "tipoRelacionamento": { "type": "string", "nullable": true }, "numeroContrato": { "type": "string", "nullable": true }, "dataContratacao": { "type": "string", "nullable": true }, "tipoContratacao": { "type": "string", "nullable": true }, "dataAtualizacao": { "type": "string", "nullable": true }, "detalheEmprestimo": { "$ref": "#/components/schemas/DetalheEmprestimo" }, "dataVencimento": { "type": "string", "nullable": true }, "valorTotal": { "type": "number", "format": "double", "nullable": true }, "quantidadeParcelas": { "type": "integer", "format": "int32", "nullable": true }, "parcelasAnteriores": { "type": "array", "items": { "$ref": "#/components/schemas/ParcelaAnterior" }, "nullable": true }, "pagamentosDesanexados": { "type": "array", "items": { "$ref": "#/components/schemas/PagamentoDesanexado" }, "nullable": true }, "parcelasFuturas": { "type": "array", "items": { "$ref": "#/components/schemas/ParcelaFutura" }, "nullable": true } }, "additionalProperties": false }, "Endereco": { "type": "object", "properties": { "logradouro": { "type": "string", "nullable": true }, "numero": { "type": "string", "nullable": true }, "complemento": { "type": "string", "nullable": true }, "bairro": { "type": "string", "nullable": true }, "cidade": { "type": "string", "nullable": true }, "uf": { "type": "string", "nullable": true }, "cep": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EnderecoDAP": { "type": "object", "properties": { "logradouro": { "type": "string", "nullable": true }, "numero": { "type": "string", "nullable": true }, "bairro": { "type": "string", "nullable": true }, "cep": { "type": "string", "nullable": true }, "municipio": { "type": "string", "nullable": true }, "tipo": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EnderecoDCC": { "type": "object", "properties": { "logradouro": { "type": "string", "nullable": true }, "numero": { "type": "string", "nullable": true }, "complemento": { "type": "string", "nullable": true }, "bairro": { "type": "string", "nullable": true }, "cidade": { "type": "string", "nullable": true }, "uf": { "type": "string", "nullable": true }, "cep": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EnderecoDN": { "type": "object", "properties": { "logradouro": { "type": "string", "nullable": true }, "numero": { "type": "string", "nullable": true }, "complemento": { "type": "string", "nullable": true }, "bairro": { "type": "string", "nullable": true }, "cidade": { "type": "string", "nullable": true }, "uf": { "type": "string", "nullable": true }, "cep": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EnderecoNFe": { "type": "object", "properties": { "logradouro": { "type": "string", "nullable": true }, "numero": { "type": "string", "nullable": true }, "bairro": { "type": "string", "nullable": true }, "municipio": { "type": "string", "nullable": true }, "uf": { "type": "string", "nullable": true }, "cep": { "type": "string", "nullable": true }, "telefone": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EnderecoProfissional": { "type": "object", "properties": { "logradouro": { "type": "string", "nullable": true }, "numero": { "type": "string", "nullable": true }, "complemento": { "type": "string", "nullable": true }, "bairro": { "type": "string", "nullable": true }, "cidade": { "type": "string", "nullable": true }, "cep": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EnderecoSancao": { "type": "object", "properties": { "endereco": { "type": "string", "nullable": true }, "pais": { "type": "string", "nullable": true }, "cidade": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EnderecoSancoesUtils": { "type": "object", "properties": { "endereco": { "type": "string", "nullable": true }, "cidade": { "type": "string", "nullable": true }, "estado": { "type": "string", "nullable": true }, "codigoPostal": { "type": "string", "nullable": true }, "pais": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EnriquecimentoLead": { "type": "object", "properties": { "cpf": { "type": "string", "nullable": true }, "nome": { "type": "string", "nullable": true }, "sexo": { "type": "string", "nullable": true }, "dataNascimento": { "type": "string", "nullable": true }, "nomeMae": { "type": "string", "nullable": true }, "idade": { "type": "integer", "format": "int32", "nullable": true }, "signo": { "type": "string", "nullable": true }, "telefones": { "type": "array", "items": { "$ref": "#/components/schemas/Telefone" }, "nullable": true }, "enderecos": { "type": "array", "items": { "$ref": "#/components/schemas/Endereco" }, "nullable": true }, "emails": { "type": "array", "items": { "$ref": "#/components/schemas/Email" }, "nullable": true }, "rendaEstimada": { "type": "string", "nullable": true }, "rendaFaixaSalarial": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EnriquecimentoLeadRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/EnriquecimentoLead" } }, "additionalProperties": false }, "EntidadeFisica": { "type": "object", "properties": { "statusCadastroPositivo": { "type": "string", "nullable": true }, "segmentoCadastroPositivo": { "type": "string", "nullable": true }, "dadosCadastrais": { "$ref": "#/components/schemas/DadoPessoal" }, "dadosEmpresariais": { "type": "array", "items": { "$ref": "#/components/schemas/DadoEmpresarial" }, "nullable": true }, "scoreEntidade": { "$ref": "#/components/schemas/ScoreEntidadeDCC" }, "pendenciaFinanceira": { "$ref": "#/components/schemas/PendenciaFinanceiraDCC" }, "consulta": { "$ref": "#/components/schemas/ConsultaDCC" }, "frequenciaPagamentos": { "type": "array", "items": { "$ref": "#/components/schemas/FrequenciaPagamento" }, "nullable": true } }, "additionalProperties": false }, "EntidadeJuridica": { "type": "object", "properties": { "statusCadastroPositivo": { "type": "string", "nullable": true }, "dadosCadastrais": { "$ref": "#/components/schemas/DadosCadastrais" }, "quadroSocietario": { "$ref": "#/components/schemas/QuadroSocietario" }, "scoreEntidades": { "$ref": "#/components/schemas/ScoreEntidadeDCC" }, "pendenciaFinanceira": { "$ref": "#/components/schemas/PendenciaFinanceiraDCC" }, "indicadores": { "$ref": "#/components/schemas/Indicadores" }, "consulta": { "$ref": "#/components/schemas/ConsultaDCC" }, "conglomerado": { "$ref": "#/components/schemas/ConsultasConglomerado" }, "dadosEmpresariais": { "type": "array", "items": { "$ref": "#/components/schemas/DadoEmpresarial" }, "nullable": true } }, "additionalProperties": false }, "EstruturaSocietariaDefineLimitePositivoPJ": { "type": "object", "properties": { "nome": { "type": "string", "nullable": true }, "documento": { "type": "string", "nullable": true }, "percentualParticipacao": { "type": "string", "nullable": true }, "tipoDocumento": { "type": "string", "nullable": true }, "situacaoDocumento": { "type": "string", "nullable": true }, "restricoes": { "type": "array", "items": { "$ref": "#/components/schemas/RestricaoSocioDefineLimitePositivoPJ" }, "nullable": true } }, "additionalProperties": false }, "EstruturaSocietária": { "type": "object", "properties": { "nome": { "type": "string", "nullable": true }, "documento": { "type": "string", "nullable": true }, "percentualParticipacao": { "type": "string", "nullable": true }, "tipoDocumento": { "type": "string", "nullable": true }, "situacaoDocumento": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EventoNegocio": { "type": "object", "properties": { "indicador": { "type": "string", "nullable": true }, "periodo": { "type": "string", "nullable": true }, "pontuacao": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EventoNegocioDefineLimitePositivoPJ": { "type": "object", "properties": { "indicador": { "type": "string", "nullable": true }, "periodo": { "type": "string", "nullable": true }, "pontuacao": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Expedicao": { "type": "object", "properties": { "numeroProcesso": { "type": "string", "nullable": true }, "orgao": { "type": "string", "nullable": true }, "data": { "type": "string", "nullable": true }, "dataValidade": { "type": "string", "nullable": true }, "especiePrisao": { "type": "string", "nullable": true }, "municipio": { "type": "string", "nullable": true }, "magistrado": { "type": "string", "nullable": true }, "tipificacoesPenais": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "FBIMostWanted": { "type": "object", "properties": { "nomeConsultado": { "type": "string", "nullable": true }, "resultadosEncontrados": { "type": "integer", "format": "int32" }, "observacoes": { "type": "string", "nullable": true }, "pessoas": { "type": "array", "items": { "$ref": "#/components/schemas/FBIPessoa" }, "nullable": true } }, "additionalProperties": false }, "FBIMostWantedRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/FBIMostWanted" } }, "additionalProperties": false }, "FBIPessoa": { "type": "object", "properties": { "alcunha": { "type": "array", "items": { "type": "string" }, "nullable": true }, "nomeCompleto": { "type": "string", "nullable": true }, "datasNascimentoUsadas": { "type": "array", "items": { "type": "string" }, "nullable": true }, "localNascimento": { "type": "string", "nullable": true }, "nacionalidade": { "type": "string", "nullable": true }, "sexo": { "type": "string", "nullable": true }, "ocupacao": { "type": "string", "nullable": true }, "descricao": { "$ref": "#/components/schemas/Descricao" }, "linguasFaladas": { "type": "array", "items": { "type": "string" }, "nullable": true }, "recompensa": { "type": "string", "nullable": true }, "observacao": { "type": "string", "nullable": true }, "cautela": { "type": "string", "nullable": true }, "detalhes": { "type": "string", "nullable": true }, "atencao": { "type": "string", "nullable": true }, "fotos": { "type": "array", "items": { "type": "string" }, "nullable": true }, "poster": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FalenciaOcorrenciaAcertaCompletoPF": { "type": "object", "properties": { "tipo": { "type": "string", "nullable": true }, "quantidade": { "type": "string", "nullable": true }, "cartorio": { "type": "string", "nullable": true }, "data": { "type": "string", "nullable": true }, "origem": { "type": "string", "nullable": true }, "valor": { "type": "string", "nullable": true }, "documento": { "type": "string", "nullable": true }, "razaoSocial": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FalenciaOcorrenciaPF": { "type": "object", "properties": { "tipo": { "type": "string", "nullable": true }, "quantidade": { "type": "string", "nullable": true }, "cartorio": { "type": "string", "nullable": true }, "data": { "type": "string", "nullable": true }, "origem": { "type": "string", "nullable": true }, "valor": { "type": "string", "nullable": true }, "documento": { "type": "string", "nullable": true }, "razaoSocial": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FalenciaRecuperacaoDetalhe": { "type": "object", "properties": { "tipo": { "type": "string", "nullable": true }, "data": { "type": "string", "nullable": true }, "origem": { "type": "string", "nullable": true }, "vara": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FalenciaRecuperacaoDetalheDefineLimitePositivoPJ": { "type": "object", "properties": { "tipo": { "type": "string", "nullable": true }, "data": { "type": "string", "nullable": true }, "origem": { "type": "string", "nullable": true }, "vara": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FalenciaRecuperacaoResumo": { "type": "object", "properties": { "quantidade": { "type": "string", "nullable": true }, "periodoInicial": { "type": "string", "nullable": true }, "periodoFinal": { "type": "string", "nullable": true }, "ocorrencias": { "type": "array", "items": { "$ref": "#/components/schemas/FalenciaRecuperacaoDetalhe" }, "nullable": true } }, "additionalProperties": false }, "FalenciaRecuperacaoResumoDefineLimitePositivoPJ": { "type": "object", "properties": { "quantidade": { "type": "string", "nullable": true }, "periodoInicial": { "type": "string", "nullable": true }, "periodoFinal": { "type": "string", "nullable": true }, "ocorrencias": { "type": "array", "items": { "$ref": "#/components/schemas/FalenciaRecuperacaoDetalheDefineLimitePositivoPJ" }, "nullable": true } }, "additionalProperties": false }, "FalenciasAcoesRecuperacoesAcertaCompletoPF": { "type": "object", "properties": { "quantidadeOcorrencia": { "type": "string", "nullable": true }, "valorTotal": { "type": "string", "nullable": true }, "ultimoRegistro": { "type": "string", "nullable": true }, "ocorrencias": { "type": "array", "items": { "$ref": "#/components/schemas/FalenciaOcorrenciaAcertaCompletoPF" }, "nullable": true } }, "additionalProperties": false }, "FalenciasAcoesRecuperacoesPF": { "type": "object", "properties": { "quantidadeOcorrencia": { "type": "string", "nullable": true }, "valorTotal": { "type": "string", "nullable": true }, "ultimoRegistro": { "type": "string", "nullable": true }, "ocorrencias": { "type": "array", "items": { "$ref": "#/components/schemas/FalenciaOcorrenciaPF" }, "nullable": true } }, "additionalProperties": false }, "FaturadoVeiculo": { "type": "object", "properties": { "documento": { "type": "string", "nullable": true }, "tipo": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FaturamentoPresumidoResumo": { "type": "object", "properties": { "faixa": { "type": "string", "nullable": true }, "faturamentoAnual": { "type": "string", "nullable": true }, "mensagem": { "type": "string", "nullable": true }, "dataReferencia": { "type": "string", "nullable": true }, "valorPresumido": { "type": "string", "nullable": true }, "dadosCadastroPositivo": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FaturamentoPresumidoResumoDefineLimitePositivoPJ": { "type": "object", "properties": { "faixa": { "type": "string", "nullable": true }, "faturamentoAnual": { "type": "string", "nullable": true }, "mensagem": { "type": "string", "nullable": true }, "dataReferencia": { "type": "string", "nullable": true }, "valorPresumido": { "type": "string", "nullable": true }, "dadosCadastroPositivo": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FichaFuncional": { "type": "object", "properties": { "tipoFicha": { "type": "string", "nullable": true }, "situacaoServidor": { "type": "string", "nullable": true }, "regimeJuridico": { "type": "string", "nullable": true }, "jornadaTrabalho": { "type": "string", "nullable": true }, "cargo": { "type": "string", "nullable": true }, "classeCargo": { "type": "string", "nullable": true }, "padraoCargo": { "type": "string", "nullable": true }, "nivelCargo": { "type": "string", "nullable": true }, "funcao": { "type": "string", "nullable": true }, "atividade": { "type": "string", "nullable": true }, "opcaoFuncao": { "type": "string", "nullable": true }, "formaIngresso": { "type": "string", "nullable": true }, "diplomaLegal": { "type": "string", "nullable": true }, "dataPublicacaoDocumentoIngresso": { "type": "string", "nullable": true }, "dataIngressoCargo": { "type": "string", "nullable": true }, "dataIngressoFuncao": { "type": "string", "nullable": true }, "dataIngressoOrgao": { "type": "string", "nullable": true }, "dataIngressoServicoPublico": { "type": "string", "nullable": true }, "orgaoSuperiorLotacao": { "type": "string", "nullable": true }, "orgaoLotacao": { "type": "string", "nullable": true }, "uorgLotacao": { "type": "string", "nullable": true }, "orgaoSuperiorExercicio": { "type": "string", "nullable": true }, "orgaoExercicio": { "type": "string", "nullable": true }, "uorgExercicio": { "type": "string", "nullable": true }, "ufExercicio": { "type": "string", "nullable": true }, "afastamentos": { "type": "array", "items": { "type": "string" }, "nullable": true }, "tipoAposentadoria": { "type": "string", "nullable": true }, "fundamentacaoAposentadoria": { "type": "string", "nullable": true }, "dataAposentadoria": { "type": "string", "nullable": true }, "dataReforma": { "type": "string", "nullable": true }, "tipoPensao": { "type": "string", "nullable": true }, "fundamentacaoPensao": { "type": "string", "nullable": true }, "dataInicioPensao": { "type": "string", "nullable": true }, "proporcaoPensao": { "type": "string", "nullable": true }, "representanteLegal": { "type": "string", "nullable": true }, "cpfRepresentanteLegal": { "type": "string", "nullable": true }, "nomeInstituidor": { "type": "string", "nullable": true }, "cpfInstituidor": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FieldConfidenceEntity": { "type": "object", "properties": { "provided": { "type": "string", "nullable": true }, "confidence": { "type": "integer", "format": "int32", "nullable": true }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Filial": { "type": "object", "properties": { "cnpj": { "type": "string", "nullable": true }, "razaoSocial": { "type": "string", "nullable": true }, "uf": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FinCEN": { "type": "object", "properties": { "numeroMSB": { "type": "string", "nullable": true }, "razaoSocial": { "type": "string", "nullable": true }, "nomeFantasia": { "type": "string", "nullable": true }, "dataAssinaturaAutorizada": { "type": "string", "nullable": true }, "dataRecebimento": { "type": "string", "nullable": true }, "quantidadeFiliais": { "type": "integer", "format": "int32", "nullable": true }, "servicoMonetario": { "$ref": "#/components/schemas/ServicoMonetario" }, "localizacao": { "$ref": "#/components/schemas/EnderecoSancoesUtils" } }, "additionalProperties": false }, "FinCENRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/RetornoFinCEN" } }, "additionalProperties": false }, "Fonte": { "type": "object", "properties": { "nome": { "type": "string", "nullable": true }, "telefone": { "type": "string", "nullable": true }, "endereco": { "type": "string", "nullable": true }, "dadosPublicacao": { "$ref": "#/components/schemas/DadosPublicacao" } }, "additionalProperties": false }, "ForoTJ": { "type": "object", "properties": { "foro": { "type": "string", "nullable": true }, "resumoProcessos": { "type": "array", "items": { "$ref": "#/components/schemas/ResumoProcesso" }, "nullable": true }, "dadosProcesso": { "$ref": "#/components/schemas/ProcessoPrimeiroGrau" } }, "additionalProperties": false }, "FrequenciaPagamento": { "type": "object", "properties": { "emprestimos": { "type": "array", "items": { "$ref": "#/components/schemas/Emprestimo" }, "nullable": true }, "rotativos": { "type": "array", "items": { "$ref": "#/components/schemas/Rotativo" }, "nullable": true }, "cartoesCredito": { "type": "array", "items": { "$ref": "#/components/schemas/CartaoCredito" }, "nullable": true }, "consorcios": { "type": "array", "items": { "$ref": "#/components/schemas/Consorcio" }, "nullable": true }, "unicoCNPJEmprestimos": { "type": "integer", "format": "int32", "nullable": true }, "unicoCNPJRotativo": { "type": "integer", "format": "int32", "nullable": true }, "unicoCNPJCartoesCredito": { "type": "integer", "format": "int32", "nullable": true }, "unicoCNPJConsorcios": { "type": "integer", "format": "int32", "nullable": true }, "unicoCNPJTotal": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "Funcionario": { "type": "object", "properties": { "cpf": { "type": "string", "nullable": true }, "nome": { "type": "string", "nullable": true }, "dataNascimento": { "type": "string", "nullable": true }, "codigoCBO": { "type": "string", "nullable": true }, "descricaoCBO": { "type": "string", "nullable": true }, "dataAdmissao": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GarantiaSafra": { "type": "object", "properties": { "nome": { "type": "string", "nullable": true }, "nis": { "type": "string", "nullable": true }, "cpf": { "type": "string", "nullable": true }, "beneficios": { "type": "array", "items": { "$ref": "#/components/schemas/Safra" }, "nullable": true } }, "additionalProperties": false }, "GarantiaSafraRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/GarantiaSafra" } }, "additionalProperties": false }, "GasDoPovo": { "type": "object", "properties": { "nome": { "type": "string", "nullable": true }, "cpf": { "type": "string", "nullable": true }, "vales": { "type": "array", "items": { "$ref": "#/components/schemas/ValeGas" }, "nullable": true } }, "additionalProperties": false }, "GasDoPovoRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/GasDoPovo" } }, "additionalProperties": false }, "Governanca": { "type": "object", "properties": { "quantidadeAdministradores": { "type": "string", "nullable": true }, "administradores": { "type": "array", "items": { "$ref": "#/components/schemas/Administrador" }, "nullable": true }, "quantidadeSocios": { "type": "string", "nullable": true }, "socios": { "type": "array", "items": { "$ref": "#/components/schemas/EstruturaSocietária" }, "nullable": true } }, "additionalProperties": false }, "GovernancaDefineLimitePositivoPJ": { "type": "object", "properties": { "quantidadeAdministradores": { "type": "string", "nullable": true }, "administradores": { "type": "array", "items": { "$ref": "#/components/schemas/AdministradorDefineLimitePositivoPJ" }, "nullable": true }, "quantidadeSocios": { "type": "string", "nullable": true }, "socios": { "type": "array", "items": { "$ref": "#/components/schemas/EstruturaSocietariaDefineLimitePositivoPJ" }, "nullable": true } }, "additionalProperties": false }, "GravameInfo": { "type": "object", "properties": { "documentoProprietarioAtual": { "type": "string", "nullable": true }, "nomeFinanciado": { "type": "string", "nullable": true }, "numeroContrato": { "type": "string", "nullable": true }, "documentoFinanceira": { "type": "string", "nullable": true }, "financeiraNome": { "type": "string", "nullable": true }, "codigoFinanceira": { "type": "string", "nullable": true }, "ufGravame": { "type": "string", "nullable": true }, "dataGravame": { "type": "string", "nullable": true }, "dataGravameVigencia": { "type": "string", "nullable": true }, "dataLimiteRestricaoTributaria": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GuiaRecolhimento": { "type": "object", "properties": { "codigoPagamento": { "type": "string", "nullable": true }, "situacao": { "type": "string", "nullable": true }, "dataPagamento": { "type": "string", "nullable": true }, "valorPago": { "type": "string", "nullable": true }, "origemPagamento": { "type": "string", "nullable": true }, "numero": { "type": "string", "nullable": true } }, "additionalProperties": false }, "HistoricoConsultaDetalhe": { "type": "object", "properties": { "data": { "type": "string", "nullable": true }, "razaoSocial": { "type": "string", "nullable": true }, "cnpj": { "type": "string", "nullable": true } }, "additionalProperties": false }, "HistoricoConsultaDetalheDefineLimitePositivoPJ": { "type": "object", "properties": { "data": { "type": "string", "nullable": true }, "razaoSocial": { "type": "string", "nullable": true }, "cnpj": { "type": "string", "nullable": true } }, "additionalProperties": false }, "HistoricoConsultas": { "type": "object", "properties": { "quantidadeOcorrencias": { "type": "string", "nullable": true }, "dataInicial": { "type": "string", "nullable": true }, "dataFinal": { "type": "string", "nullable": true }, "detalhes": { "type": "array", "items": { "$ref": "#/components/schemas/HistoricoConsultaDetalhe" }, "nullable": true } }, "additionalProperties": false }, "HistoricoConsultasDefineLimitePositivoPJ": { "type": "object", "properties": { "quantidadeOcorrencias": { "type": "string", "nullable": true }, "dataInicial": { "type": "string", "nullable": true }, "dataFinal": { "type": "string", "nullable": true }, "detalhes": { "type": "array", "items": { "$ref": "#/components/schemas/HistoricoConsultaDetalheDefineLimitePositivoPJ" }, "nullable": true } }, "additionalProperties": false }, "HistoricoEmpregador": { "type": "object", "properties": { "dataEmissao": { "type": "string", "nullable": true }, "numeroCrf": { "type": "string", "nullable": true }, "periodoValidade": { "$ref": "#/components/schemas/Periodo" } }, "additionalProperties": false }, "HistoricoProprietarioRegistro": { "type": "object", "properties": { "placa": { "type": "string", "nullable": true }, "placaMercosul": { "type": "string", "nullable": true }, "chassi": { "type": "string", "nullable": true }, "marcaModelo": { "type": "string", "nullable": true }, "documento": { "type": "string", "nullable": true }, "tipoDocumento": { "type": "string", "nullable": true }, "nomeRazaoSocial": { "type": "string", "nullable": true }, "ano": { "type": "integer", "format": "int32", "nullable": true }, "dataTransferencia": { "type": "string", "nullable": true }, "uf": { "type": "string", "nullable": true }, "municipio": { "type": "string", "nullable": true } }, "additionalProperties": false }, "HistoricoVeiculo": { "type": "object", "properties": { "placa": { "type": "string", "nullable": true }, "veiculo": { "type": "string", "nullable": true }, "marca": { "type": "string", "nullable": true }, "modelo": { "type": "string", "nullable": true }, "renavam": { "type": "string", "nullable": true }, "chassi": { "type": "string", "nullable": true }, "dataAquisicao": { "type": "string", "nullable": true } }, "additionalProperties": false }, "HistoricoVeiculoNacional": { "type": "object", "properties": { "placa": { "type": "string", "nullable": true }, "chassi": { "type": "string", "nullable": true }, "marcaModelo": { "type": "string", "nullable": true }, "ano": { "type": "integer", "format": "int32", "nullable": true }, "municipio": { "type": "string", "nullable": true }, "uf": { "type": "string", "nullable": true } }, "additionalProperties": false }, "HistoricoVeiculos": { "type": "object", "properties": { "documento": { "type": "string", "nullable": true }, "proprietario": { "type": "string", "nullable": true }, "veiculos": { "type": "array", "items": { "$ref": "#/components/schemas/HistoricoVeiculo" }, "nullable": true }, "enderecos": { "type": "array", "items": { "$ref": "#/components/schemas/Endereco" }, "nullable": true } }, "additionalProperties": false }, "HistoricoVeiculosNacional": { "type": "object", "properties": { "documento": { "type": "string", "nullable": true }, "proprietario": { "type": "string", "nullable": true }, "quantidadeVeiculos": { "type": "integer", "format": "int32", "nullable": true }, "veiculos": { "type": "array", "items": { "$ref": "#/components/schemas/HistoricoVeiculoNacional" }, "nullable": true } }, "additionalProperties": false }, "HistoricoVeiculosNacionalRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/HistoricoVeiculosNacional" } }, "additionalProperties": false }, "HistoricoVeiculosRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/HistoricoVeiculos" } }, "additionalProperties": false }, "HonorarioAdvocaticio": { "type": "object", "properties": { "mesReferencia": { "type": "string", "nullable": true }, "valor": { "type": "string", "nullable": true } }, "additionalProperties": false }, "IBAMACertidaoNegativaDebitos": { "type": "object", "properties": { "documentoConsultado": { "type": "string", "nullable": true }, "nome": { "type": "string", "nullable": true }, "dataEmissao": { "type": "string", "nullable": true }, "dataValidade": { "type": "string", "nullable": true }, "numero": { "type": "integer", "format": "int32", "nullable": true }, "possuiDebito": { "type": "boolean", "nullable": true }, "efeitoNegativo": { "type": "boolean", "nullable": true }, "status": { "type": "string", "nullable": true }, "debitos": { "type": "array", "items": { "$ref": "#/components/schemas/DebitoIbama" }, "nullable": true } }, "additionalProperties": false }, "IBAMACertidaoNegativaDebitosRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/IBAMACertidaoNegativaDebitos" } }, "additionalProperties": false }, "IBAMACertidaoNegativaEmbargoRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/IBAMACertidaoNegativaEmbargos" } }, "additionalProperties": false }, "IBAMACertidaoNegativaEmbargos": { "type": "object", "properties": { "documento": { "type": "string", "nullable": true }, "nome": { "type": "string", "nullable": true }, "endereco": { "type": "string", "nullable": true }, "numeroCertidao": { "type": "string", "nullable": true }, "dataEmissao": { "type": "string", "nullable": true }, "dataValidade": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "possuiEmbargo": { "type": "boolean", "nullable": true }, "embargos": { "type": "array", "items": { "$ref": "#/components/schemas/Embargos" }, "nullable": true }, "observacoes": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "IBAMACertificadoRegularidade": { "type": "object", "properties": { "documento": { "type": "string", "nullable": true }, "numeroRegistro": { "type": "string", "nullable": true }, "dataConsulta": { "type": "string", "nullable": true }, "dataEmissao": { "type": "string", "nullable": true }, "dataAbertura": { "type": "string", "nullable": true }, "dataValidade": { "type": "string", "nullable": true }, "nomeEmpresarial": { "type": "string", "nullable": true }, "nomeFantasia": { "type": "string", "nullable": true }, "logradouro": { "type": "string", "nullable": true }, "complemento": { "type": "string", "nullable": true }, "numero": { "type": "integer", "format": "int32", "nullable": true }, "municipio": { "type": "string", "nullable": true }, "bairro": { "type": "string", "nullable": true }, "cep": { "type": "string", "nullable": true }, "uf": { "type": "string", "nullable": true }, "constaCertificado": { "type": "boolean", "nullable": true }, "observacao": { "type": "string", "nullable": true }, "categorias": { "$ref": "#/components/schemas/Categorias" }, "atividades": { "$ref": "#/components/schemas/Atividades" } }, "additionalProperties": false }, "IBAMACertificadoRegularidadeRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/IBAMACertificadoRegularidade" } }, "additionalProperties": false }, "IBAMAConsultaAutuacoesAmbientais": { "type": "object", "properties": { "documentoConsultado": { "type": "string", "nullable": true }, "nomeEntidade": { "type": "string", "nullable": true }, "autuacoes": { "type": "array", "items": { "$ref": "#/components/schemas/AutoInfracao" }, "nullable": true }, "possuiAutuacao": { "type": "boolean", "nullable": true }, "totalAutuacoes": { "type": "integer", "format": "int32", "nullable": true }, "valorTotalMultas": { "type": "string", "nullable": true }, "observacoes": { "type": "string", "nullable": true } }, "additionalProperties": false }, "IBAMAConsultaAutuacoesAmbientaisRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/IBAMAConsultaAutuacoesAmbientais" } }, "additionalProperties": false }, "IBGE": { "type": "object", "properties": { "codigo": { "type": "string", "nullable": true }, "uf": { "type": "string", "nullable": true }, "cidade": { "type": "string", "nullable": true }, "tipo": { "type": "string", "nullable": true }, "dataConsulta": { "type": "string", "nullable": true } }, "additionalProperties": false }, "IRPF": { "type": "object", "properties": { "exercicio": { "type": "integer", "format": "int32", "nullable": true }, "nomeContribuinte": { "type": "string", "nullable": true }, "resultado": { "type": "string", "nullable": true }, "restituicao": { "$ref": "#/components/schemas/Restituicao" }, "debitoAutomatico": { "type": "string", "nullable": true }, "situacao": { "type": "string", "nullable": true }, "observacoes": { "type": "string", "nullable": true }, "fila": { "type": "boolean", "nullable": true }, "tipoDeclaracao": { "type": "string", "nullable": true } }, "additionalProperties": false }, "IRPFRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/IRPF" } }, "additionalProperties": false }, "Identificacao": { "type": "object", "properties": { "inscricao": { "type": "string", "nullable": true }, "eleitor": { "type": "string", "nullable": true } }, "additionalProperties": false }, "IdentityVerificationArgentina": { "type": "object", "properties": { "dni": { "$ref": "#/components/schemas/FieldConfidenceEntity" }, "name": { "$ref": "#/components/schemas/FieldConfidenceEntity" }, "surname": { "$ref": "#/components/schemas/FieldConfidenceEntity" }, "dob": { "$ref": "#/components/schemas/FieldConfidenceEntity" }, "gender": { "$ref": "#/components/schemas/FieldConfidenceEntity" }, "address": { "$ref": "#/components/schemas/FieldConfidenceEntity" }, "city": { "$ref": "#/components/schemas/FieldConfidenceEntity" }, "state": { "$ref": "#/components/schemas/FieldConfidenceEntity" }, "postCode": { "$ref": "#/components/schemas/FieldConfidenceEntity" }, "phone": { "type": "array", "items": { "$ref": "#/components/schemas/FieldConfidenceEntity" }, "nullable": true }, "country": { "$ref": "#/components/schemas/FieldConfidenceEntity" } }, "additionalProperties": false, "description": "Espelho do retorno da LibraryAPI: score de confiança 0-100 + veredicto por campo, no nível\r\nraiz e com todos os campos sempre instanciados (padrão Similarity — sem dado para comparar,\r\nConfidence null + \"NO DATA TO COMPARE\"). Os dados oficiais do registro (RegistryDataEntity)\r\nnão são expostos por ora." }, "IdentityVerificationArgentinaRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/IdentityVerificationArgentina" } }, "additionalProperties": false }, "ImovelDAP": { "type": "object", "properties": { "nome": { "type": "string", "nullable": true }, "localizacao": { "type": "string", "nullable": true }, "tipo": { "type": "string", "nullable": true }, "area": { "type": "string", "nullable": true }, "areaEstabelecimento": { "type": "string", "nullable": true }, "nomeProprietario": { "type": "string", "nullable": true }, "documentoProprietario": { "type": "string", "nullable": true }, "imoveisExplorados": { "type": "integer", "format": "int32", "nullable": true }, "empregados": { "type": "integer", "format": "int32", "nullable": true }, "membrosFamilia": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "ImportacaoVeiculo": { "type": "object", "properties": { "numeroDeclaracao": { "type": "string", "nullable": true }, "data": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ImpostoItem": { "type": "object", "properties": { "baseICMS": { "type": "string", "nullable": true }, "aliquotaICMS": { "type": "string", "nullable": true }, "valorICMS": { "type": "string", "nullable": true }, "pis": { "$ref": "#/components/schemas/PisCofinsNFe" }, "cofins": { "$ref": "#/components/schemas/PisCofinsNFe" } }, "additionalProperties": false }, "Indicador": { "type": "object", "properties": { "conceito": { "type": "string", "nullable": true }, "indicadoresNegocio": { "type": "array", "items": { "$ref": "#/components/schemas/IndicadoreNegocio" }, "nullable": true } }, "additionalProperties": false }, "IndicadorEventosPessoaJuridica": { "type": "object", "properties": { "pontuacao": { "type": "string", "nullable": true }, "ocorrencias": { "type": "array", "items": { "$ref": "#/components/schemas/EventoNegocio" }, "nullable": true } }, "additionalProperties": false }, "IndicadorEventosPessoaJuridicaDefineLimitePositivoPJ": { "type": "object", "properties": { "pontuacao": { "type": "string", "nullable": true }, "ocorrencias": { "type": "array", "items": { "$ref": "#/components/schemas/EventoNegocioDefineLimitePositivoPJ" }, "nullable": true } }, "additionalProperties": false }, "IndicadorNegocio": { "type": "object", "properties": { "indicador": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "risco": { "type": "string", "nullable": true }, "observacao": { "type": "string", "nullable": true } }, "additionalProperties": false }, "IndicadorNegocioDCC": { "type": "object", "properties": { "indicador": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "risco": { "type": "string", "nullable": true }, "observacao": { "type": "string", "nullable": true } }, "additionalProperties": false }, "IndicadorPagamentoAtrasado": { "type": "object", "properties": { "ocorrencias": { "type": "array", "items": { "$ref": "#/components/schemas/PagamentoEmAtraso" }, "nullable": true } }, "additionalProperties": false }, "IndicadorPagamentoAtrasadoDefineLimitePositivoPJ": { "type": "object", "properties": { "ocorrencias": { "type": "array", "items": { "$ref": "#/components/schemas/PagamentoEmAtrasoDefineLimitePositivoPJ" }, "nullable": true } }, "additionalProperties": false }, "IndicadorPeriodoRelacionamento": { "type": "object", "properties": { "pontuacao": { "type": "string", "nullable": true }, "ocorrencias": { "type": "array", "items": { "$ref": "#/components/schemas/PeriodoValor" }, "nullable": true } }, "additionalProperties": false }, "IndicadorPeriodoRelacionamentoDefineLimitePositivoPJ": { "type": "object", "properties": { "pontuacao": { "type": "string", "nullable": true }, "ocorrencias": { "type": "array", "items": { "$ref": "#/components/schemas/PeriodoValorDefineLimitePositivoPJ" }, "nullable": true } }, "additionalProperties": false }, "IndicadorSerieMensal": { "type": "object", "properties": { "pontuacao": { "type": "string", "nullable": true }, "ocorrencias": { "type": "array", "items": { "$ref": "#/components/schemas/SerieMensal" }, "nullable": true } }, "additionalProperties": false }, "IndicadorSerieMensalDefineLimitePositivoPJ": { "type": "object", "properties": { "pontuacao": { "type": "string", "nullable": true }, "ocorrencias": { "type": "array", "items": { "$ref": "#/components/schemas/SerieMensalDefineLimitePositivoPJ" }, "nullable": true } }, "additionalProperties": false }, "IndicadoreNegocio": { "type": "object", "properties": { "faixa": { "type": "string", "nullable": true }, "risco": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Indicadores": { "type": "object", "properties": { "quantidadeIndicadores": { "type": "integer", "format": "int32", "nullable": true }, "indicacoes": { "type": "array", "items": { "$ref": "#/components/schemas/Indicador" }, "nullable": true }, "observacao": { "type": "string", "nullable": true } }, "additionalProperties": false }, "IndicadoresPositivos": { "type": "object", "properties": { "creditoObtido": { "$ref": "#/components/schemas/IndicadorSerieMensal" }, "compromissos": { "$ref": "#/components/schemas/IndicadorSerieMensal" }, "pagamentoPontual": { "$ref": "#/components/schemas/IndicadorSerieMensal" }, "pagamentoAtrasado": { "$ref": "#/components/schemas/IndicadorPagamentoAtrasado" }, "eventosPessoaJuridica": { "$ref": "#/components/schemas/IndicadorEventosPessoaJuridica" }, "periodoRelacionamentoFornecedores": { "$ref": "#/components/schemas/IndicadorPeriodoRelacionamento" } }, "additionalProperties": false }, "IndicadoresPositivosDefineLimitePositivoPJ": { "type": "object", "properties": { "creditoObtido": { "$ref": "#/components/schemas/IndicadorSerieMensalDefineLimitePositivoPJ" }, "compromissos": { "$ref": "#/components/schemas/IndicadorSerieMensalDefineLimitePositivoPJ" }, "pagamentoPontual": { "$ref": "#/components/schemas/IndicadorSerieMensalDefineLimitePositivoPJ" }, "pagamentoAtrasado": { "$ref": "#/components/schemas/IndicadorPagamentoAtrasadoDefineLimitePositivoPJ" }, "eventosPessoaJuridica": { "$ref": "#/components/schemas/IndicadorEventosPessoaJuridicaDefineLimitePositivoPJ" }, "periodoRelacionamentoFornecedores": { "$ref": "#/components/schemas/IndicadorPeriodoRelacionamentoDefineLimitePositivoPJ" } }, "additionalProperties": false }, "IndicadoresRouboFurto": { "type": "object", "properties": { "houveRouboFurto": { "type": "boolean", "nullable": true }, "houveRecuperacao": { "type": "boolean", "nullable": true }, "houveDevolucao": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "IndicadoresVeiculo": { "type": "object", "properties": { "renainf": { "type": "boolean" }, "comunicadoVenda": { "type": "boolean" }, "pendenciaEmissao": { "type": "boolean" }, "renajud": { "type": "boolean" }, "rfb": { "type": "boolean" }, "rouboFurto": { "type": "boolean" }, "leilao": { "type": "boolean" }, "alarme": { "type": "boolean" }, "siniav": { "type": "boolean" }, "recall": { "type": "boolean" } }, "additionalProperties": false }, "InformacaoAdcional": { "type": "object", "properties": { "tema": { "type": "string", "nullable": true }, "fase": { "type": "string", "nullable": true }, "descricao": { "type": "string", "nullable": true }, "dataProcessamento": { "type": "string", "nullable": true }, "areaSobreposicao": { "type": "string", "nullable": true }, "percentualSobreposicao": { "type": "string", "nullable": true } }, "additionalProperties": false }, "InformacoesAlertasRestricoesPF": { "type": "object", "properties": { "quantidadeOcorrencias": { "type": "string", "nullable": true }, "ocorrencias": { "type": "array", "items": { "$ref": "#/components/schemas/OcorrenciaInformacaoPF" }, "nullable": true } }, "additionalProperties": false }, "Infracoes": { "type": "object", "properties": { "autoInfracao": { "type": "string", "nullable": true }, "exigivel": { "type": "boolean", "nullable": true }, "localInfracao": { "type": "string", "nullable": true }, "dataInfracao": { "type": "string", "nullable": true }, "codigoInfracao": { "type": "string", "nullable": true }, "descricaoInfracao": { "type": "string", "nullable": true }, "enquadramento": { "type": "string", "nullable": true }, "amparoLegal": { "type": "string", "nullable": true }, "pontos": { "type": "string", "nullable": true }, "statusInfracao": { "type": "string", "nullable": true }, "faseAutuacao": { "type": "string", "nullable": true }, "codigoMulta": { "type": "string", "nullable": true }, "dataLimiteDefesaAutuacao": { "type": "string", "nullable": true }, "dataLimiteRecursoVencimentoPenalidade": { "type": "string", "nullable": true }, "dividaQuitada": { "type": "string", "nullable": true }, "valorMulta": { "type": "string", "nullable": true }, "valorDevido": { "type": "string", "nullable": true }, "valorFinal": { "type": "string", "nullable": true }, "valorDoJuros": { "type": "string", "nullable": true }, "taxaJuros": { "type": "string", "nullable": true }, "guiaRecolhimento": { "type": "array", "items": { "$ref": "#/components/schemas/GuiaRecolhimento" }, "nullable": true } }, "additionalProperties": false }, "InfracoesTrabalhistas": { "type": "object", "properties": { "uf": { "type": "string", "nullable": true }, "numeroInscricao": { "type": "string", "nullable": true }, "numeroProcesso": { "type": "string", "nullable": true }, "tipo": { "type": "string", "nullable": true }, "situacao": { "type": "string", "nullable": true }, "ultimoMovimento": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Inscricao": { "type": "object", "properties": { "atividadeEconomicaEstadual": { "type": "string", "nullable": true }, "atividadeEconomicaPrincipal": { "type": "string", "nullable": true }, "atividadesEconomicasSecundarias": { "type": "array", "items": { "type": "string" }, "nullable": true }, "bairro": { "type": "string", "nullable": true }, "cep": { "type": "string", "nullable": true }, "cnpj": { "type": "string", "nullable": true }, "complemento": { "type": "string", "nullable": true }, "dataConsulta": { "type": "string", "nullable": true }, "dataConsultaSuframa": { "type": "string", "nullable": true }, "dataValidadeCadastral": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "inscricaoSuframa": { "type": "integer", "format": "int32", "nullable": true }, "logradouro": { "type": "string", "nullable": true }, "municipio": { "type": "string", "nullable": true }, "razaoSocial": { "type": "string", "nullable": true }, "situacaoCadastralAtual": { "type": "string", "nullable": true }, "telefone": { "type": "string", "nullable": true }, "uf": { "type": "string", "nullable": true } }, "additionalProperties": false }, "InscricaoEstadual": { "type": "object", "properties": { "inscricao": { "type": "string", "nullable": true }, "situacao": { "type": "string", "nullable": true }, "vinculo": { "type": "string", "nullable": true }, "ativoHabilitada": { "type": "string", "nullable": true }, "uf": { "type": "string", "nullable": true } }, "additionalProperties": false }, "InscricaoEstadualCompleta": { "type": "object", "properties": { "codigoControle": { "type": "string", "nullable": true }, "dataConsulta": { "type": "string", "nullable": true }, "ie": { "type": "string", "nullable": true }, "tipoIE": { "type": "string", "nullable": true }, "ufie": { "type": "string", "nullable": true }, "cnpj": { "type": "string", "nullable": true }, "cpf": { "type": "string", "nullable": true }, "nomeEmpresarial": { "type": "string", "nullable": true }, "nomeFantasia": { "type": "string", "nullable": true }, "naturezaJuridica": { "type": "string", "nullable": true }, "logradouro": { "type": "string", "nullable": true }, "numero": { "type": "integer", "format": "int32", "nullable": true }, "complemento": { "type": "string", "nullable": true }, "cep": { "type": "string", "nullable": true }, "bairro": { "type": "string", "nullable": true }, "municipio": { "type": "string", "nullable": true }, "uf": { "type": "string", "nullable": true }, "telefone": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "situacaoCadastral": { "type": "string", "nullable": true }, "situacaoCNPJ": { "type": "string", "nullable": true }, "motivoSituacaoCadastral": { "type": "string", "nullable": true }, "dataAbertura": { "type": "string", "nullable": true }, "dataInicioAtividade": { "type": "string", "nullable": true }, "dataFimAtividade": { "type": "string", "nullable": true }, "dataSituacaoCadastral": { "type": "string", "nullable": true }, "ocorrenciaFiscal": { "type": "string", "nullable": true }, "regimeApuracao": { "type": "string", "nullable": true }, "atividadeEconomicaPrincipal": { "type": "string", "nullable": true }, "atividadesEconomicasSecundarias": { "type": "array", "items": { "type": "string" }, "nullable": true }, "dataCredenciamentoEmissorNFe": { "type": "string", "nullable": true }, "indicadorObrigatoriedadeNFe": { "type": "string", "nullable": true }, "dataInicioObrigatoriedadeNFe": { "type": "string", "nullable": true }, "observacao": { "type": "string", "nullable": true }, "situacaoContribuinteNaData": { "type": "string", "nullable": true }, "informacaoIBGE": { "$ref": "#/components/schemas/IBGE" } }, "additionalProperties": false, "description": "Item da lista InscricoesEstaduais: cadastro completo de uma IE, sem sub-lista." }, "Interpol": { "type": "object", "properties": { "pessoas": { "type": "array", "items": { "$ref": "#/components/schemas/Pessoa" }, "nullable": true }, "nome": { "type": "string", "nullable": true }, "sobrenome": { "type": "string", "nullable": true }, "dataConsulta": { "type": "string", "nullable": true } }, "additionalProperties": false }, "InterpolRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/Pesquisa" } }, "additionalProperties": false }, "ItemNFe": { "type": "object", "properties": { "numeroItem": { "type": "integer", "format": "int32", "nullable": true }, "codigoProduto": { "type": "string", "nullable": true }, "descricaoProduto": { "type": "string", "nullable": true }, "ncm": { "type": "string", "nullable": true }, "cest": { "type": "string", "nullable": true }, "cfop": { "type": "string", "nullable": true }, "quantidade": { "type": "string", "nullable": true }, "unidadeComercial": { "type": "string", "nullable": true }, "valorUnitario": { "type": "string", "nullable": true }, "valorTotal": { "type": "string", "nullable": true }, "impostos": { "$ref": "#/components/schemas/ImpostoItem" } }, "additionalProperties": false }, "ItemRemuneracaoValor": { "type": "object", "properties": { "descricao": { "type": "string", "nullable": true }, "valor": { "type": "string", "nullable": true } }, "additionalProperties": false }, "JetomRemuneracao": { "type": "object", "properties": { "descricao": { "type": "string", "nullable": true }, "mesReferencia": { "type": "string", "nullable": true }, "valor": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Julgamento": { "type": "object", "properties": { "data": { "type": "string", "nullable": true }, "situacao": { "type": "string", "nullable": true }, "decisao": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LeilaoVeicularRegistro": { "type": "object", "properties": { "leiloeiro": { "type": "string", "nullable": true }, "lote": { "type": "string", "nullable": true }, "patio": { "type": "string", "nullable": true }, "dataLeilao": { "type": "string", "nullable": true }, "comitente": { "type": "string", "nullable": true }, "classificacao": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LimiteCreditoResumo": { "type": "object", "properties": { "descricao": { "type": "string", "nullable": true }, "valor": { "type": "string", "nullable": true }, "texto": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LimiteCreditoResumoDefineLimitePositivoPJ": { "type": "object", "properties": { "descricao": { "type": "string", "nullable": true }, "valor": { "type": "string", "nullable": true }, "texto": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ListaCategorias": { "type": "object", "properties": { "categoria": { "type": "string", "nullable": true }, "detalhe": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ListaSancoesEURetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/EUFinancialList" } }, "additionalProperties": false }, "Local": { "type": "object", "properties": { "status": { "type": "string", "nullable": true }, "estabelecimento": { "type": "string", "nullable": true }, "uf": { "type": "string", "nullable": true }, "quantidadeTrabalhadores": { "type": "integer", "format": "int32", "nullable": true }, "cnae": { "type": "string", "nullable": true }, "anoAcaoFiscal": { "type": "string", "nullable": true }, "dataAdministrativa": { "type": "string", "nullable": true }, "dataInclusao": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Localizacao": { "type": "object", "properties": { "uf": { "type": "string", "nullable": true }, "municipio": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MPFCertidaoNegativa": { "type": "object", "properties": { "nomeEntidade": { "type": "string", "nullable": true }, "documentoConsultado": { "type": "string", "nullable": true }, "dataEmissao": { "type": "string", "nullable": true }, "dataValidade": { "type": "string", "nullable": true }, "possuiProcedimentoExtrajudicial": { "type": "boolean", "nullable": true }, "procedimentosExtrajudiciais": { "type": "array", "items": { "$ref": "#/components/schemas/ProcedimentoExtrajudicial" }, "nullable": true }, "codigoValidacao": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MPFCertidaoNegativaRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/MPFCertidaoNegativa" } }, "additionalProperties": false }, "MPMTMinisterioPublicoMatoGrosso": { "type": "object", "properties": { "documentoConsultado": { "type": "string", "nullable": true }, "dataEmissao": { "type": "string", "nullable": true }, "dataValidade": { "type": "string", "nullable": true }, "possuiProcedimentoExtrajudicial": { "type": "boolean", "nullable": true }, "procedimentosInvestigatoriosExtrajudiciais": { "type": "array", "items": { "$ref": "#/components/schemas/ProcedimentoInvestigatorioExtrajudicial" }, "nullable": true }, "numeroCertidao": { "type": "string", "nullable": true }, "codigoValidacao": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MPMTMinisterioPublicoMatoGrossoRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/MPMTMinisterioPublicoMatoGrosso" } }, "additionalProperties": false }, "MTEInfracoesTrabalhistas": { "type": "object", "properties": { "documentoConsultado": { "type": "string", "nullable": true }, "dataConsulta": { "type": "string", "nullable": true }, "tipoConsultado": { "type": "string", "nullable": true }, "infracoesTrabalhistas": { "type": "array", "items": { "$ref": "#/components/schemas/InfracoesTrabalhistas" }, "nullable": true }, "totalProcessos": { "type": "string", "nullable": true }, "constamProcessos": { "type": "boolean", "nullable": true }, "status": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MTEInfracoesTrabalhistasRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/MTEInfracoesTrabalhistas" } }, "additionalProperties": false }, "Mandado": { "type": "object", "properties": { "numero": { "type": "string", "nullable": true }, "nome": { "type": "string", "nullable": true }, "profissao": { "type": "string", "nullable": true }, "sexo": { "type": "string", "nullable": true }, "nomeMae": { "type": "string", "nullable": true }, "nomePai": { "type": "string", "nullable": true }, "alcunha": { "type": "string", "nullable": true }, "dataNascimento": { "type": "string", "nullable": true }, "situacao": { "type": "string", "nullable": true }, "regimePrisional": { "type": "string", "nullable": true }, "tempoPena": { "type": "string", "nullable": true }, "isRecaptura": { "type": "boolean", "nullable": true }, "expedicao": { "$ref": "#/components/schemas/Expedicao" } }, "additionalProperties": false }, "MandadoPrisao": { "type": "object", "properties": { "cpf": { "type": "string", "nullable": true }, "dataConsulta": { "type": "string", "nullable": true }, "possuiMandado": { "type": "boolean", "nullable": true }, "mandadosPrisao": { "type": "array", "items": { "$ref": "#/components/schemas/Mandado" }, "nullable": true }, "status": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Medico": { "type": "object", "properties": { "nomeEntidade": { "type": "string", "nullable": true }, "crm": { "type": "string", "nullable": true }, "uf": { "type": "string", "nullable": true }, "tipoInscricao": { "type": "string", "nullable": true }, "dataInscricao": { "type": "string", "nullable": true }, "situacao": { "type": "string", "nullable": true }, "instituicaoGraduacao": { "type": "string", "nullable": true }, "anoFormatura": { "type": "string", "nullable": true }, "inscricaoOutrosEstados": { "type": "string", "nullable": true }, "endereco": { "type": "string", "nullable": true }, "telefone": { "type": "string", "nullable": true }, "especialidades": { "type": "array", "items": { "type": "string" }, "nullable": true }, "status": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MetaDados": { "type": "object", "properties": { "consultaNome": { "type": "string", "nullable": true }, "consultaUid": { "type": "string", "nullable": true }, "chave": { "type": "string", "nullable": true }, "usuario": { "type": "string", "nullable": true }, "mensagem": { "type": "string", "nullable": true }, "ip": { "type": "string", "nullable": true }, "resultadoId": { "type": "integer", "format": "int32" }, "resultado": { "type": "string", "nullable": true }, "apiVersao": { "type": "string", "default": "v3", "nullable": true }, "enviarCallback": { "type": "boolean", "default": false }, "gerarComprovante": { "type": "boolean", "default": false }, "urlComprovante": { "type": "string", "nullable": true }, "assincrono": { "type": "boolean", "default": true }, "data": { "type": "string", "default": "dd/MM/yyyy HH:mm:ss", "nullable": true }, "tempoExecucaoMs": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "MinisterioPublicoTrabalho": { "type": "object", "properties": { "documentoConsultado": { "type": "string", "nullable": true }, "regiao": { "type": "string", "nullable": true }, "dataEmissao": { "type": "string", "nullable": true }, "possuiOcorrencia": { "type": "boolean", "nullable": true }, "status": { "type": "string", "nullable": true }, "codigoValidacao": { "type": "string", "nullable": true }, "ocorrencias": { "type": "array", "items": { "$ref": "#/components/schemas/OcorrenciaMPT" }, "nullable": true } }, "additionalProperties": false }, "MinisterioPublicoTrabalhoRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/MinisterioPublicoTrabalho" } }, "additionalProperties": false }, "MinisterioTrabalhoPIS": { "type": "object", "properties": { "pis": { "type": "string", "nullable": true }, "cpf": { "type": "string", "nullable": true }, "nome": { "type": "string", "nullable": true }, "nomeMae": { "type": "string", "nullable": true }, "dataNascimento": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MinisterioTrabalhoPISRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/MinisterioTrabalhoPIS" } }, "additionalProperties": false }, "MontanteVencimentoContrato": { "type": "object", "properties": { "vencido15Dias": { "type": "string", "nullable": true }, "vencido16A30Dias": { "type": "string", "nullable": true }, "vencido31A60Dias": { "type": "string", "nullable": true }, "vencido61A90Dias": { "type": "string", "nullable": true }, "vencidoMais91Dias": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Movimentacoes": { "type": "object", "properties": { "data": { "type": "string", "nullable": true }, "movimento": { "type": "string", "nullable": true }, "descricao": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MultasRadarDetalhes": { "type": "object", "properties": { "numeroAutoInfracao": { "type": "string", "nullable": true }, "orgaoAutuador": { "type": "string", "nullable": true }, "codigoRenainf": { "type": "string", "nullable": true }, "placa": { "type": "string", "nullable": true }, "uf": { "type": "string", "nullable": true }, "marcaModelo": { "type": "string", "nullable": true }, "dataHora": { "type": "string", "nullable": true }, "municipio": { "type": "string", "nullable": true }, "ufCometimento": { "type": "string", "nullable": true }, "local": { "type": "string", "nullable": true }, "infracao": { "type": "string", "nullable": true }, "descricao": { "type": "string", "nullable": true }, "amparoLegal": { "type": "string", "nullable": true }, "pontos": { "type": "integer", "format": "int32", "nullable": true }, "gravidade": { "type": "string", "nullable": true }, "valor": { "type": "string", "nullable": true }, "observacoes": { "type": "string", "nullable": true }, "limitePermitido": { "type": "string", "nullable": true }, "medicaoReal": { "type": "string", "nullable": true }, "medicaoConsiderada": { "type": "string", "nullable": true }, "unidadeMedida": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MultasRadarInfracao": { "type": "object", "properties": { "dataInfracao": { "type": "string", "nullable": true }, "situacao": { "type": "string", "nullable": true }, "descricaoInfracao": { "type": "string", "nullable": true }, "detalhes": { "$ref": "#/components/schemas/MultasRadarDetalhes" } }, "additionalProperties": false }, "NameEntity": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "distance": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "NaturezaPGFN": { "type": "object", "properties": { "numeroInscricao": { "type": "string", "nullable": true }, "tipoDivida": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "receitaPrincipal": { "type": "string", "nullable": true }, "situacaoInscricao": { "type": "string", "nullable": true }, "total": { "type": "number", "format": "double", "nullable": true }, "debitos": { "type": "array", "items": { "$ref": "#/components/schemas/Debito" }, "nullable": true }, "natureza": { "type": "integer", "format": "int32", "nullable": true }, "entidadeResponsavel": { "type": "string", "nullable": true }, "dataInscricao": { "type": "string", "nullable": true }, "tipoCredito": { "type": "string", "nullable": true }, "unidadeInscricao": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Negativacao": { "type": "object", "properties": { "documento": { "type": "string", "nullable": true }, "nomeEmpresa": { "type": "string", "nullable": true }, "motivo": { "type": "string", "nullable": true }, "valor": { "type": "number", "format": "double", "nullable": true }, "numeroContrato": { "type": "string", "nullable": true }, "tipoParticipacao": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "dataOcorrencia": { "type": "string", "nullable": true }, "dataInclusao": { "type": "string", "nullable": true }, "dataModificacao": { "type": "string", "nullable": true }, "endereco": { "$ref": "#/components/schemas/EnderecoDN" } }, "additionalProperties": false }, "NegativacaoDCC": { "type": "object", "properties": { "documento": { "type": "string", "nullable": true }, "nomeEmpresa": { "type": "string", "nullable": true }, "motivo": { "type": "string", "nullable": true }, "valor": { "type": "number", "format": "double", "nullable": true }, "numeroContrato": { "type": "string", "nullable": true }, "tipoParticipacao": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "dataOcorrencia": { "type": "string", "nullable": true }, "dataInclusao": { "type": "string", "nullable": true }, "dataModificacao": { "type": "string", "nullable": true }, "endereco": { "$ref": "#/components/schemas/EnderecoDCC" } }, "additionalProperties": false }, "NfeInutilizacao": { "type": "object", "properties": { "ano": { "type": "integer", "format": "int32", "nullable": true }, "modelo": { "type": "integer", "format": "int32", "nullable": true }, "serie": { "type": "integer", "format": "int32", "nullable": true }, "numeroInicial": { "type": "integer", "format": "int64" }, "numeroFinal": { "type": "integer", "format": "int64" }, "protocolo": { "type": "string", "nullable": true }, "dataAutorizacao": { "type": "string", "nullable": true }, "dataRecebimentoAN": { "type": "string", "nullable": true } }, "additionalProperties": false }, "NivelSocioeconomico": { "type": "object", "properties": { "cpf": { "type": "string", "nullable": true }, "rendaEstimada": { "type": "string", "nullable": true }, "rendaFaixaSalarial": { "type": "string", "nullable": true }, "rendaMinimaCBO": { "type": "string", "nullable": true }, "rendaMediaCBO": { "type": "string", "nullable": true }, "rendaMaximaCBO": { "type": "string", "nullable": true }, "rendaIBGE": { "type": "string", "nullable": true }, "codigoCBO": { "type": "string", "nullable": true }, "cbo": { "type": "string", "nullable": true }, "classeSocial": { "type": "string", "nullable": true }, "escolaridade": { "type": "string", "nullable": true }, "perfilDomiciliar": { "$ref": "#/components/schemas/PerfilDomiciliar" } }, "additionalProperties": false }, "NivelSocioeconomicoRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/NivelSocioeconomico" } }, "additionalProperties": false }, "NotaContratoRecenteAcertaCompletoPF": { "type": "object", "properties": { "nota": { "type": "string", "nullable": true } }, "additionalProperties": false }, "NotaContratoRecentePF": { "type": "object", "properties": { "nota": { "type": "string", "nullable": true } }, "additionalProperties": false }, "NotaFaturaAtrasoAcertaCompletoPF": { "type": "object", "properties": { "notaComportamentoFaturaEmAtraso": { "type": "string", "nullable": true } }, "additionalProperties": false }, "NotaFaturaAtrasoPF": { "type": "object", "properties": { "notaComportamentoFaturaEmAtraso": { "type": "string", "nullable": true } }, "additionalProperties": false }, "NotaFiscalEletronicaCompleta": { "type": "object", "properties": { "chaveNFe": { "type": "string", "nullable": true }, "identificacao": { "$ref": "#/components/schemas/DadosNFe" }, "emitente": { "$ref": "#/components/schemas/Emitente" }, "destinatario": { "$ref": "#/components/schemas/Destinatario" }, "itens": { "type": "array", "items": { "$ref": "#/components/schemas/ItemNFe" }, "nullable": true }, "totais": { "$ref": "#/components/schemas/TotaisNFe" }, "formasPagamento": { "type": "array", "items": { "$ref": "#/components/schemas/DuplicataNFe" }, "nullable": true }, "transporte": { "$ref": "#/components/schemas/TransporteNFe" }, "informacoesComplementares": { "type": "string", "nullable": true } }, "additionalProperties": false }, "NotaFiscalEletronicaCompletaRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/NotaFiscalEletronicaCompleta" } }, "additionalProperties": false }, "NotaFiscalEletronicaInutilizacao": { "type": "object", "properties": { "cnpj": { "type": "string", "nullable": true }, "razaoSocial": { "type": "string", "nullable": true }, "inutilizacoes": { "type": "array", "items": { "$ref": "#/components/schemas/NfeInutilizacao" }, "nullable": true }, "observacao": { "type": "string", "nullable": true } }, "additionalProperties": false }, "NotaFiscalEletronicaInutilizacaoRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/NotaFiscalEletronicaInutilizacao" } }, "additionalProperties": false }, "NumeroPrimeiraInstancia": { "type": "object", "properties": { "numero": { "type": "string", "nullable": true }, "foro": { "type": "string", "nullable": true }, "vara": { "type": "string", "nullable": true }, "juiz": { "type": "string", "nullable": true }, "observacao": { "type": "string", "nullable": true } }, "additionalProperties": false }, "NumeroProcesso": { "type": "object", "properties": { "numero": { "type": "string", "nullable": true }, "incidente": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OAB": { "type": "object", "properties": { "numeroOAB": { "type": "string", "nullable": true }, "uf": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OABCadastroNacionalAdvogados": { "type": "object", "properties": { "nomePesquisado": { "type": "string", "nullable": true }, "inscricao": { "type": "string", "nullable": true }, "uf": { "type": "string", "nullable": true }, "possuiRegistros": { "type": "boolean", "nullable": true }, "observacoes": { "type": "string", "nullable": true }, "advogados": { "type": "array", "items": { "$ref": "#/components/schemas/Advogado" }, "nullable": true } }, "additionalProperties": false }, "OABCadastroNacionalAdvogadosRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/OABCadastroNacionalAdvogados" } }, "additionalProperties": false }, "OFAC": { "type": "object", "properties": { "nomeConsultado": { "type": "string", "nullable": true }, "resultadosEncontrados": { "type": "integer", "format": "int32" }, "observacoes": { "type": "string", "nullable": true }, "dataListaSDN": { "type": "string", "nullable": true }, "dataListaNONSDN": { "type": "string", "nullable": true }, "sancoes": { "type": "array", "items": { "$ref": "#/components/schemas/OFACSancoes" }, "nullable": true } }, "additionalProperties": false }, "OFACApelidos": { "type": "object", "properties": { "tipo": { "type": "string", "nullable": true }, "categoria": { "type": "string", "nullable": true }, "nome": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OFACIdentificacoes": { "type": "object", "properties": { "tipo": { "type": "string", "nullable": true }, "descricao": { "type": "string", "nullable": true }, "pais": { "type": "string", "nullable": true }, "dataEmissao": { "type": "string", "nullable": true }, "dataExpiracao": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OFACSancoes": { "type": "object", "properties": { "nome": { "type": "string", "nullable": true }, "sobrenome": { "type": "string", "nullable": true }, "dataNascimento": { "type": "string", "nullable": true }, "localNascimento": { "type": "string", "nullable": true }, "nacionalidade": { "type": "string", "nullable": true }, "cidadania": { "type": "string", "nullable": true }, "lista": { "type": "string", "nullable": true }, "programa": { "type": "string", "nullable": true }, "identificacoes": { "type": "array", "items": { "$ref": "#/components/schemas/OFACIdentificacoes" }, "nullable": true }, "apelidos": { "type": "array", "items": { "$ref": "#/components/schemas/OFACApelidos" }, "nullable": true }, "enderecos": { "type": "array", "items": { "$ref": "#/components/schemas/EnderecoSancoesUtils" }, "nullable": true } }, "additionalProperties": false }, "OFACSanctionsSearchRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/OFAC" } }, "additionalProperties": false }, "Obito": { "type": "object", "properties": { "cpf": { "type": "string", "nullable": true }, "nome": { "type": "string", "nullable": true }, "constaObito": { "type": "boolean", "nullable": true }, "status": { "type": "string", "nullable": true }, "dataObito": { "type": "string", "nullable": true }, "anoObito": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "ObitoRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/Obito" } }, "additionalProperties": false }, "Ocorrencia": { "type": "object", "properties": { "cobranca": { "type": "string", "nullable": true }, "pais": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OcorrenciaInformacaoPF": { "type": "object", "properties": { "codigoInformacao": { "type": "string", "nullable": true }, "descricaoInformacao": { "type": "string", "nullable": true }, "titulo": { "type": "string", "nullable": true }, "observacao": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OcorrenciaMPT": { "type": "object", "properties": { "anoAutuacao": { "type": "string", "nullable": true }, "classe": { "type": "string", "nullable": true }, "numero": { "type": "string", "nullable": true }, "partes": { "type": "array", "items": { "type": "string" }, "nullable": true }, "situacao": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OcorrenciaRouboFurto": { "type": "object", "properties": { "categoria": { "type": "string", "nullable": true }, "ano": { "type": "integer", "format": "int32", "nullable": true }, "orgaoSeguranca": { "type": "string", "nullable": true }, "boletim": { "type": "string", "nullable": true }, "numeroOcorrencia": { "type": "string", "nullable": true }, "tipoDeclaracao": { "type": "string", "nullable": true }, "dataOcorrencia": { "type": "string", "nullable": true }, "alarme": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OffshoreLeaks": { "type": "object", "properties": { "nomeConsultado": { "type": "string", "nullable": true }, "resultadosEncontrados": { "type": "integer", "format": "int32" }, "observacoes": { "type": "string", "nullable": true }, "referenciaBase": { "type": "string", "nullable": true }, "totalRegistrosBase": { "type": "integer", "format": "int32" }, "fonteAtribuicao": { "type": "string", "nullable": true }, "registros": { "type": "array", "items": { "$ref": "#/components/schemas/OffshoreLeaksRegistro" }, "nullable": true } }, "additionalProperties": false }, "OffshoreLeaksRegistro": { "type": "object", "properties": { "nodeId": { "type": "string", "nullable": true }, "tipoNo": { "type": "string", "nullable": true }, "tipoMatch": { "type": "string", "nullable": true }, "nome": { "type": "string", "nullable": true }, "jurisdicao": { "type": "string", "nullable": true }, "pais": { "type": "array", "items": { "type": "string" }, "nullable": true }, "vazamento": { "type": "string", "nullable": true }, "dataIncorporacao": { "type": "string", "nullable": true }, "situacao": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OffshoreLeaksRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/OffshoreLeaks" } }, "additionalProperties": false }, "OpcaoExtensaoArquivo": { "enum": [ "PDF", "JSON" ], "type": "string", "default": "JSON" }, "OpcaoGenero": { "enum": [ "Masculino", "Feminino" ], "type": "string" }, "OpcaoGerarComprovante": { "enum": [ "Desabilitar", "Habilitar" ], "type": "string", "default": "Desabilitar" }, "OpcaoGrauTJ": { "enum": [ 1, 2 ], "type": "integer", "format": "int32", "default": 1 }, "OpcaoRegiaoMPT": { "enum": [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24 ], "type": "integer", "format": "int32" }, "OpcaoRegiaoTRF": { "enum": [ "TRF1", "TRF2", "TRF3", "TRF4", "TRF5", "TRF6" ], "type": "string", "default": "TRF1" }, "OpcaoRegiaoTRT": { "enum": [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24 ], "type": "integer", "format": "int32", "default": 1 }, "OpcaoTipoCGU": { "enum": [ "AgentePúblico", "EntePrivado" ], "type": "string" }, "OpcaoTipoCertidaoTJ": { "enum": [ "Cível", "Criminal", "Fiscal", "FinsEleitorais", "FalênciaRecuperação", "Família", "Militar" ], "type": "string", "default": "Cível" }, "OpcaoTipoInfracoes": { "enum": [ "EmAberto", "Pagas", "Canceladas" ], "type": "string" }, "OpcaoTipoMTE": { "enum": [ "Eletrônico", "Físico" ], "type": "string" }, "OpcaoTipoPIX": { "enum": [ "CPF", "CNPJ", "EMAIL", "TELEFONE" ], "type": "string" }, "OpcaoTipoTRF": { "enum": [ "Cível", "Criminal", "FinsEleitorais" ], "type": "string", "default": "Cível" }, "OpcaoTipoTRT": { "enum": [ "Eletrônico", "Físico" ], "type": "string", "default": "Eletrônico" }, "OpcaoUF": { "enum": [ "AC", "AL", "AM", "AP", "BA", "CE", "DF", "ES", "GO", "MA", "MG", "MS", "MT", "PA", "PB", "PE", "PI", "PR", "RJ", "RN", "RO", "RR", "RS", "SC", "SE", "SP", "TO" ], "type": "string", "default": "SP" }, "OrgaoJulgador": { "type": "object", "properties": { "tribunal": { "type": "string", "nullable": true }, "comarca": { "type": "string", "nullable": true }, "orgaoResponsavel": { "type": "string", "nullable": true }, "unidadeOrigem": { "type": "string", "nullable": true }, "cidade": { "type": "string", "nullable": true }, "uf": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OrgaoLotacao": { "type": "object", "properties": { "nome": { "type": "string", "nullable": true }, "sigla": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OrgaoSancionador": { "type": "object", "properties": { "nome": { "type": "string", "nullable": true }, "uf": { "type": "string", "nullable": true }, "poder": { "type": "string", "nullable": true }, "esfera": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OrgaoSancionadorCEPIM": { "type": "object", "properties": { "nome": { "type": "string", "nullable": true }, "cnpj": { "type": "string", "nullable": true }, "sigla": { "type": "string", "nullable": true }, "poder": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OrgaoServidorFederal": { "type": "object", "properties": { "codigo": { "type": "string", "nullable": true }, "nome": { "type": "string", "nullable": true }, "sigla": { "type": "string", "nullable": true }, "orgaoVinculado": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OrgaoViagem": { "type": "object", "properties": { "nome": { "type": "string", "nullable": true }, "sigla": { "type": "string", "nullable": true }, "cnpj": { "type": "string", "nullable": true }, "poder": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OrgaoVinculo": { "type": "object", "properties": { "uf": { "type": "string", "nullable": true }, "orgaoSuperior": { "type": "string", "nullable": true }, "orgao": { "type": "string", "nullable": true }, "uorg": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PEPParentescos": { "type": "object", "properties": { "cpf": { "type": "string", "nullable": true }, "nome": { "type": "string", "nullable": true }, "pep": { "type": "boolean", "nullable": true }, "funcao": { "type": "string", "nullable": true }, "orgao": { "type": "string", "nullable": true }, "parentescos": { "type": "array", "items": { "$ref": "#/components/schemas/Parentesco" }, "nullable": true }, "dataConsulta": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PEPParentescosRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/PEPParentescos" } }, "additionalProperties": false }, "PEPRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/PessoaExpostaPoliticamente" } }, "additionalProperties": false }, "PETI": { "type": "object", "properties": { "numeroRegistro": { "type": "integer", "format": "int64", "nullable": true }, "data": { "type": "string", "nullable": true }, "situacao": { "type": "string", "nullable": true }, "valor": { "type": "string", "nullable": true }, "municipio": { "type": "string", "nullable": true }, "uf": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PETITrabalhoInfantil": { "type": "object", "properties": { "nome": { "type": "string", "nullable": true }, "nis": { "type": "string", "nullable": true }, "cpf": { "type": "string", "nullable": true }, "beneficios": { "type": "array", "items": { "$ref": "#/components/schemas/PETI" }, "nullable": true } }, "additionalProperties": false }, "PETITrabalhoInfantilRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/PETITrabalhoInfantil" } }, "additionalProperties": false }, "PGFNListaDevedoresUniao": { "type": "object", "properties": { "documentoConsultado": { "type": "string", "nullable": true }, "nome": { "type": "string", "nullable": true }, "tipoPessoa": { "type": "string", "nullable": true }, "tipoDevedor": { "type": "string", "nullable": true }, "cnae": { "type": "string", "nullable": true }, "cnaeDescricao": { "type": "string", "nullable": true }, "codigoMunicipio": { "type": "integer", "format": "int32", "nullable": true }, "nomeMunicipio": { "type": "string", "nullable": true }, "unidadeResponsavel": { "type": "string", "nullable": true }, "uf": { "type": "string", "nullable": true }, "totalDivida": { "type": "number", "format": "double", "nullable": true }, "totalTributario": { "type": "number", "format": "double", "nullable": true }, "totalPrevidenciario": { "type": "number", "format": "double", "nullable": true }, "naturezas": { "type": "array", "items": { "$ref": "#/components/schemas/NaturezaPGFN" }, "nullable": true }, "possuiDivida": { "type": "boolean", "nullable": true }, "status": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PGFNListaDevedoresUniaoRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/PGFNListaDevedoresUniao" } }, "additionalProperties": false }, "PRFInfracoes": { "type": "object", "properties": { "renavam": { "type": "string", "nullable": true }, "nomeDestinatario": { "type": "string", "nullable": true }, "placa": { "type": "string", "nullable": true }, "ufPlaca": { "type": "string", "nullable": true }, "licenciadoExterior": { "type": "boolean", "nullable": true }, "possuiInfracao": { "type": "boolean", "nullable": true }, "tipoConsultado": { "type": "string", "nullable": true }, "observacao": { "type": "string", "nullable": true }, "infracoes": { "type": "array", "items": { "$ref": "#/components/schemas/Infracoes" }, "nullable": true } }, "additionalProperties": false }, "PRFInfracoesRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/PRFInfracoes" } }, "additionalProperties": false }, "PagamentoDCC": { "type": "object", "properties": { "data": { "type": "string", "nullable": true }, "valorTotal": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "PagamentoDesanexado": { "type": "object", "properties": { "data": { "type": "string", "nullable": true }, "totalPago": { "type": "number", "format": "double", "nullable": true }, "tipoPagamento": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PagamentoEmAtraso": { "type": "object", "properties": { "descricao": { "type": "string", "nullable": true }, "pontuacao": { "type": "string", "nullable": true }, "itens": { "type": "array", "items": { "$ref": "#/components/schemas/SerieMensal" }, "nullable": true } }, "additionalProperties": false }, "PagamentoEmAtrasoDefineLimitePositivoPJ": { "type": "object", "properties": { "descricao": { "type": "string", "nullable": true }, "pontuacao": { "type": "string", "nullable": true }, "itens": { "type": "array", "items": { "$ref": "#/components/schemas/SerieMensalDefineLimitePositivoPJ" }, "nullable": true } }, "additionalProperties": false }, "ParcelaAnterior": { "type": "object", "properties": { "dataVencimento": { "type": "string", "nullable": true }, "periodicidadeParcela": { "type": "string", "nullable": true }, "saldoTotal": { "type": "number", "format": "double", "nullable": true }, "statusPagamento": { "type": "string", "nullable": true }, "pagamentos": { "type": "array", "items": { "$ref": "#/components/schemas/PagamentoDCC" }, "nullable": true }, "dataEncerramento": { "type": "string", "nullable": true }, "valorUtilizado": { "type": "number", "format": "double", "nullable": true }, "pagamentoMinimo": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "ParcelaFutura": { "type": "object", "properties": { "dataParcelaAnterior": { "type": "string", "nullable": true }, "periodicidade": { "type": "string", "nullable": true }, "totalParcelaFutura": { "type": "number", "format": "double", "nullable": true }, "quantidadeParcelasRemanescentes": { "type": "integer", "format": "int32", "nullable": true }, "quantidadeParcelasNaoPagas": { "type": "integer", "format": "int32", "nullable": true }, "dataEncerramento": { "type": "string", "nullable": true }, "valorUsado": { "type": "number", "format": "double", "nullable": true }, "pagamentoMinimo": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "Parentesco": { "type": "object", "properties": { "grauParentesco": { "type": "string", "nullable": true }, "cpf": { "type": "string", "nullable": true }, "nome": { "type": "string", "nullable": true }, "dataNascimento": { "type": "string", "nullable": true }, "genero": { "type": "string", "nullable": true }, "obito": { "type": "boolean", "nullable": true }, "dataObito": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ParentescoPEP": { "type": "object", "properties": { "grauParentesco": { "type": "string", "nullable": true }, "cpf": { "type": "string", "nullable": true }, "nome": { "type": "string", "nullable": true }, "dataNascimento": { "type": "string", "nullable": true }, "genero": { "type": "string", "nullable": true }, "obito": { "type": "boolean", "nullable": true }, "dataObito": { "type": "string", "nullable": true }, "codigoGrauParentesco": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "ParentescosBET": { "type": "object", "properties": { "cpf": { "type": "string", "nullable": true }, "nome": { "type": "string", "nullable": true }, "dataNascimento": { "type": "string", "nullable": true }, "genero": { "type": "string", "nullable": true }, "grauParentesco": { "type": "string", "nullable": true }, "relacionadoEsporte": { "type": "boolean", "nullable": true }, "codigoCBO": { "type": "string", "nullable": true }, "cbo": { "type": "string", "nullable": true }, "obito": { "type": "boolean", "nullable": true }, "dataObito": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Partes": { "type": "object", "properties": { "nomeCompleto": { "type": "string", "nullable": true }, "documento": { "type": "string", "nullable": true }, "origemDocumento": { "type": "string", "nullable": true }, "polo": { "type": "string", "nullable": true }, "posicaoProcessual": { "type": "string", "nullable": true }, "advogados": { "type": "array", "items": { "$ref": "#/components/schemas/Advogados" }, "nullable": true } }, "additionalProperties": false }, "PartesProcesso": { "type": "object", "properties": { "tipo": { "type": "string", "nullable": true }, "nome": { "type": "string", "nullable": true }, "representantes": { "type": "array", "items": { "$ref": "#/components/schemas/Representante" }, "nullable": true } }, "additionalProperties": false }, "PartesSimplificada": { "type": "object", "properties": { "nomeCompleto": { "type": "string", "nullable": true }, "polo": { "type": "string", "nullable": true }, "tipo": { "type": "string", "nullable": true }, "documento": { "type": "string", "nullable": true }, "tipoPessoa": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ParticipacaoEmEmpresasPF": { "type": "object", "properties": { "quantidadeOcorrencias": { "type": "string", "nullable": true }, "ocorrencias": { "type": "array", "items": { "$ref": "#/components/schemas/ParticipacaoEmpresaOcorrenciaPF" }, "nullable": true } }, "additionalProperties": false }, "ParticipacaoEmpresaConsultadaDefineLimitePositivoPJ": { "type": "object", "properties": { "razaoSocialParticipada": { "type": "string", "nullable": true }, "cnpjParticipada": { "type": "string", "nullable": true }, "situacaoCnpj": { "type": "string", "nullable": true }, "participacao": { "type": "string", "nullable": true }, "entrada": { "type": "string", "nullable": true }, "indicadorDebito": { "type": "string", "nullable": true }, "indicadorFraude": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ParticipacaoEmpresaOcorrenciaAcertaCompletoPF": { "type": "object", "properties": { "cnpj": { "type": "string", "nullable": true }, "razaoSocial": { "type": "string", "nullable": true }, "participanteTipo": { "type": "string", "nullable": true }, "participanteDocumento": { "type": "string", "nullable": true }, "participanteCargo": { "type": "string", "nullable": true }, "participanteEntrada": { "type": "string", "nullable": true }, "participacao": { "type": "string", "nullable": true }, "quantidadeOutrosSocios": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ParticipacaoEmpresaOcorrenciaPF": { "type": "object", "properties": { "cnpj": { "type": "string", "nullable": true }, "razaoSocial": { "type": "string", "nullable": true }, "participanteTipo": { "type": "string", "nullable": true }, "participanteDocumento": { "type": "string", "nullable": true }, "participanteCargo": { "type": "string", "nullable": true }, "participanteRenda": { "type": "string", "nullable": true }, "participacao": { "type": "string", "nullable": true }, "quantidadeOutrosSocios": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ParticipacaoEmpresasAcertaCompletoPF": { "type": "object", "properties": { "quantidadeOcorrencias": { "type": "string", "nullable": true }, "ocorrencias": { "type": "array", "items": { "$ref": "#/components/schemas/ParticipacaoEmpresaOcorrenciaAcertaCompletoPF" }, "nullable": true } }, "additionalProperties": false }, "ParticipacaoSocioAdmDefineLimitePositivoPJ": { "type": "object", "properties": { "nomeSocio": { "type": "string", "nullable": true }, "cpfCnpj": { "type": "string", "nullable": true }, "tipoDocumento": { "type": "string", "nullable": true }, "empresas": { "type": "array", "items": { "$ref": "#/components/schemas/EmpresaParticipacaoDefineLimitePositivoPJ" }, "nullable": true } }, "additionalProperties": false }, "ParticipacoesSocietariasDefineLimitePositivoPJ": { "type": "object", "properties": { "quantidadeParticipacoesSocioAdm": { "type": "string", "nullable": true }, "participacoesSocioAdmOutrasEmpresas": { "type": "array", "items": { "$ref": "#/components/schemas/ParticipacaoSocioAdmDefineLimitePositivoPJ" }, "nullable": true }, "quantidadeParticipacoesConsultada": { "type": "string", "nullable": true }, "participacoesEmpresasConsultadas": { "type": "array", "items": { "$ref": "#/components/schemas/ParticipacaoEmpresaConsultadaDefineLimitePositivoPJ" }, "nullable": true } }, "additionalProperties": false }, "PassagemComercialOcorrenciaAcertaCompletoPF": { "type": "object", "properties": { "dataConsulta": { "type": "string", "nullable": true }, "horaConsulta": { "type": "string", "nullable": true }, "clienteConsulta": { "type": "string", "nullable": true }, "telefoneCliente": { "type": "string", "nullable": true }, "enderecoCliente": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PassagemComercialOcorrenciaPF": { "type": "object", "properties": { "dataConsulta": { "type": "string", "nullable": true }, "horaConsulta": { "type": "string", "nullable": true }, "clienteConsulta": { "type": "string", "nullable": true }, "telefoneCliente": { "type": "string", "nullable": true }, "enderecoCliente": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PassagensComerciaisAcertaCompletoPF": { "type": "object", "properties": { "quantidadeOcorrencias": { "type": "string", "nullable": true }, "ocorrencias": { "type": "array", "items": { "$ref": "#/components/schemas/PassagemComercialOcorrenciaAcertaCompletoPF" }, "nullable": true } }, "additionalProperties": false }, "PassagensComerciaisPF": { "type": "object", "properties": { "quantidadeOcorrencias": { "type": "string", "nullable": true }, "ocorrencias": { "type": "array", "items": { "$ref": "#/components/schemas/PassagemComercialOcorrenciaPF" }, "nullable": true } }, "additionalProperties": false }, "Penalidade": { "type": "object", "properties": { "numeroPAS": { "type": "string", "nullable": true }, "descricao": { "type": "string", "nullable": true }, "prazoEmAnos": { "type": "string", "nullable": true }, "dataInicio": { "type": "string", "nullable": true }, "dataFim": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Pendencia": { "type": "object", "properties": { "entidade": { "type": "string", "nullable": true }, "dataInclusaoCADIN": { "type": "string", "nullable": true }, "quantidadePendencias": { "type": "integer", "format": "int32", "nullable": true }, "localRegularizacao": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PendenciaFinanceira": { "type": "object", "properties": { "status": { "type": "string", "nullable": true }, "totalPendencia": { "type": "number", "format": "double", "nullable": true }, "protestos": { "type": "array", "items": { "$ref": "#/components/schemas/ProtestoDN" }, "nullable": true }, "acoesJudiciais": { "type": "array", "items": { "$ref": "#/components/schemas/AcaoJudicial" }, "nullable": true }, "negativacoes": { "type": "array", "items": { "$ref": "#/components/schemas/Negativacao" }, "nullable": true }, "recuperacoesJudiciaisFalencia": { "type": "array", "items": { "$ref": "#/components/schemas/AcaoJudicial" }, "nullable": true }, "chequesSemFundo": { "type": "array", "items": { "$ref": "#/components/schemas/ChequeSemFundo" }, "nullable": true } }, "additionalProperties": false }, "PendenciaFinanceiraDCC": { "type": "object", "properties": { "status": { "type": "string", "nullable": true }, "totalPendencia": { "type": "number", "format": "double", "nullable": true }, "protestos": { "type": "array", "items": { "$ref": "#/components/schemas/ProtestoDCC" }, "nullable": true }, "acoesJudiciais": { "type": "array", "items": { "$ref": "#/components/schemas/AcaoJudicialDCC" }, "nullable": true }, "negativacoes": { "type": "array", "items": { "$ref": "#/components/schemas/NegativacaoDCC" }, "nullable": true }, "recuperacoesJudiciaisFalencia": { "type": "array", "items": { "$ref": "#/components/schemas/AcaoJudicialDCC" }, "nullable": true }, "chequesSemFundo": { "type": "array", "items": { "$ref": "#/components/schemas/ChequeSemFundoDCC" }, "nullable": true } }, "additionalProperties": false }, "PendenciaFinanceiraDetalhe": { "type": "object", "properties": { "dataVencimento": { "type": "string", "nullable": true }, "dataInclusao": { "type": "string", "nullable": true }, "informante": { "type": "string", "nullable": true }, "tipoDevedor": { "type": "string", "nullable": true }, "credor": { "type": "string", "nullable": true }, "moeda": { "type": "string", "nullable": true }, "valor": { "type": "string", "nullable": true }, "contrato": { "type": "string", "nullable": true }, "origem": { "type": "string", "nullable": true }, "subjudice": { "type": "string", "nullable": true }, "modalidade": { "type": "string", "nullable": true }, "entidade": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PendenciaFinanceiraDetalheDefineLimitePositivoPJ": { "type": "object", "properties": { "dataVencimento": { "type": "string", "nullable": true }, "dataInclusao": { "type": "string", "nullable": true }, "informante": { "type": "string", "nullable": true }, "tipoDevedor": { "type": "string", "nullable": true }, "credor": { "type": "string", "nullable": true }, "moeda": { "type": "string", "nullable": true }, "valor": { "type": "string", "nullable": true }, "contrato": { "type": "string", "nullable": true }, "origem": { "type": "string", "nullable": true }, "subjudice": { "type": "string", "nullable": true }, "modalidade": { "type": "string", "nullable": true }, "entidade": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PendenciaOcorrenciaAcertaCompletoPF": { "type": "object", "properties": { "dataVencimento": { "type": "string", "nullable": true }, "dataInclusao": { "type": "string", "nullable": true }, "informante": { "type": "string", "nullable": true }, "tipoDevedor": { "type": "string", "nullable": true }, "credor": { "type": "string", "nullable": true }, "moeda": { "type": "string", "nullable": true }, "valor": { "type": "string", "nullable": true }, "contrato": { "type": "string", "nullable": true }, "origem": { "type": "string", "nullable": true }, "subjudice": { "type": "string", "nullable": true }, "modalidade": { "type": "string", "nullable": true }, "entidade": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PendenciaOcorrenciaPF": { "type": "object", "properties": { "dataVencimento": { "type": "string", "nullable": true }, "dataInclusao": { "type": "string", "nullable": true }, "informante": { "type": "string", "nullable": true }, "tipoDevedor": { "type": "string", "nullable": true }, "credor": { "type": "string", "nullable": true }, "moeda": { "type": "string", "nullable": true }, "valor": { "type": "string", "nullable": true }, "contrato": { "type": "string", "nullable": true }, "origem": { "type": "string", "nullable": true }, "subjudice": { "type": "string", "nullable": true }, "modalidade": { "type": "string", "nullable": true }, "entidade": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Pendencias": { "type": "object", "properties": { "entidade": { "type": "string", "nullable": true }, "orgao": { "type": "string", "nullable": true }, "tipoPendencia": { "type": "string", "nullable": true }, "dataInclusaoCADIN": { "type": "string", "nullable": true }, "numeroProcesso": { "type": "string", "nullable": true }, "numeroDecisao": { "type": "string", "nullable": true }, "quantidadePendencias": { "type": "integer", "format": "int32", "nullable": true }, "valorAtualizado": { "type": "string", "nullable": true }, "localRegularizacao": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PendenciasFinanceirasAcertaCompletoPF": { "type": "object", "properties": { "quantidadeOcorrencia": { "type": "string", "nullable": true }, "valorTotal": { "type": "string", "nullable": true }, "ultimoVencimento": { "type": "string", "nullable": true }, "dataPrimeiro": { "type": "string", "nullable": true }, "totalCredores": { "type": "string", "nullable": true }, "valorMaior": { "type": "string", "nullable": true }, "valorPrimeiro": { "type": "string", "nullable": true }, "periodoInicial": { "type": "string", "nullable": true }, "periodoFinal": { "type": "string", "nullable": true }, "dataMaior": { "type": "string", "nullable": true }, "provedores": { "type": "array", "items": { "$ref": "#/components/schemas/ProvedorAcertaCompletoPF" }, "nullable": true }, "ocorrencias": { "type": "array", "items": { "$ref": "#/components/schemas/PendenciaOcorrenciaAcertaCompletoPF" }, "nullable": true } }, "additionalProperties": false }, "PendenciasFinanceirasPF": { "type": "object", "properties": { "quantidadeOcorrencia": { "type": "string", "nullable": true }, "valorTotal": { "type": "string", "nullable": true }, "ultimoVencimento": { "type": "string", "nullable": true }, "dataPrimeiro": { "type": "string", "nullable": true }, "totalCredores": { "type": "string", "nullable": true }, "valorMaior": { "type": "string", "nullable": true }, "valorPrimeiro": { "type": "string", "nullable": true }, "periodoInicial": { "type": "string", "nullable": true }, "periodoFinal": { "type": "string", "nullable": true }, "dataMaior": { "type": "string", "nullable": true }, "provedores": { "type": "array", "items": { "$ref": "#/components/schemas/ProvedorPF" }, "nullable": true }, "ocorrencias": { "type": "array", "items": { "$ref": "#/components/schemas/PendenciaOcorrenciaPF" }, "nullable": true } }, "additionalProperties": false }, "PendenciasFinanceirasResumo": { "type": "object", "properties": { "quantidade": { "type": "string", "nullable": true }, "valorTotal": { "type": "string", "nullable": true }, "periodoInicial": { "type": "string", "nullable": true }, "periodoFinal": { "type": "string", "nullable": true }, "ultimoVencimento": { "type": "string", "nullable": true }, "dataPrimeiro": { "type": "string", "nullable": true }, "dataMaior": { "type": "string", "nullable": true }, "totalCredores": { "type": "string", "nullable": true }, "valorMaior": { "type": "string", "nullable": true }, "valorPrimeiro": { "type": "string", "nullable": true }, "provedores": { "type": "array", "items": { "type": "string" }, "nullable": true }, "ocorrencias": { "type": "array", "items": { "$ref": "#/components/schemas/PendenciaFinanceiraDetalhe" }, "nullable": true } }, "additionalProperties": false }, "PendenciasFinanceirasResumoDefineLimitePositivoPJ": { "type": "object", "properties": { "quantidade": { "type": "string", "nullable": true }, "valorTotal": { "type": "string", "nullable": true }, "periodoInicial": { "type": "string", "nullable": true }, "periodoFinal": { "type": "string", "nullable": true }, "ultimoVencimento": { "type": "string", "nullable": true }, "dataPrimeiro": { "type": "string", "nullable": true }, "dataMaior": { "type": "string", "nullable": true }, "totalCredores": { "type": "string", "nullable": true }, "valorMaior": { "type": "string", "nullable": true }, "valorPrimeiro": { "type": "string", "nullable": true }, "provedores": { "type": "array", "items": { "type": "string" }, "nullable": true }, "ocorrencias": { "type": "array", "items": { "$ref": "#/components/schemas/PendenciaFinanceiraDetalheDefineLimitePositivoPJ" }, "nullable": true } }, "additionalProperties": false }, "PerfilDomiciliar": { "type": "object", "properties": { "tipoDomicilio": { "type": "string", "nullable": true }, "quantidadeMoradores": { "type": "integer", "format": "int32", "nullable": true }, "quantidadeAdultos": { "type": "integer", "format": "int32", "nullable": true }, "quantidadeMenores": { "type": "integer", "format": "int32", "nullable": true }, "rendaDomiciliar": { "type": "string", "nullable": true }, "rendaPerCapita": { "type": "string", "nullable": true }, "faixaRendaPerCapita": { "type": "string", "nullable": true }, "classeSocialFamiliar": { "type": "string", "nullable": true }, "confiabilidade": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Periodo": { "type": "object", "properties": { "inicio": { "type": "string", "nullable": true }, "fim": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PeriodoValor": { "type": "object", "properties": { "periodo": { "type": "string", "nullable": true }, "valor": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PeriodoValorDefineLimitePositivoPJ": { "type": "object", "properties": { "periodo": { "type": "string", "nullable": true }, "valor": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Pesquisa": { "type": "object", "properties": { "interpol": { "$ref": "#/components/schemas/Interpol" }, "observacao": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Pessoa": { "type": "object", "properties": { "sexo": { "type": "string", "nullable": true }, "dataNascimento": { "type": "string", "nullable": true }, "localNascimento": { "type": "string", "nullable": true }, "marcasDistintivas": { "type": "string", "nullable": true }, "altura": { "type": "string", "nullable": true }, "ocorrencias": { "type": "array", "items": { "$ref": "#/components/schemas/Ocorrencia" }, "nullable": true }, "fotos": { "type": "array", "items": { "type": "string" }, "nullable": true }, "linguasFaladas": { "type": "array", "items": { "type": "string" }, "nullable": true }, "nacionalidades": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "PessoaExpostaPoliticamente": { "type": "object", "properties": { "cpf": { "type": "string", "nullable": true }, "nome": { "type": "string", "nullable": true }, "pep": { "type": "boolean", "nullable": true }, "relacionadoComPEP": { "type": "boolean", "nullable": true }, "funcao": { "type": "string", "nullable": true }, "orgao": { "type": "string", "nullable": true }, "dataConsulta": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "parentescosPEP": { "type": "array", "items": { "$ref": "#/components/schemas/ParentescoPEP" }, "nullable": true } }, "additionalProperties": false }, "Peticao": { "type": "object", "properties": { "data": { "type": "string", "nullable": true }, "tipo": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PhoneEntity": { "type": "object", "properties": { "phone": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "distance": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "PisCofinsNFe": { "type": "object", "properties": { "cst": { "type": "string", "nullable": true }, "baseCalculo": { "type": "string", "nullable": true }, "aliquota": { "type": "string", "nullable": true }, "valor": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PoliciaCivilAntecedentesCriminais": { "type": "object", "properties": { "cpf": { "type": "string", "nullable": true }, "rg": { "type": "string", "nullable": true }, "nome": { "type": "string", "nullable": true }, "nomeMae": { "type": "string", "nullable": true }, "nomePai": { "type": "string", "nullable": true }, "genero": { "type": "string", "nullable": true }, "idade": { "type": "integer", "format": "int32", "nullable": true }, "dataNascimento": { "type": "string", "nullable": true }, "dataConsulta": { "type": "string", "nullable": true }, "dataEmissao": { "type": "string", "nullable": true }, "dataValidade": { "type": "string", "nullable": true }, "naturalidade": { "type": "string", "nullable": true }, "nacionalidade": { "type": "string", "nullable": true }, "numeroCertidao": { "type": "string", "nullable": true }, "uf": { "type": "string", "nullable": true }, "possuiAntecedentesCriminais": { "type": "boolean", "nullable": true }, "status": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PoliciaCivilAntecedentesCriminaisRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/PoliciaCivilAntecedentesCriminais" } }, "additionalProperties": false }, "PoliciaFederalAntecedentesCriminais": { "type": "object", "properties": { "cpf": { "type": "string", "nullable": true }, "nome": { "type": "string", "nullable": true }, "nomeMae": { "type": "string", "nullable": true }, "dataNascimento": { "type": "string", "nullable": true }, "possuiAntecedentesCriminais": { "type": "boolean", "nullable": true }, "numeroCertidao": { "type": "string", "nullable": true }, "dataValidade": { "type": "string", "nullable": true }, "dataEmissao": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PoliciaFederalAntecedentesCriminaisRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/PoliciaFederalAntecedentesCriminais" } }, "additionalProperties": false }, "PortalTransparenciaIndicadoresPessoaFisica": { "type": "object", "properties": { "cpf": { "type": "string", "nullable": true }, "nome": { "type": "string", "nullable": true }, "nis": { "type": "string", "nullable": true }, "favorecidoDespesas": { "type": "boolean", "nullable": true }, "servidor": { "type": "boolean", "nullable": true }, "beneficiarioDiarias": { "type": "boolean", "nullable": true }, "permissionario": { "type": "boolean", "nullable": true }, "contratado": { "type": "boolean", "nullable": true }, "sancionadoCEIS": { "type": "boolean", "nullable": true }, "sancionadoCNEP": { "type": "boolean", "nullable": true }, "sancionadoCEAF": { "type": "boolean", "nullable": true }, "portadorCPDC": { "type": "boolean", "nullable": true }, "portadorCPGF": { "type": "boolean", "nullable": true }, "favorecidoBolsaFamilia": { "type": "boolean", "nullable": true }, "favorecidoPeti": { "type": "boolean", "nullable": true }, "favorecidoSafra": { "type": "boolean", "nullable": true }, "favorecidoSeguroDefeso": { "type": "boolean", "nullable": true }, "favorecidoBPC": { "type": "boolean", "nullable": true }, "favorecidoTransferencias": { "type": "boolean", "nullable": true }, "favorecidoCPCC": { "type": "boolean", "nullable": true }, "favorecidoCPDC": { "type": "boolean", "nullable": true }, "favorecidoCPGF": { "type": "boolean", "nullable": true }, "participanteLicitacao": { "type": "boolean", "nullable": true }, "servidorInativo": { "type": "boolean", "nullable": true }, "pensionistaOuRepresentanteLegal": { "type": "boolean", "nullable": true }, "instituidorPensao": { "type": "boolean", "nullable": true }, "auxilioEmergencial": { "type": "boolean", "nullable": true }, "favorecidoAuxilioBrasil": { "type": "boolean", "nullable": true }, "favorecidoNovoBolsaFamilia": { "type": "boolean", "nullable": true }, "favorecidoAuxilioReconstrucao": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "PortalTransparenciaIndicadoresPessoaFisicaRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/PortalTransparenciaIndicadoresPessoaFisica" } }, "additionalProperties": false }, "PortalTransparenciaIndicadoresPessoaJuridica": { "type": "object", "properties": { "cnpj": { "type": "string", "nullable": true }, "razaoSocial": { "type": "string", "nullable": true }, "nomeFantasia": { "type": "string", "nullable": true }, "favorecidoDespesas": { "type": "boolean", "nullable": true }, "possuiContratacao": { "type": "boolean", "nullable": true }, "convenios": { "type": "boolean", "nullable": true }, "favorecidoTransferencias": { "type": "boolean", "nullable": true }, "sancionadoCEPIM": { "type": "boolean", "nullable": true }, "sancionadoCEIS": { "type": "boolean", "nullable": true }, "sancionadoCNEP": { "type": "boolean", "nullable": true }, "sancionadoCEAF": { "type": "boolean", "nullable": true }, "participanteLicitacao": { "type": "boolean", "nullable": true }, "emitiuNFe": { "type": "boolean", "nullable": true }, "beneficiadoRenunciaFiscal": { "type": "boolean", "nullable": true }, "isentoImuneRenunciaFiscal": { "type": "boolean", "nullable": true }, "habilitadoRenunciaFiscal": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "PortalTransparenciaIndicadoresPessoaJuridicaRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/PortalTransparenciaIndicadoresPessoaJuridica" } }, "additionalProperties": false }, "PortalTransparenciaServidores": { "type": "object", "properties": { "cpf": { "type": "string", "nullable": true }, "nome": { "type": "string", "nullable": true }, "possuiRegistros": { "type": "boolean" }, "observacoes": { "type": "string", "nullable": true }, "vinculos": { "type": "array", "items": { "$ref": "#/components/schemas/VinculoServidorFederal" }, "nullable": true } }, "additionalProperties": false }, "PortalTransparenciaServidoresCompleta": { "type": "object", "properties": { "cpf": { "type": "string", "nullable": true }, "nome": { "type": "string", "nullable": true }, "uf": { "type": "string", "nullable": true }, "possuiRegistros": { "type": "boolean" }, "observacoes": { "type": "string", "nullable": true }, "vinculosVigentes": { "type": "array", "items": { "$ref": "#/components/schemas/VinculoVigente" }, "nullable": true }, "remuneracoes": { "type": "array", "items": { "$ref": "#/components/schemas/RemuneracaoMes" }, "nullable": true }, "historicoVinculos": { "type": "array", "items": { "$ref": "#/components/schemas/VinculoHistorico" }, "nullable": true } }, "additionalProperties": false }, "PortalTransparenciaServidoresCompletaRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/PortalTransparenciaServidoresCompleta" } }, "additionalProperties": false }, "PortalTransparenciaServidoresRemuneracao": { "type": "object", "properties": { "cpf": { "type": "string", "nullable": true }, "nome": { "type": "string", "nullable": true }, "mesAnoReferencia": { "type": "string", "nullable": true }, "possuiRegistros": { "type": "boolean" }, "observacoes": { "type": "string", "nullable": true }, "remuneracoes": { "type": "array", "items": { "$ref": "#/components/schemas/RemuneracaoVinculo" }, "nullable": true } }, "additionalProperties": false }, "PortalTransparenciaServidoresRemuneracaoRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/PortalTransparenciaServidoresRemuneracao" } }, "additionalProperties": false }, "PortalTransparenciaServidoresRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/PortalTransparenciaServidores" } }, "additionalProperties": false }, "PortalTransparenciaServidoresViagens": { "type": "object", "properties": { "cpf": { "type": "string", "nullable": true }, "nome": { "type": "string", "nullable": true }, "possuiRegistros": { "type": "boolean" }, "observacoes": { "type": "string", "nullable": true }, "quantidadeViagens": { "type": "integer", "format": "int32" }, "valorTotalViagens": { "type": "string", "nullable": true }, "viagens": { "type": "array", "items": { "$ref": "#/components/schemas/ViagemServico" }, "nullable": true } }, "additionalProperties": false }, "PortalTransparenciaServidoresViagensRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/PortalTransparenciaServidoresViagens" } }, "additionalProperties": false }, "PostCodeEntity": { "type": "object", "properties": { "postCode": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "distance": { "type": "integer", "format": "int32", "nullable": true }, "descriptionOnFirstFiveDigits": { "type": "string", "nullable": true }, "distanceOnFirstFiveDigits": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "PrimeiroGrau": { "type": "object", "properties": { "totalProcessos": { "type": "integer", "format": "int32", "nullable": true }, "foros": { "type": "array", "items": { "$ref": "#/components/schemas/ForoTJ" }, "nullable": true } }, "additionalProperties": false }, "ProcedimentoExtrajudicial": { "type": "object", "properties": { "etiqueta": { "type": "string", "nullable": true }, "localizacao": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ProcedimentoInvestigatorioExtrajudicial": { "type": "object", "properties": { "numeroSIMP": { "type": "string", "nullable": true }, "classe": { "type": "string", "nullable": true }, "comarca": { "type": "string", "nullable": true }, "promotoriaResponsavel": { "type": "string", "nullable": true }, "observacao": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Processo": { "type": "object", "properties": { "numero": { "type": "string", "nullable": true }, "classeProcessual": { "type": "string", "nullable": true }, "juizo": { "type": "string", "nullable": true }, "local": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ProcessoJudiciailSimplificada": { "type": "object", "properties": { "documentoConsultado": { "type": "string", "nullable": true }, "totalProcessos": { "type": "integer", "format": "int32", "nullable": true }, "observacoes": { "type": "string", "nullable": true }, "processos": { "type": "array", "items": { "$ref": "#/components/schemas/ProcessosSimplificadaLista" }, "nullable": true } }, "additionalProperties": false }, "ProcessoPrimeiroGrau": { "type": "object", "properties": { "numeroProcesso": { "$ref": "#/components/schemas/NumeroProcesso" }, "classe": { "type": "string", "nullable": true }, "assunto": { "type": "string", "nullable": true }, "vara": { "type": "string", "nullable": true }, "juiz": { "type": "string", "nullable": true }, "controle": { "type": "string", "nullable": true }, "area": { "type": "string", "nullable": true }, "valorAcao": { "type": "number", "format": "double", "nullable": true }, "outrosAssuntos": { "type": "string", "nullable": true }, "distribuicao": { "$ref": "#/components/schemas/DistribuicaoTJ" }, "partesProcesso": { "type": "array", "items": { "$ref": "#/components/schemas/PartesProcesso" }, "nullable": true }, "movimentacoes": { "type": "array", "items": { "$ref": "#/components/schemas/Movimentacoes" }, "nullable": true }, "peticoesDiversas": { "type": "array", "items": { "$ref": "#/components/schemas/Peticao" }, "nullable": true }, "incidentes": { "type": "array", "items": { "$ref": "#/components/schemas/SubprocessosRecursos" }, "nullable": true }, "apensos": { "type": "array", "items": { "$ref": "#/components/schemas/Apenso" }, "nullable": true }, "audiencias": { "type": "array", "items": { "$ref": "#/components/schemas/Audiencia1Grau" }, "nullable": true } }, "additionalProperties": false }, "ProcessoSegundoGrau": { "type": "object", "properties": { "numeroProcesso": { "$ref": "#/components/schemas/NumeroProcesso" }, "classe": { "type": "string", "nullable": true }, "assunto": { "type": "string", "nullable": true }, "secao": { "type": "string", "nullable": true }, "orgaoJulgador": { "type": "string", "nullable": true }, "area": { "type": "string", "nullable": true }, "valorAcao": { "type": "number", "format": "double", "nullable": true }, "relator": { "type": "string", "nullable": true }, "origem": { "type": "string", "nullable": true }, "volumeApenso": { "type": "string", "nullable": true }, "partesProcesso": { "type": "array", "items": { "$ref": "#/components/schemas/PartesProcesso" }, "nullable": true }, "movimentacoes": { "type": "array", "items": { "$ref": "#/components/schemas/Movimentacoes" }, "nullable": true }, "numerosPrimeiraInstancia": { "type": "array", "items": { "$ref": "#/components/schemas/NumeroPrimeiraInstancia" }, "nullable": true }, "peticoesDiversas": { "type": "array", "items": { "$ref": "#/components/schemas/Peticao" }, "nullable": true }, "subprocessosRecursos": { "type": "array", "items": { "$ref": "#/components/schemas/SubprocessosRecursos" }, "nullable": true }, "composicaoJulgamentos": { "type": "array", "items": { "$ref": "#/components/schemas/ComposicaoJulgamento" }, "nullable": true }, "julgamentos": { "type": "array", "items": { "$ref": "#/components/schemas/Julgamento" }, "nullable": true } }, "additionalProperties": false }, "ProcessoTCU": { "type": "object", "properties": { "numeroProcesso": { "type": "string", "nullable": true }, "tipo": { "type": "string", "nullable": true }, "assunto": { "type": "string", "nullable": true }, "estadoProcesso": { "type": "string", "nullable": true }, "qualificacao": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ProcessoTRT": { "type": "object", "properties": { "local": { "type": "string", "nullable": true }, "processo": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "ProcessoTST": { "type": "object", "properties": { "codigo": { "type": "string", "nullable": true }, "local": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ProcessosCarf": { "type": "object", "properties": { "numeroProcesso": { "type": "string", "nullable": true }, "dataEntrada": { "type": "string", "nullable": true }, "tributo": { "type": "string", "nullable": true }, "recursos": { "type": "array", "items": { "$ref": "#/components/schemas/Recursos" }, "nullable": true }, "andamentos": { "type": "array", "items": { "$ref": "#/components/schemas/Andamentos" }, "nullable": true } }, "additionalProperties": false }, "ProcessosCompletaLista": { "type": "object", "properties": { "numeroProcesso": { "type": "string", "nullable": true }, "instancia": { "type": "integer", "format": "int32", "nullable": true }, "justicaGratuita": { "type": "boolean", "nullable": true }, "segredoJustica": { "type": "boolean", "nullable": true }, "processoDigital": { "type": "boolean", "nullable": true }, "tutelaAntecipada": { "type": "boolean", "nullable": true }, "prioritario": { "type": "boolean", "nullable": true }, "orgaoJulgador": { "$ref": "#/components/schemas/OrgaoJulgador" }, "ambitoJustica": { "type": "string", "nullable": true }, "sistema": { "type": "string", "nullable": true }, "areaDireito": { "type": "string", "nullable": true }, "classificacao": { "$ref": "#/components/schemas/ClassificacaoProcesso" }, "assuntos": { "type": "array", "items": { "$ref": "#/components/schemas/AssuntoProcesso" }, "nullable": true }, "dataDistribuicao": { "type": "string", "nullable": true }, "dataAutuacao": { "type": "string", "nullable": true }, "partes": { "type": "array", "items": { "$ref": "#/components/schemas/Partes" }, "nullable": true }, "valorProcesso": { "type": "string", "nullable": true }, "processosRelacionados": { "type": "array", "items": { "type": "string" }, "nullable": true }, "detalhesStatusProcesso": { "$ref": "#/components/schemas/DetalhesStatusProcesso" } }, "additionalProperties": false }, "ProcessosDistribuicaoPorAno": { "type": "object", "properties": { "totalPorAno": { "type": "integer", "format": "int32", "nullable": true }, "ano": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ProcessosJudiciaisAgrupada": { "type": "object", "properties": { "documentoConsultado": { "type": "string", "nullable": true }, "segmentos": { "type": "array", "items": { "$ref": "#/components/schemas/ProcessosSegmentos" }, "nullable": true }, "tribunais": { "type": "array", "items": { "$ref": "#/components/schemas/ProcessosTribunais" }, "nullable": true }, "distribuicaoPorAno": { "type": "array", "items": { "$ref": "#/components/schemas/ProcessosDistribuicaoPorAno" }, "nullable": true }, "areasDireito": { "type": "array", "items": { "$ref": "#/components/schemas/ProcessossAreaDireito" }, "nullable": true }, "totalProcessos": { "type": "integer", "format": "int32", "nullable": true }, "observacoes": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ProcessosJudiciaisAgrupadaRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/ProcessosJudiciaisAgrupada" } }, "additionalProperties": false }, "ProcessosJudiciaisCompleta": { "type": "object", "properties": { "documentoConsultado": { "type": "string", "nullable": true }, "processos": { "type": "array", "items": { "$ref": "#/components/schemas/ProcessosCompletaLista" }, "nullable": true }, "totalProcessos": { "type": "integer", "format": "int32", "nullable": true }, "observacoes": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ProcessosJudiciaisCompletaRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/ProcessosJudiciaisCompleta" } }, "additionalProperties": false }, "ProcessosJudiciaisSimplificadaRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/ProcessoJudiciailSimplificada" } }, "additionalProperties": false }, "ProcessosSegmentos": { "type": "object", "properties": { "totalPorSegmento": { "type": "integer", "format": "int32", "nullable": true }, "segmento": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ProcessosSimplificadaLista": { "type": "object", "properties": { "numeroProcesso": { "type": "string", "nullable": true }, "tribunal": { "type": "string", "nullable": true }, "grau": { "type": "string", "nullable": true }, "classe": { "type": "string", "nullable": true }, "assuntoPrincipal": { "type": "string", "nullable": true }, "segmento": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "valorAcao": { "type": "number", "format": "double", "nullable": true }, "dataAjuizamento": { "type": "string", "nullable": true }, "partes": { "type": "array", "items": { "$ref": "#/components/schemas/PartesSimplificada" }, "nullable": true }, "ultimaMovimentacao": { "$ref": "#/components/schemas/UltimaMovimentacao" } }, "additionalProperties": false }, "ProcessosTribunais": { "type": "object", "properties": { "totalPorTribunal": { "type": "integer", "format": "int32", "nullable": true }, "tribunal": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ProcessossAreaDireito": { "type": "object", "properties": { "areaDireito": { "type": "string", "nullable": true }, "tipoAreaDireito": { "type": "string", "nullable": true }, "totalProcessosArea": { "type": "integer", "format": "int32", "nullable": true }, "totalValorProcessosArea": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ProdutoDAP": { "type": "object", "properties": { "nome": { "type": "string", "nullable": true }, "codigo": { "type": "string", "nullable": true }, "valorAuferido": { "type": "string", "nullable": true }, "valorEstimada": { "type": "string", "nullable": true }, "observacao": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ProtestaOnline": { "type": "object", "properties": { "estado": { "type": "string", "nullable": true }, "numeroTotalProtestosUF": { "type": "integer", "format": "int32", "nullable": true }, "valorTotalProtestosEstado": { "type": "string", "nullable": true }, "cartorios": { "type": "array", "items": { "$ref": "#/components/schemas/CartorioOnline" }, "nullable": true } }, "additionalProperties": false }, "ProtestoDCC": { "type": "object", "properties": { "situacao": { "type": "string", "nullable": true }, "valorTotal": { "type": "number", "format": "double", "nullable": true }, "cartorios": { "type": "array", "items": { "$ref": "#/components/schemas/CartorioDCC" }, "nullable": true }, "observacao": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ProtestoDN": { "type": "object", "properties": { "situacao": { "type": "string", "nullable": true }, "valorTotal": { "type": "number", "format": "double", "nullable": true }, "cartorios": { "type": "array", "items": { "$ref": "#/components/schemas/CartorioDN" }, "nullable": true }, "observacao": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ProtestoDetalhe": { "type": "object", "properties": { "data": { "type": "string", "nullable": true }, "moeda": { "type": "string", "nullable": true }, "valor": { "type": "string", "nullable": true }, "valorCustas": { "type": "string", "nullable": true }, "quantidade": { "type": "string", "nullable": true }, "cartorio": { "type": "string", "nullable": true }, "origem": { "type": "string", "nullable": true }, "credor": { "type": "string", "nullable": true }, "anuencia": { "type": "string", "nullable": true }, "tipoAnotacao": { "type": "string", "nullable": true }, "subjudice": { "type": "string", "nullable": true }, "vencimento": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ProtestoDetalheDefineLimitePositivoPJ": { "type": "object", "properties": { "data": { "type": "string", "nullable": true }, "moeda": { "type": "string", "nullable": true }, "valor": { "type": "string", "nullable": true }, "valorCustas": { "type": "string", "nullable": true }, "quantidade": { "type": "string", "nullable": true }, "cartorio": { "type": "string", "nullable": true }, "origem": { "type": "string", "nullable": true }, "credor": { "type": "string", "nullable": true }, "anuencia": { "type": "string", "nullable": true }, "tipoAnotacao": { "type": "string", "nullable": true }, "subjudice": { "type": "string", "nullable": true }, "vencimento": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ProtestoOcorrenciaAcertaCompletoPF": { "type": "object", "properties": { "data": { "type": "string", "nullable": true }, "moeda": { "type": "string", "nullable": true }, "valor": { "type": "string", "nullable": true }, "valorCustas": { "type": "string", "nullable": true }, "quantidade": { "type": "string", "nullable": true }, "cartorio": { "type": "string", "nullable": true }, "origem": { "type": "string", "nullable": true }, "credor": { "type": "string", "nullable": true }, "anuencia": { "type": "string", "nullable": true }, "tipoAnotacao": { "type": "string", "nullable": true }, "subjudice": { "type": "string", "nullable": true }, "vencimento": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ProtestosAcertaCompletoPF": { "type": "object", "properties": { "quantidadeOcorrencia": { "type": "string", "nullable": true }, "valorTotal": { "type": "string", "nullable": true }, "ultimoProtesto": { "type": "string", "nullable": true }, "dataPrimeiro": { "type": "string", "nullable": true }, "valorPrimeiro": { "type": "string", "nullable": true }, "dataUltimo": { "type": "string", "nullable": true }, "valorUltimo": { "type": "string", "nullable": true }, "dataMaior": { "type": "string", "nullable": true }, "valorMaior": { "type": "string", "nullable": true }, "ocorrencias": { "type": "array", "items": { "$ref": "#/components/schemas/ProtestoOcorrenciaAcertaCompletoPF" }, "nullable": true } }, "additionalProperties": false }, "ProtestosBasica": { "type": "object", "properties": { "documentoConsultado": { "type": "string", "nullable": true }, "dataConsulta": { "type": "string", "nullable": true }, "constamProtestos": { "type": "boolean", "nullable": true }, "numeroTotalProtestos": { "type": "integer", "format": "int32", "nullable": true }, "valorTotalProtestos": { "type": "string", "nullable": true }, "cnaeDevedor": { "type": "string", "nullable": true }, "observacoes": { "type": "string", "nullable": true }, "documentos": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentoBasica" }, "nullable": true } }, "additionalProperties": false }, "ProtestosBasicaRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/ProtestosBasica" } }, "additionalProperties": false }, "ProtestosCompleta": { "type": "object", "properties": { "documentoConsultado": { "type": "string", "nullable": true }, "dataConsulta": { "type": "string", "nullable": true }, "constamProtestos": { "type": "boolean", "nullable": true }, "numeroTotalProtestos": { "type": "integer", "format": "int32", "nullable": true }, "valorTotalProtestos": { "type": "string", "nullable": true }, "cnaeDevedor": { "type": "string", "nullable": true }, "observacoes": { "type": "string", "nullable": true }, "documentos": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentoCompleta" }, "nullable": true } }, "additionalProperties": false }, "ProtestosCompletaRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/ProtestosCompleta" } }, "additionalProperties": false }, "ProtestosOcorrencia": { "type": "object", "properties": { "data": { "type": "string", "nullable": true }, "moeda": { "type": "string", "nullable": true }, "valor": { "type": "string", "nullable": true }, "valorCustas": { "type": "string", "nullable": true }, "quantidade": { "type": "string", "nullable": true }, "cartorio": { "type": "string", "nullable": true }, "origem": { "type": "string", "nullable": true }, "credor": { "type": "string", "nullable": true }, "anuencia": { "type": "string", "nullable": true }, "tipoAnotacao": { "type": "string", "nullable": true }, "subjudice": { "type": "string", "nullable": true }, "vencimento": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ProtestosOnline": { "type": "object", "properties": { "documentoConsultado": { "type": "string", "nullable": true }, "constamProtestos": { "type": "boolean", "nullable": true }, "numeroTotalProtestos": { "type": "integer", "format": "int32", "nullable": true }, "valorTotalProtestos": { "type": "string", "nullable": true }, "observacoes": { "type": "string", "nullable": true }, "protestos": { "type": "array", "items": { "$ref": "#/components/schemas/ProtestaOnline" }, "nullable": true } }, "additionalProperties": false }, "ProtestosOnlineRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/ProtestosOnline" } }, "additionalProperties": false }, "ProtestosPF": { "type": "object", "properties": { "quantidadeOcorrencia": { "type": "string", "nullable": true }, "valorTotal": { "type": "string", "nullable": true }, "ultimoProtesto": { "type": "string", "nullable": true }, "dataPrimeiro": { "type": "string", "nullable": true }, "valorPrimeiro": { "type": "string", "nullable": true }, "dataUltimo": { "type": "string", "nullable": true }, "valorUltimo": { "type": "string", "nullable": true }, "dataMaior": { "type": "string", "nullable": true }, "valorMaior": { "type": "string", "nullable": true }, "ocorrencias": { "type": "array", "items": { "$ref": "#/components/schemas/ProtestosOcorrencia" }, "nullable": true } }, "additionalProperties": false }, "ProtestosResumo": { "type": "object", "properties": { "quantidade": { "type": "string", "nullable": true }, "valorTotal": { "type": "string", "nullable": true }, "ultimoProtesto": { "type": "string", "nullable": true }, "dataPrimeiro": { "type": "string", "nullable": true }, "dataUltimo": { "type": "string", "nullable": true }, "dataMaior": { "type": "string", "nullable": true }, "valorPrimeiro": { "type": "string", "nullable": true }, "valorUltimo": { "type": "string", "nullable": true }, "valorMaior": { "type": "string", "nullable": true }, "ocorrencias": { "type": "array", "items": { "$ref": "#/components/schemas/ProtestoDetalhe" }, "nullable": true } }, "additionalProperties": false }, "ProtestosResumoDefineLimitePositivoPJ": { "type": "object", "properties": { "quantidade": { "type": "string", "nullable": true }, "valorTotal": { "type": "string", "nullable": true }, "ultimoProtesto": { "type": "string", "nullable": true }, "dataPrimeiro": { "type": "string", "nullable": true }, "dataUltimo": { "type": "string", "nullable": true }, "dataMaior": { "type": "string", "nullable": true }, "valorPrimeiro": { "type": "string", "nullable": true }, "valorUltimo": { "type": "string", "nullable": true }, "valorMaior": { "type": "string", "nullable": true }, "ocorrencias": { "type": "array", "items": { "$ref": "#/components/schemas/ProtestoDetalheDefineLimitePositivoPJ" }, "nullable": true } }, "additionalProperties": false }, "ProvedorAcertaCompletoPF": { "type": "object", "properties": { "provedor": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ProvedorPF": { "type": "object", "properties": { "provedor": { "type": "string", "nullable": true } }, "additionalProperties": false }, "QuadroSocietario": { "type": "object", "properties": { "informacoes": { "type": "array", "items": { "$ref": "#/components/schemas/DadoEmpresarial" }, "nullable": true }, "capitalSocial": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "RecallPendente": { "type": "object", "properties": { "tipo": { "type": "integer", "format": "int32", "nullable": true }, "dataOcorrencia": { "type": "string", "nullable": true }, "chassi": { "type": "string", "nullable": true }, "montadora": { "type": "string", "nullable": true }, "marcaModelo": { "type": "string", "nullable": true }, "anoModelo": { "type": "string", "nullable": true }, "anoFabricacao": { "type": "string", "nullable": true }, "nomeRecall": { "type": "string", "nullable": true }, "descricaoRecall": { "type": "string", "nullable": true }, "dataRegistro": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ReceitaFederalPessoaFisicaRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/ReceitaPessoaFisica" } }, "additionalProperties": false }, "ReceitaFederalPessoaJuridica": { "type": "object", "properties": { "numeroInscricao": { "type": "string", "nullable": true }, "matriz": { "type": "boolean", "nullable": true }, "dataAbertura": { "type": "string", "nullable": true }, "nomeEmpresarial": { "type": "string", "nullable": true }, "nomeFantasia": { "type": "string", "nullable": true }, "porte": { "type": "string", "nullable": true }, "atividadeEconomicaPrincipal": { "type": "string", "nullable": true }, "atividadesEconomicasSecundarias": { "type": "array", "items": { "type": "string" }, "nullable": true }, "naturezaJuridica": { "type": "string", "nullable": true }, "logradouro": { "type": "string", "nullable": true }, "numero": { "type": "string", "nullable": true }, "complemento": { "type": "string", "nullable": true }, "cep": { "type": "string", "nullable": true }, "bairroDistrito": { "type": "string", "nullable": true }, "municipio": { "type": "string", "nullable": true }, "uf": { "type": "string", "nullable": true }, "situacaoCadastral": { "type": "string", "nullable": true }, "dataSituacaoCadastral": { "type": "string", "nullable": true }, "motivoSituacaoCadastral": { "type": "string", "nullable": true }, "situacaoEspecial": { "type": "string", "nullable": true }, "dataSituacaoEspecial": { "type": "string", "nullable": true }, "dataEmissao": { "type": "string", "nullable": true }, "dataConsulta": { "type": "string", "nullable": true }, "enderecoEletronico": { "type": "string", "nullable": true }, "telefone": { "type": "string", "nullable": true }, "efr": { "type": "string", "nullable": true }, "capitalSocialQSA": { "type": "string", "nullable": true }, "emRecuperJudicial": { "type": "boolean", "nullable": true }, "socios": { "type": "array", "items": { "$ref": "#/components/schemas/SocioReceita" }, "nullable": true } }, "additionalProperties": false }, "ReceitaFederalPessoaJuridicaRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/ReceitaFederalPessoaJuridica" } }, "additionalProperties": false }, "ReceitaPJParticipacaoSocietaria": { "type": "object", "properties": { "numeroInscricao": { "type": "string", "nullable": true }, "matriz": { "type": "boolean", "nullable": true }, "dataAbertura": { "type": "string", "nullable": true }, "nomeEmpresarial": { "type": "string", "nullable": true }, "nomeFantasia": { "type": "string", "nullable": true }, "porte": { "type": "string", "nullable": true }, "atividadeEconomicaPrincipal": { "type": "string", "nullable": true }, "atividadesEconomicasSecundarias": { "type": "array", "items": { "type": "string" }, "nullable": true }, "naturezaJuridica": { "type": "string", "nullable": true }, "logradouro": { "type": "string", "nullable": true }, "numero": { "type": "string", "nullable": true }, "complemento": { "type": "string", "nullable": true }, "cep": { "type": "string", "nullable": true }, "bairroDistrito": { "type": "string", "nullable": true }, "municipio": { "type": "string", "nullable": true }, "uf": { "type": "string", "nullable": true }, "situacaoCadastral": { "type": "string", "nullable": true }, "dataSituacaoCadastral": { "type": "string", "nullable": true }, "motivoSituacaoCadastral": { "type": "string", "nullable": true }, "situacaoEspecial": { "type": "string", "nullable": true }, "dataSituacaoEspecial": { "type": "string", "nullable": true }, "dataEmissao": { "type": "string", "nullable": true }, "dataConsulta": { "type": "string", "nullable": true }, "enderecoEletronico": { "type": "string", "nullable": true }, "telefone": { "type": "string", "nullable": true }, "efr": { "type": "string", "nullable": true }, "capitalSocialQSA": { "type": "string", "nullable": true }, "emRecuperacaoJudicial": { "type": "boolean", "nullable": true }, "socios": { "type": "array", "items": { "$ref": "#/components/schemas/Socios" }, "nullable": true } }, "additionalProperties": false }, "ReceitaPJParticipacaoSocietariaRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/ReceitaPJParticipacaoSocietaria" } }, "additionalProperties": false }, "ReceitaPessoaFisica": { "type": "object", "properties": { "numeroCPF": { "type": "string", "nullable": true }, "nomePessoaFisica": { "type": "string", "nullable": true }, "nomeSocial": { "type": "string", "nullable": true }, "dataNascimento": { "type": "string", "nullable": true }, "situacaoCadastral": { "type": "string", "nullable": true }, "dataInscricao": { "type": "string", "nullable": true }, "dataInscricaoAnterior1990": { "type": "boolean", "nullable": true }, "digitoVerificador": { "type": "string", "nullable": true }, "dataEmissao": { "type": "string", "nullable": true }, "codigoControleComprovante": { "type": "string", "nullable": true }, "dataConsulta": { "type": "string", "nullable": true }, "possuiObito": { "type": "boolean", "nullable": true }, "anoObito": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Recursos": { "type": "object", "properties": { "dataEntrada": { "type": "string", "nullable": true }, "tipoRecurso": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RegistrationDataArgentina": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "dateOfBirth": { "type": "string", "nullable": true }, "gender": { "type": "string", "nullable": true }, "age": { "type": "integer", "format": "int32", "nullable": true }, "phones": { "type": "array", "items": { "$ref": "#/components/schemas/Telephone" }, "nullable": true }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/Address" }, "nullable": true }, "emails": { "type": "array", "items": { "$ref": "#/components/schemas/EmailE" }, "nullable": true }, "salaryRange": { "type": "string", "nullable": true }, "estimatedSalary": { "type": "string", "nullable": true }, "dni": { "type": "string", "nullable": true }, "nationality": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RegistrationDataArgentinaRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/RegistrationDataArgentina" } }, "additionalProperties": false }, "RegistrationDataBrazil": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "dateOfBirth": { "type": "string", "nullable": true }, "gender": { "type": "string", "nullable": true }, "age": { "type": "integer", "format": "int32", "nullable": true }, "phones": { "type": "array", "items": { "$ref": "#/components/schemas/Telephone" }, "nullable": true }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/Address" }, "nullable": true }, "emails": { "type": "array", "items": { "$ref": "#/components/schemas/EmailE" }, "nullable": true }, "salaryRange": { "type": "string", "nullable": true }, "estimatedSalary": { "type": "string", "nullable": true }, "cpf": { "type": "string", "nullable": true }, "nameMother": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RegistrationDataBrazilRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/RegistrationDataBrazil" } }, "additionalProperties": false }, "RegistrationDataMexico": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "dateOfBirth": { "type": "string", "nullable": true }, "gender": { "type": "string", "nullable": true }, "age": { "type": "integer", "format": "int32", "nullable": true }, "phones": { "type": "array", "items": { "$ref": "#/components/schemas/Telephone" }, "nullable": true }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/Address" }, "nullable": true }, "emails": { "type": "array", "items": { "$ref": "#/components/schemas/EmailE" }, "nullable": true }, "salaryRange": { "type": "string", "nullable": true }, "estimatedSalary": { "type": "string", "nullable": true }, "curp": { "type": "string", "nullable": true }, "rfc": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RegistrationDataMexicoRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/RegistrationDataMexico" } }, "additionalProperties": false }, "RemuneracaoMensal": { "type": "object", "properties": { "mesAno": { "type": "string", "nullable": true }, "remuneracaoBasicaBruta": { "type": "string", "nullable": true }, "abateTetoRemuneracaoBasica": { "type": "string", "nullable": true }, "gratificacaoNatalina": { "type": "string", "nullable": true }, "abateTetoGratificacaoNatalina": { "type": "string", "nullable": true }, "ferias": { "type": "string", "nullable": true }, "outrasRemuneracoesEventuais": { "type": "string", "nullable": true }, "impostoRetidoNaFonte": { "type": "string", "nullable": true }, "previdenciaOficial": { "type": "string", "nullable": true }, "outrasDeducoesObrigatorias": { "type": "string", "nullable": true }, "pensaoMilitar": { "type": "string", "nullable": true }, "fundoSaude": { "type": "string", "nullable": true }, "taxaOcupacaoImovelFuncional": { "type": "string", "nullable": true }, "remuneracaoAposDeducoesObrigatorias": { "type": "string", "nullable": true }, "verbasIndenizatoriasCivil": { "type": "string", "nullable": true }, "verbasIndenizatoriasMilitar": { "type": "string", "nullable": true }, "verbasIndenizatoriasPDV": { "type": "string", "nullable": true }, "totalVerbasIndenizatorias": { "type": "string", "nullable": true }, "valorTotalJetons": { "type": "string", "nullable": true }, "valorTotalHonorariosAdvocaticios": { "type": "string", "nullable": true }, "rubricas": { "type": "array", "items": { "$ref": "#/components/schemas/RubricaRemuneracao" }, "nullable": true }, "jetons": { "type": "array", "items": { "$ref": "#/components/schemas/JetomRemuneracao" }, "nullable": true }, "honorariosAdvocaticios": { "type": "array", "items": { "$ref": "#/components/schemas/HonorarioAdvocaticio" }, "nullable": true }, "observacoesPortal": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "RemuneracaoMes": { "type": "object", "properties": { "mesAno": { "type": "string", "nullable": true }, "tipoFicha": { "type": "string", "nullable": true }, "remuneracaoBasicaBruta": { "type": "string", "nullable": true }, "abateTetoRemuneracaoBasica": { "type": "string", "nullable": true }, "gratificacaoNatalina": { "type": "string", "nullable": true }, "abateTetoGratificacaoNatalina": { "type": "string", "nullable": true }, "ferias": { "type": "string", "nullable": true }, "outrasRemuneracoesEventuais": { "type": "string", "nullable": true }, "impostoRetidoNaFonte": { "type": "string", "nullable": true }, "previdenciaOficial": { "type": "string", "nullable": true }, "outrasDeducoesObrigatorias": { "type": "string", "nullable": true }, "pensaoMilitar": { "type": "string", "nullable": true }, "fundoSaude": { "type": "string", "nullable": true }, "taxaOcupacaoImovelFuncional": { "type": "string", "nullable": true }, "totalAposDeducoes": { "type": "string", "nullable": true }, "verbasIndenizatorias": { "type": "array", "items": { "$ref": "#/components/schemas/ItemRemuneracaoValor" }, "nullable": true }, "totalVerbasIndenizatorias": { "type": "string", "nullable": true }, "honorariosAdvocaticios": { "type": "array", "items": { "$ref": "#/components/schemas/ItemRemuneracaoValor" }, "nullable": true }, "totalHonorariosAdvocaticios": { "type": "string", "nullable": true }, "observacoes": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "RemuneracaoVinculo": { "type": "object", "properties": { "servidor": { "$ref": "#/components/schemas/ServidorRemuneracao" }, "observacao": { "type": "string", "nullable": true }, "valores": { "type": "array", "items": { "$ref": "#/components/schemas/RemuneracaoMensal" }, "nullable": true } }, "additionalProperties": false }, "RenainfDetalhes": { "type": "object", "properties": { "cadastroInfracao": { "type": "string", "nullable": true }, "codigoInfracao": { "type": "string", "nullable": true }, "codigoMunicipalEmplacamento": { "type": "string", "nullable": true }, "codigoMunicipalInfracao": { "type": "string", "nullable": true }, "dataEmissaoPenalidade": { "type": "string", "nullable": true }, "dataInfracao": { "type": "string", "nullable": true }, "dataNotificacaoInfracao": { "type": "string", "nullable": true }, "horaInfracao": { "type": "string", "nullable": true }, "limitePermitido": { "type": "string", "nullable": true }, "localInfracao": { "type": "string", "nullable": true }, "marcaModelo": { "type": "string", "nullable": true }, "medicaoConsiderada": { "type": "string", "nullable": true }, "medicaoReal": { "type": "string", "nullable": true }, "numeroAutoInfracao": { "type": "string", "nullable": true }, "orgaoAutuador": { "type": "string", "nullable": true }, "ufOrgaoAutuador": { "type": "string", "nullable": true }, "placa": { "type": "string", "nullable": true }, "ufPlaca": { "type": "string", "nullable": true }, "ufJurisdicaoVeiculo": { "type": "string", "nullable": true }, "tipoAutoInfracao": { "type": "string", "nullable": true }, "valorInfracao": { "type": "string", "nullable": true }, "unidadeMedida": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RenainfRegistro": { "type": "object", "properties": { "autoInfracao": { "type": "string", "nullable": true }, "dataInfracao": { "type": "string", "nullable": true }, "exigibilidade": { "type": "string", "nullable": true }, "infracao": { "type": "string", "nullable": true }, "orgaoAutuador": { "type": "string", "nullable": true }, "detalhes": { "$ref": "#/components/schemas/RenainfDetalhes" } }, "additionalProperties": false }, "RenajudOcorrencia": { "type": "object", "properties": { "status": { "type": "string", "nullable": true }, "tipoRestricao": { "type": "string", "nullable": true }, "numeroProcesso": { "type": "string", "nullable": true }, "dataInclusao": { "type": "string", "nullable": true }, "magistradoInclusao": { "type": "string", "nullable": true }, "dataExclusao": { "type": "string", "nullable": true }, "magistradoExclusao": { "type": "string", "nullable": true }, "tribunal": { "type": "string", "nullable": true }, "orgaoJulgador": { "type": "string", "nullable": true }, "orgaoJulgadorUf": { "type": "string", "nullable": true }, "orgaoJulgadorMunicipio": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RenajudProprietario": { "type": "object", "properties": { "nome": { "type": "string", "nullable": true }, "documento": { "type": "string", "nullable": true }, "endereco": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RendaDAP": { "type": "object", "properties": { "valorAgroIndustrial": { "type": "string", "nullable": true }, "valorEstabelecimento": { "type": "string", "nullable": true }, "valorForaEstabelecimento": { "type": "string", "nullable": true }, "valorPrevidenciario": { "type": "string", "nullable": true }, "valorTotal": { "type": "string", "nullable": true }, "produtos": { "type": "array", "items": { "$ref": "#/components/schemas/ProdutoDAP" }, "nullable": true } }, "additionalProperties": false }, "RendaPresumidaAcertaCompletoPF": { "type": "object", "properties": { "descricao": { "type": "string", "nullable": true }, "faixa": { "type": "string", "nullable": true }, "rendaAnual": { "type": "string", "nullable": true }, "mensagem": { "type": "string", "nullable": true }, "dataReferencia": { "type": "string", "nullable": true }, "valorPresumido": { "type": "string", "nullable": true }, "dadosCadastroPositivo": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RendaPresumidaPF": { "type": "object", "properties": { "descricao": { "type": "string", "nullable": true }, "faixa": { "type": "string", "nullable": true }, "rendaAnual": { "type": "string", "nullable": true }, "mensagem": { "type": "string", "nullable": true }, "dataReferencia": { "type": "string", "nullable": true }, "valorPresumido": { "type": "string", "nullable": true }, "dadosCadastroPositivo": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Representante": { "type": "object", "properties": { "tipo": { "type": "string", "nullable": true }, "nome": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ReservaLegal": { "type": "object", "properties": { "localizacao": { "type": "string", "nullable": true }, "averbadaArt30": { "type": "string", "nullable": true }, "averbada": { "type": "string", "nullable": true }, "aprovadaNaoAverbada": { "type": "string", "nullable": true }, "proposta": { "type": "string", "nullable": true }, "declarada": { "type": "string", "nullable": true }, "passivoExcedente": { "type": "string", "nullable": true }, "recompor": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Restituicao": { "type": "object", "properties": { "lote": { "type": "string", "nullable": true }, "dataDisponibilidade": { "type": "string", "nullable": true }, "situacaoRestituicao": { "type": "string", "nullable": true }, "mensagemPeres": { "type": "string", "nullable": true }, "dadosBancarios": { "$ref": "#/components/schemas/DadosBancarios" } }, "additionalProperties": false }, "RestricaoOcorrenciaAcertaCompletoPF": { "type": "object", "properties": { "codigoInformacao": { "type": "string", "nullable": true }, "descricaoInformacao": { "type": "string", "nullable": true }, "titulo": { "type": "string", "nullable": true }, "observacao": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RestricaoSocioDefineLimitePositivoPJ": { "type": "object", "properties": { "tipo": { "type": "string", "nullable": true }, "quantidade": { "type": "string", "nullable": true }, "ultima": { "type": "string", "nullable": true }, "valor": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RestricoesAcertaCompletoPF": { "type": "object", "properties": { "quantidadeOcorrencias": { "type": "string", "nullable": true }, "ocorrencias": { "type": "array", "items": { "$ref": "#/components/schemas/RestricaoOcorrenciaAcertaCompletoPF" }, "nullable": true } }, "additionalProperties": false }, "RestricoesCGU": { "type": "object", "properties": { "emissor": { "type": "string", "nullable": true }, "descricao": { "type": "string", "nullable": true }, "possuiCorrecional": { "type": "boolean", "nullable": true }, "status": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RestricoesResumo": { "type": "object", "properties": { "pendenciasFinanceiras": { "$ref": "#/components/schemas/PendenciasFinanceirasResumo" }, "protestos": { "$ref": "#/components/schemas/ProtestosResumo" }, "chequesSemFundoBacen": { "$ref": "#/components/schemas/ChequesSemFundoResumo" }, "chequesSemFundoVarejo": { "$ref": "#/components/schemas/ChequesSemFundoResumo" }, "contumacia": { "$ref": "#/components/schemas/ContumaciaResumo" }, "acoesCiveis": { "$ref": "#/components/schemas/AcoesCiveisResumo" }, "falenciaRecuperacaoJudicial": { "$ref": "#/components/schemas/FalenciaRecuperacaoResumo" }, "limiteCredito": { "$ref": "#/components/schemas/LimiteCreditoResumo" }, "faturamentoPresumido": { "$ref": "#/components/schemas/FaturamentoPresumidoResumo" } }, "additionalProperties": false }, "RestricoesResumoDefineLimitePositivoPJ": { "type": "object", "properties": { "pendenciasFinanceiras": { "$ref": "#/components/schemas/PendenciasFinanceirasResumoDefineLimitePositivoPJ" }, "protestos": { "$ref": "#/components/schemas/ProtestosResumoDefineLimitePositivoPJ" }, "chequesSemFundoBacen": { "$ref": "#/components/schemas/ChequesSemFundoResumoDefineLimitePositivoPJ" }, "chequesSemFundoVarejo": { "$ref": "#/components/schemas/ChequesSemFundoResumoDefineLimitePositivoPJ" }, "contumacia": { "$ref": "#/components/schemas/ContumaciaResumoDefineLimitePositivoPJ" }, "acoesCiveis": { "$ref": "#/components/schemas/AcoesCiveisResumoDefineLimitePositivoPJ" }, "falenciaRecuperacaoJudicial": { "$ref": "#/components/schemas/FalenciaRecuperacaoResumoDefineLimitePositivoPJ" }, "limiteCredito": { "$ref": "#/components/schemas/LimiteCreditoResumoDefineLimitePositivoPJ" }, "faturamentoPresumido": { "$ref": "#/components/schemas/FaturamentoPresumidoResumoDefineLimitePositivoPJ" } }, "additionalProperties": false }, "RestricoesVeiculoEstadual": { "type": "object", "properties": { "financeira": { "type": "string", "nullable": true }, "furto": { "type": "string", "nullable": true }, "guincho": { "type": "string", "nullable": true }, "administrativa": { "type": "string", "nullable": true }, "judicial": { "type": "string", "nullable": true }, "tributaria": { "type": "string", "nullable": true }, "renajud": { "type": "string", "nullable": true }, "ambiental": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ResumoProcesso": { "type": "object", "properties": { "numero": { "type": "string", "nullable": true }, "parte": { "type": "string", "nullable": true }, "classe": { "type": "string", "nullable": true }, "assunto": { "type": "string", "nullable": true }, "distribuicao": { "$ref": "#/components/schemas/DistribuicaoTJ" } }, "additionalProperties": false }, "RetornoCIOT": { "type": "object", "properties": { "cnpjContratante": { "type": "string", "nullable": true }, "dataFimVinculo": { "type": "string", "nullable": true }, "tipoOperacao": { "type": "string", "nullable": true }, "situacao": { "type": "string", "nullable": true }, "numeroCIOT": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RetornoFinCEN": { "type": "object", "properties": { "nomeConsultado": { "type": "string", "nullable": true }, "resultadosEncontrados": { "type": "integer", "format": "int32" }, "observacoes": { "type": "string", "nullable": true }, "empresas": { "type": "array", "items": { "$ref": "#/components/schemas/FinCEN" }, "nullable": true } }, "additionalProperties": false }, "RiscoPositivoRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/BoaVistaRiscoPositivoPessoaJuridica" } }, "additionalProperties": false }, "Rotativo": { "type": "object", "properties": { "tipoRelacionamento": { "type": "string", "nullable": true }, "numeroContrato": { "type": "string", "nullable": true }, "dataContratacao": { "type": "string", "nullable": true }, "tipoContratacao": { "type": "string", "nullable": true }, "dataReferencia": { "type": "string", "nullable": true }, "dataFechamento": { "type": "string", "nullable": true }, "valorUsado": { "type": "number", "format": "double", "nullable": true }, "parcelasAnteriores": { "type": "array", "items": { "$ref": "#/components/schemas/ParcelaAnterior" }, "nullable": true }, "parcelaFutura": { "$ref": "#/components/schemas/ParcelaFutura" } }, "additionalProperties": false }, "RubricaRemuneracao": { "type": "object", "properties": { "codigo": { "type": "string", "nullable": true }, "descricao": { "type": "string", "nullable": true }, "valor": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SCRBacenAnalitica": { "type": "object", "properties": { "documentoConsultado": { "type": "string", "nullable": true }, "quantidadeInstituicoes": { "type": "integer", "format": "int32", "nullable": true }, "quantidadeOperacoes": { "type": "integer", "format": "int32", "nullable": true }, "relacionamentos": { "type": "string", "nullable": true }, "volume": { "type": "string", "nullable": true }, "situacao": { "type": "string", "nullable": true }, "perfil": { "type": "string", "nullable": true }, "score": { "type": "string", "nullable": true }, "classeRisco": { "type": "string", "nullable": true }, "carteiraCredito": { "$ref": "#/components/schemas/SCRBacenCarteiraCredito" }, "indice": { "$ref": "#/components/schemas/SCRBacenIndice" }, "percentualCategoria": { "$ref": "#/components/schemas/SCRBacenCategoria" }, "percentualVencido": { "$ref": "#/components/schemas/SCRBacenVencidos" }, "percentualPrazo": { "$ref": "#/components/schemas/SCRBacenPrazos" }, "percentualEvolucaoCompromisso": { "$ref": "#/components/schemas/SCRBacenEvolucaoCompromisso" } }, "additionalProperties": false }, "SCRBacenAnaliticaRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/SCRBacenAnalitica" } }, "additionalProperties": false }, "SCRBacenCarteiraCredito": { "type": "object", "properties": { "valorVencer": { "type": "string", "nullable": true }, "valorVencida": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SCRBacenCategoria": { "type": "object", "properties": { "linhaRiscoMaior": { "type": "string", "nullable": true }, "cartao": { "type": "string", "nullable": true }, "financiamentos": { "type": "string", "nullable": true }, "emprestimos": { "type": "string", "nullable": true }, "financiamentosExportacao": { "type": "string", "nullable": true }, "financiamentosImobiliarios": { "type": "string", "nullable": true }, "financiamentosVeiculos": { "type": "string", "nullable": true }, "adiantamentosDepositantes": { "type": "string", "nullable": true }, "operacoesArrendamento": { "type": "string", "nullable": true }, "coobrigacoes": { "type": "string", "nullable": true }, "outrosCreditos": { "type": "string", "nullable": true }, "outros": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SCRBacenEvolucaoCompromisso": { "type": "object", "properties": { "total": { "type": "string", "nullable": true }, "maiorRisco": { "type": "string", "nullable": true }, "financiamentos": { "type": "string", "nullable": true }, "cartao": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SCRBacenIndice": { "type": "object", "properties": { "total": { "type": "string", "nullable": true }, "cartao": { "type": "string", "nullable": true }, "creditoPessoal": { "type": "string", "nullable": true }, "chequeEspecial": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SCRBacenPrazos": { "type": "object", "properties": { "curto": { "type": "string", "nullable": true }, "medio": { "type": "string", "nullable": true }, "longo": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SCRBacenVencidos": { "type": "object", "properties": { "cartao": { "type": "string", "nullable": true }, "emprestimos": { "type": "string", "nullable": true }, "financiamentos": { "type": "string", "nullable": true }, "financiamentosImobiliarios": { "type": "string", "nullable": true }, "financiamentosVeiculos": { "type": "string", "nullable": true }, "adiantamentoDepositos": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SCRDetalhada": { "type": "object", "properties": { "documentoConsultado": { "type": "string", "nullable": true }, "mesReferencia": { "type": "string", "nullable": true }, "dataInicioRelacionamento": { "type": "string", "nullable": true }, "numeroHistorico": { "type": "integer", "format": "int32", "nullable": true }, "quantidadeInstituicoes": { "type": "integer", "format": "int32", "nullable": true }, "quantidadeOperacoes": { "type": "integer", "format": "int32", "nullable": true }, "quantidadeOperacoesDiscordancia": { "type": "integer", "format": "int32", "nullable": true }, "quantidadeOperacoesSubjudice": { "type": "integer", "format": "int32", "nullable": true }, "obrigacaoAssumida": { "type": "string", "nullable": true }, "obrigacaoResumida": { "type": "string", "nullable": true }, "percentualDocumentoProcessado": { "type": "string", "nullable": true }, "percentualVolumeProcessado": { "type": "string", "nullable": true }, "responsabilidadeTotalSubJudice": { "type": "string", "nullable": true }, "responsabilidadeTotalDiscordancia": { "type": "string", "nullable": true }, "responsabilidadeTotal": { "type": "string", "nullable": true }, "score": { "type": "string", "nullable": true }, "scoreObservacao": { "type": "string", "nullable": true }, "faixaRisco": { "type": "string", "nullable": true }, "riscoIndiretoVendor": { "type": "string", "nullable": true }, "riscoTotal": { "type": "string", "nullable": true }, "carteiraCredito": { "$ref": "#/components/schemas/SCRDetalhadaCarteiraCredito" }, "modalidades": { "type": "array", "items": { "$ref": "#/components/schemas/SCRDetalhadaRegistros" }, "nullable": true } }, "additionalProperties": false }, "SCRDetalhadaALiberar": { "type": "object", "properties": { "total": { "type": "string", "nullable": true }, "de1a30Dias": { "type": "string", "nullable": true }, "de31a60Dias": { "type": "string", "nullable": true }, "de61a90Dias": { "type": "string", "nullable": true }, "de91a180Dias": { "type": "string", "nullable": true }, "de181a360Dias": { "type": "string", "nullable": true }, "acimaDe361Dias": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SCRDetalhadaCarteiraCredito": { "type": "object", "properties": { "total": { "type": "string", "nullable": true }, "limite": { "type": "string", "nullable": true }, "prejuizo": { "type": "string", "nullable": true }, "vencer": { "type": "string", "nullable": true }, "vencido": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SCRDetalhadaPrejuizo": { "type": "object", "properties": { "total": { "type": "string", "nullable": true }, "prejuizo12Meses": { "type": "string", "nullable": true }, "prejuizo24Meses": { "type": "string", "nullable": true }, "prejuizo36Meses": { "type": "string", "nullable": true }, "prejuizo48Meses": { "type": "string", "nullable": true }, "acimaDe48Meses": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SCRDetalhadaRegistros": { "type": "object", "properties": { "aLiberar": { "$ref": "#/components/schemas/SCRDetalhadaALiberar" }, "aVencer": { "$ref": "#/components/schemas/SCRDetalhadaValor" }, "vencido": { "$ref": "#/components/schemas/SCRDetalhadaValor" }, "prejuizo": { "$ref": "#/components/schemas/SCRDetalhadaPrejuizo" }, "limiteCredito": { "type": "string", "nullable": true }, "codigoModalidade": { "type": "string", "nullable": true }, "descricaoModalidade": { "type": "string", "nullable": true }, "variacaoCambial": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SCRDetalhadaRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/SCRDetalhada" } }, "additionalProperties": false }, "SCRDetalhadaValor": { "type": "object", "properties": { "total": { "type": "string", "nullable": true }, "de1a30Dias": { "type": "string", "nullable": true }, "de31a60Dias": { "type": "string", "nullable": true }, "de61a90Dias": { "type": "string", "nullable": true }, "de91a180Dias": { "type": "string", "nullable": true }, "de181a360Dias": { "type": "string", "nullable": true }, "acimaDe361Dias": { "type": "string", "nullable": true }, "de361a720Dias": { "type": "string", "nullable": true }, "de721a1080Dias": { "type": "string", "nullable": true }, "de1081a1440Dias": { "type": "string", "nullable": true }, "de1441a1800Dias": { "type": "string", "nullable": true }, "de1801a5400Dias": { "type": "string", "nullable": true }, "acimaDe5400Dias": { "type": "string", "nullable": true } }, "additionalProperties": false }, "STMCertidaoNegativaUniao": { "type": "object", "properties": { "nomeEntidade": { "type": "string", "nullable": true }, "documento": { "type": "string", "nullable": true }, "dataEmissao": { "type": "string", "nullable": true }, "dataValidade": { "type": "string", "nullable": true }, "codigoValidacao": { "type": "string", "nullable": true }, "possuiPenalidade": { "type": "boolean", "nullable": true }, "status": { "type": "string", "nullable": true } }, "additionalProperties": false }, "STMCertidaoNegativaUniaoRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/STMCertidaoNegativaUniao" } }, "additionalProperties": false }, "Safra": { "type": "object", "properties": { "numeroRegistro": { "type": "integer", "format": "int64", "nullable": true }, "data": { "type": "string", "nullable": true }, "valor": { "type": "string", "nullable": true }, "municipio": { "type": "string", "nullable": true }, "uf": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SancaoAcordo": { "type": "object", "properties": { "cnpj": { "type": "string", "nullable": true }, "razaoSocial": { "type": "string", "nullable": true }, "nomeFantasia": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SancaoCEAF": { "type": "object", "properties": { "numeroRegistro": { "type": "integer", "format": "int32", "nullable": true }, "detalhamentoSancao": { "$ref": "#/components/schemas/DetalhamentoSancaoCEAF" }, "orgao": { "$ref": "#/components/schemas/OrgaoLotacao" }, "fundamentoLegal": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SancaoCEIS": { "type": "object", "properties": { "numeroRegistro": { "type": "integer", "format": "int32", "nullable": true }, "detalhamentoSancao": { "$ref": "#/components/schemas/DetalhamentoSancao" }, "orgao": { "$ref": "#/components/schemas/OrgaoSancionador" }, "fundamentoLegal": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SancaoCEPIM": { "type": "object", "properties": { "numeroRegistro": { "type": "integer", "format": "int32", "nullable": true }, "detalhamentoSancao": { "$ref": "#/components/schemas/DetalhamentoSancaoCEPIM" }, "orgao": { "$ref": "#/components/schemas/OrgaoSancionadorCEPIM" } }, "additionalProperties": false }, "SancaoCNEP": { "type": "object", "properties": { "numeroRegistro": { "type": "integer", "format": "int32", "nullable": true }, "detalhamentoSancao": { "$ref": "#/components/schemas/DetalhamentoSancaoCNEP" }, "orgao": { "$ref": "#/components/schemas/OrgaoSancionador" }, "fundamentoLegal": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SancaoDocumento": { "type": "object", "properties": { "documento": { "type": "string", "nullable": true }, "tipo": { "type": "string", "nullable": true }, "dataEmissao": { "type": "string", "nullable": true }, "observacao": { "type": "string", "nullable": true }, "validade": { "type": "string", "nullable": true }, "fonte": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SancaoEntidade": { "type": "object", "properties": { "numeroReferenciaEU": { "type": "string", "nullable": true }, "baseLegal": { "type": "string", "nullable": true }, "programa": { "type": "string", "nullable": true }, "nome": { "type": "string", "nullable": true }, "alcunhas": { "type": "array", "items": { "type": "string" }, "nullable": true }, "tipoEntidade": { "type": "string", "nullable": true }, "funcao": { "type": "array", "items": { "type": "string" }, "nullable": true }, "tipoEntidadeCompanhia": { "type": "string", "nullable": true }, "localRegistro": { "type": "string", "nullable": true }, "dataRegistro": { "type": "string", "nullable": true }, "localPrincipalNegocios": { "type": "string", "nullable": true }, "entiadadesAssociadas": { "type": "array", "items": { "type": "string" }, "nullable": true }, "individuosAssociados": { "type": "array", "items": { "type": "string" }, "nullable": true }, "nacionalidades": { "type": "array", "items": { "type": "string" }, "nullable": true }, "documentos": { "type": "array", "items": { "$ref": "#/components/schemas/SancaoDocumento" }, "nullable": true }, "enderecos": { "type": "array", "items": { "$ref": "#/components/schemas/EnderecoSancao" }, "nullable": true }, "contatos": { "type": "array", "items": { "$ref": "#/components/schemas/ContatoSancao" }, "nullable": true }, "dataNascimento": { "type": "array", "items": { "type": "string" }, "nullable": true }, "localNascimento": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "ScoreEntidadeDCC": { "type": "object", "properties": { "entidadeFisica": { "$ref": "#/components/schemas/ScorePFDCC" }, "entidadeJuridica": { "$ref": "#/components/schemas/ScorePJDCC" }, "observacao": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ScoreEntidades": { "type": "object", "properties": { "dataConsulta": { "type": "string", "nullable": true }, "documentoConsultado": { "type": "string", "nullable": true }, "pessoaFisica": { "$ref": "#/components/schemas/ScorePF" }, "pessoaJuridica": { "$ref": "#/components/schemas/ScorePJ" }, "observacao": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ScoreOcorrenciaAcertaCompletoPF": { "type": "object", "properties": { "layout": { "type": "string", "nullable": true }, "tipoScore": { "type": "string", "nullable": true }, "score": { "type": "string", "nullable": true }, "execucao": { "type": "string", "nullable": true }, "descricaoPlano": { "type": "string", "nullable": true }, "descricaoScore": { "type": "string", "nullable": true }, "classificacaoNro": { "type": "string", "nullable": true }, "classificacaoABC": { "type": "string", "nullable": true }, "probabilidadeInadimplencia": { "type": "string", "nullable": true }, "texto": { "type": "string", "nullable": true }, "risco": { "type": "string", "nullable": true }, "modeloScore": { "type": "string", "nullable": true }, "informante": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ScoreOcorrenciaPF": { "type": "object", "properties": { "layout": { "type": "string", "nullable": true }, "tipoScore": { "type": "string", "nullable": true }, "score": { "type": "string", "nullable": true }, "execucao": { "type": "string", "nullable": true }, "descricaoPlano": { "type": "string", "nullable": true }, "descricaoScore": { "type": "string", "nullable": true }, "classificacaoNro": { "type": "string", "nullable": true }, "classificacaoABC": { "type": "string", "nullable": true }, "probabilidadeInadimplencia": { "type": "string", "nullable": true }, "texto": { "type": "string", "nullable": true }, "risco": { "type": "string", "nullable": true }, "modeloScore": { "type": "string", "nullable": true }, "informante": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ScorePF": { "type": "object", "properties": { "score": { "type": "integer", "format": "int32", "nullable": true }, "faixaScore": { "type": "string", "nullable": true }, "scoreCompromissoPagamento": { "type": "integer", "format": "int32", "nullable": true }, "descricaoCompromissoPagamento": { "type": "string", "nullable": true }, "scorePerfil": { "type": "integer", "format": "int32", "nullable": true }, "descricaoPerfil": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ScorePFDCC": { "type": "object", "properties": { "score": { "type": "integer", "format": "int32", "nullable": true }, "scoreCompromissoPagamento": { "type": "integer", "format": "int32", "nullable": true }, "descricaoCompromissoPagamento": { "type": "string", "nullable": true }, "scorePerfil": { "type": "integer", "format": "int32", "nullable": true }, "descricaoPerfil": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ScorePJ": { "type": "object", "properties": { "score": { "type": "integer", "format": "int32", "nullable": true }, "faixaScore": { "type": "string", "nullable": true }, "motivos": { "type": "array", "items": { "type": "string" }, "nullable": true }, "indicadoresNegocio": { "type": "array", "items": { "$ref": "#/components/schemas/IndicadorNegocio" }, "nullable": true } }, "additionalProperties": false }, "ScorePJDCC": { "type": "object", "properties": { "score": { "type": "integer", "format": "int32", "nullable": true }, "motivos": { "type": "array", "items": { "type": "string" }, "nullable": true }, "indicadoresNegocio": { "type": "array", "items": { "$ref": "#/components/schemas/IndicadorNegocioDCC" }, "nullable": true } }, "additionalProperties": false }, "ScoreResumo": { "type": "object", "properties": { "layout": { "type": "string", "nullable": true }, "tipoScore": { "type": "string", "nullable": true }, "score": { "type": "string", "nullable": true }, "execucao": { "type": "string", "nullable": true }, "descrPlano": { "type": "string", "nullable": true }, "descrScore": { "type": "string", "nullable": true }, "classificacaoABC": { "type": "string", "nullable": true }, "classificacaoNumero": { "type": "string", "nullable": true }, "probabilidadeInadimplencia": { "type": "string", "nullable": true }, "texto": { "type": "string", "nullable": true }, "risco": { "type": "string", "nullable": true }, "modeloScore": { "type": "string", "nullable": true }, "informante": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ScoreResumoDefineLimitePositivoPJ": { "type": "object", "properties": { "layout": { "type": "string", "nullable": true }, "tipoScore": { "type": "string", "nullable": true }, "score": { "type": "string", "nullable": true }, "execucao": { "type": "string", "nullable": true }, "descrPlano": { "type": "string", "nullable": true }, "descrScore": { "type": "string", "nullable": true }, "classificacaoABC": { "type": "string", "nullable": true }, "classificacaoNumero": { "type": "string", "nullable": true }, "probabilidadeInadimplencia": { "type": "string", "nullable": true }, "texto": { "type": "string", "nullable": true }, "risco": { "type": "string", "nullable": true }, "modeloScore": { "type": "string", "nullable": true }, "informante": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ScoreRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/ScoreEntidades" } }, "additionalProperties": false }, "ScoresAcertaCompletoPF": { "type": "object", "properties": { "quantidadeOcorrencias": { "type": "string", "nullable": true }, "ocorrencias": { "type": "array", "items": { "$ref": "#/components/schemas/ScoreOcorrenciaAcertaCompletoPF" }, "nullable": true } }, "additionalProperties": false }, "ScoresPF": { "type": "object", "properties": { "quantidadeOcorrencias": { "type": "string", "nullable": true }, "ocorrencias": { "type": "array", "items": { "$ref": "#/components/schemas/ScoreOcorrenciaPF" }, "nullable": true } }, "additionalProperties": false }, "SegundoGrau": { "type": "object", "properties": { "totalProcessos": { "type": "integer", "format": "int32", "nullable": true }, "sessoes": { "type": "array", "items": { "$ref": "#/components/schemas/SessaoTJ" }, "nullable": true } }, "additionalProperties": false }, "SeguroDefeso": { "type": "object", "properties": { "nome": { "type": "string", "nullable": true }, "nis": { "type": "string", "nullable": true }, "cpf": { "type": "string", "nullable": true }, "rgp": { "type": "string", "nullable": true }, "beneficios": { "type": "array", "items": { "$ref": "#/components/schemas/AuxilioSD" }, "nullable": true } }, "additionalProperties": false }, "SeguroDefesoRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/SeguroDefeso" } }, "additionalProperties": false }, "SerieMensal": { "type": "object", "properties": { "periodo": { "type": "string", "nullable": true }, "pontuacao_Mensal": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SerieMensalDefineLimitePositivoPJ": { "type": "object", "properties": { "periodo": { "type": "string", "nullable": true }, "pontuacao_Mensal": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ServicoMonetario": { "type": "object", "properties": { "numero": { "type": "string", "nullable": true }, "atividades": { "type": "array", "items": { "type": "string" }, "nullable": true }, "estados": { "type": "array", "items": { "type": "string" }, "nullable": true }, "estadosTerritorios": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "ServidorRemuneracao": { "type": "object", "properties": { "tipoServidor": { "type": "string", "nullable": true }, "situacao": { "type": "string", "nullable": true }, "matricula": { "type": "string", "nullable": true }, "funcao": { "type": "string", "nullable": true }, "orgaoLotacao": { "type": "string", "nullable": true }, "orgaoExercicio": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SessaoTJ": { "type": "object", "properties": { "sessao": { "type": "string", "nullable": true }, "resumoProcessos": { "type": "array", "items": { "$ref": "#/components/schemas/ResumoProcesso" }, "nullable": true }, "dadosProcesso": { "$ref": "#/components/schemas/ProcessoSegundoGrau" } }, "additionalProperties": false }, "Similarity": { "type": "object", "properties": { "cpf": { "$ref": "#/components/schemas/CPFEntity" }, "name": { "$ref": "#/components/schemas/NameEntity" }, "dob": { "$ref": "#/components/schemas/DOBEntity" }, "address": { "$ref": "#/components/schemas/AddressEntity" }, "city": { "$ref": "#/components/schemas/CityEntity" }, "state": { "$ref": "#/components/schemas/StateEntity" }, "postCode": { "$ref": "#/components/schemas/PostCodeEntity" }, "phone": { "type": "array", "items": { "$ref": "#/components/schemas/PhoneEntity" }, "nullable": true } }, "additionalProperties": false }, "SimilarityArgentina": { "type": "object", "properties": { "dni": { "$ref": "#/components/schemas/DNIEntity" }, "name": { "$ref": "#/components/schemas/NameEntity" }, "dob": { "$ref": "#/components/schemas/DOBEntity" }, "address": { "$ref": "#/components/schemas/AddressEntity" }, "city": { "$ref": "#/components/schemas/CityEntity" }, "state": { "$ref": "#/components/schemas/StateEntity" }, "postCode": { "$ref": "#/components/schemas/PostCodeEntity" }, "phone": { "type": "array", "items": { "$ref": "#/components/schemas/PhoneEntity" }, "nullable": true } }, "additionalProperties": false }, "SimilarityArgentinaRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/SimilarityArgentina" } }, "additionalProperties": false }, "SimilarityMexico": { "type": "object", "properties": { "curp": { "$ref": "#/components/schemas/CURPEntity" }, "name": { "$ref": "#/components/schemas/NameEntity" }, "dob": { "$ref": "#/components/schemas/DOBEntity" }, "address": { "$ref": "#/components/schemas/AddressEntity" }, "city": { "$ref": "#/components/schemas/CityEntity" }, "state": { "$ref": "#/components/schemas/StateEntity" }, "postCode": { "$ref": "#/components/schemas/PostCodeEntity" }, "phone": { "type": "array", "items": { "$ref": "#/components/schemas/PhoneEntity" }, "nullable": true } }, "additionalProperties": false }, "SimilarityMexicoRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/SimilarityMexico" } }, "additionalProperties": false }, "SimilarityRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/Similarity" } }, "additionalProperties": false }, "SimplesNacional": { "type": "object", "properties": { "cnpj": { "type": "string", "nullable": true }, "nomeEmpresarial": { "type": "string", "nullable": true }, "situacaoSimplesNacional": { "type": "string", "nullable": true }, "situacaoSIMEI": { "type": "string", "nullable": true }, "situacaoRegimeRegularIBS": { "type": "string", "nullable": true }, "situacaoRegimeRegularCBS": { "type": "string", "nullable": true }, "optanteSimplesNacional": { "type": "boolean" }, "enquadradoSIMEI": { "type": "boolean" }, "simplesNacionalPeriodosAnteriores": { "type": "array", "items": { "$ref": "#/components/schemas/DetalhamentoDTO" }, "nullable": true }, "simeiPeriodosAnteriores": { "type": "array", "items": { "$ref": "#/components/schemas/DetalhamentoDTO" }, "nullable": true }, "eventosFuturosSIMEI": { "type": "array", "items": { "$ref": "#/components/schemas/DetalhamentoDTO" }, "nullable": true }, "eventosFuturosSimplesNacional": { "type": "array", "items": { "$ref": "#/components/schemas/DetalhamentoDTO" }, "nullable": true }, "meiTransportadorAutonomo": { "type": "array", "items": { "$ref": "#/components/schemas/DetalhamentoDTO" }, "nullable": true }, "dataConsulta": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SimplesNacionalRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/SimplesNacional" } }, "additionalProperties": false }, "Sintegra": { "type": "object", "properties": { "codigoControle": { "type": "string", "nullable": true }, "dataConsulta": { "type": "string", "nullable": true }, "ie": { "type": "string", "nullable": true }, "tipoIE": { "type": "string", "nullable": true }, "ufie": { "type": "string", "nullable": true }, "cnpj": { "type": "string", "nullable": true }, "cpf": { "type": "string", "nullable": true }, "nomeEmpresarial": { "type": "string", "nullable": true }, "nomeFantasia": { "type": "string", "nullable": true }, "naturezaJuridica": { "type": "string", "nullable": true }, "logradouro": { "type": "string", "nullable": true }, "numero": { "type": "integer", "format": "int32", "nullable": true }, "complemento": { "type": "string", "nullable": true }, "cep": { "type": "string", "nullable": true }, "bairro": { "type": "string", "nullable": true }, "municipio": { "type": "string", "nullable": true }, "uf": { "type": "string", "nullable": true }, "telefone": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "situacaoCadastral": { "type": "string", "nullable": true }, "situacaoCNPJ": { "type": "string", "nullable": true }, "motivoSituacaoCadastral": { "type": "string", "nullable": true }, "dataAbertura": { "type": "string", "nullable": true }, "dataInicioAtividade": { "type": "string", "nullable": true }, "dataFimAtividade": { "type": "string", "nullable": true }, "dataSituacaoCadastral": { "type": "string", "nullable": true }, "ocorrenciaFiscal": { "type": "string", "nullable": true }, "regimeApuracao": { "type": "string", "nullable": true }, "atividadeEconomicaPrincipal": { "type": "string", "nullable": true }, "atividadesEconomicasSecundarias": { "type": "array", "items": { "type": "string" }, "nullable": true }, "dataCredenciamentoEmissorNFe": { "type": "string", "nullable": true }, "indicadorObrigatoriedadeNFe": { "type": "string", "nullable": true }, "dataInicioObrigatoriedadeNFe": { "type": "string", "nullable": true }, "observacao": { "type": "string", "nullable": true }, "situacaoContribuinteNaData": { "type": "string", "nullable": true }, "inscricoesEstaduais": { "type": "array", "items": { "$ref": "#/components/schemas/InscricaoEstadual" }, "nullable": true }, "informacaoIBGE": { "$ref": "#/components/schemas/IBGE" } }, "additionalProperties": false }, "SintegraCCCCompleta": { "type": "object", "properties": { "codigoControle": { "type": "string", "nullable": true }, "dataConsulta": { "type": "string", "nullable": true }, "ie": { "type": "string", "nullable": true }, "tipoIE": { "type": "string", "nullable": true }, "ufie": { "type": "string", "nullable": true }, "cnpj": { "type": "string", "nullable": true }, "cpf": { "type": "string", "nullable": true }, "nomeEmpresarial": { "type": "string", "nullable": true }, "nomeFantasia": { "type": "string", "nullable": true }, "naturezaJuridica": { "type": "string", "nullable": true }, "logradouro": { "type": "string", "nullable": true }, "numero": { "type": "integer", "format": "int32", "nullable": true }, "complemento": { "type": "string", "nullable": true }, "cep": { "type": "string", "nullable": true }, "bairro": { "type": "string", "nullable": true }, "municipio": { "type": "string", "nullable": true }, "uf": { "type": "string", "nullable": true }, "telefone": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "situacaoCadastral": { "type": "string", "nullable": true }, "situacaoCNPJ": { "type": "string", "nullable": true }, "motivoSituacaoCadastral": { "type": "string", "nullable": true }, "dataAbertura": { "type": "string", "nullable": true }, "dataInicioAtividade": { "type": "string", "nullable": true }, "dataFimAtividade": { "type": "string", "nullable": true }, "dataSituacaoCadastral": { "type": "string", "nullable": true }, "ocorrenciaFiscal": { "type": "string", "nullable": true }, "regimeApuracao": { "type": "string", "nullable": true }, "atividadeEconomicaPrincipal": { "type": "string", "nullable": true }, "atividadesEconomicasSecundarias": { "type": "array", "items": { "type": "string" }, "nullable": true }, "dataCredenciamentoEmissorNFe": { "type": "string", "nullable": true }, "indicadorObrigatoriedadeNFe": { "type": "string", "nullable": true }, "dataInicioObrigatoriedadeNFe": { "type": "string", "nullable": true }, "observacao": { "type": "string", "nullable": true }, "situacaoContribuinteNaData": { "type": "string", "nullable": true }, "informacaoIBGE": { "$ref": "#/components/schemas/IBGE" }, "inscricoesEstaduaisSintegra": { "type": "array", "items": { "$ref": "#/components/schemas/InscricaoEstadualCompleta" }, "nullable": true } }, "additionalProperties": false, "description": "Objeto de retorno da consulta Sintegra CCC Completa." }, "SintegraCCCCompletaRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/SintegraCCCCompleta" } }, "additionalProperties": false }, "SintegraCadastroCentralizadoContribuinte": { "type": "object", "properties": { "codigoControle": { "type": "string", "nullable": true }, "dataConsulta": { "type": "string", "nullable": true }, "ie": { "type": "string", "nullable": true }, "tipoIE": { "type": "string", "nullable": true }, "ufie": { "type": "string", "nullable": true }, "cnpj": { "type": "string", "nullable": true }, "cpf": { "type": "string", "nullable": true }, "nomeEmpresarial": { "type": "string", "nullable": true }, "nomeFantasia": { "type": "string", "nullable": true }, "naturezaJuridica": { "type": "string", "nullable": true }, "logradouro": { "type": "string", "nullable": true }, "numero": { "type": "integer", "format": "int32", "nullable": true }, "complemento": { "type": "string", "nullable": true }, "cep": { "type": "string", "nullable": true }, "bairro": { "type": "string", "nullable": true }, "municipio": { "type": "string", "nullable": true }, "uf": { "type": "string", "nullable": true }, "telefone": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "situacaoCadastral": { "type": "string", "nullable": true }, "situacaoCNPJ": { "type": "string", "nullable": true }, "motivoSituacaoCadastral": { "type": "string", "nullable": true }, "dataAbertura": { "type": "string", "nullable": true }, "dataInicioAtividade": { "type": "string", "nullable": true }, "dataFimAtividade": { "type": "string", "nullable": true }, "dataSituacaoCadastral": { "type": "string", "nullable": true }, "ocorrenciaFiscal": { "type": "string", "nullable": true }, "regimeApuracao": { "type": "string", "nullable": true }, "atividadeEconomicaPrincipal": { "type": "string", "nullable": true }, "atividadesEconomicasSecundarias": { "type": "array", "items": { "type": "string" }, "nullable": true }, "dataCredenciamentoEmissorNFe": { "type": "string", "nullable": true }, "indicadorObrigatoriedadeNFe": { "type": "string", "nullable": true }, "dataInicioObrigatoriedadeNFe": { "type": "string", "nullable": true }, "observacao": { "type": "string", "nullable": true }, "situacaoContribuinteNaData": { "type": "string", "nullable": true }, "inscricoesEstaduais": { "type": "array", "items": { "$ref": "#/components/schemas/InscricaoEstadual" }, "nullable": true }, "informacaoIBGE": { "$ref": "#/components/schemas/IBGE" } }, "additionalProperties": false }, "SintegraCadastroCentralizadoContribuinteRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/SintegraCadastroCentralizadoContribuinte" } }, "additionalProperties": false }, "SintegraRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/Sintegra" } }, "additionalProperties": false }, "SituacaoEleitoral": { "type": "object", "properties": { "identificacao": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "isRegular": { "type": "boolean", "nullable": true }, "biometriaColetada": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "SituacaoEleitoralRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/SituacaoEleitoral" } }, "additionalProperties": false }, "Sociedade": { "type": "object", "properties": { "cnpj": { "type": "string", "nullable": true }, "razaoSocial": { "type": "string", "nullable": true }, "nomeFantasia": { "type": "string", "nullable": true }, "dataAbertura": { "type": "string", "nullable": true }, "baixada": { "type": "boolean", "nullable": true }, "socios": { "type": "array", "items": { "$ref": "#/components/schemas/SocioAML" }, "nullable": true } }, "additionalProperties": false }, "Socio": { "type": "object", "properties": { "documento": { "type": "string", "nullable": true }, "nome": { "type": "string", "nullable": true }, "dataEntrada": { "type": "string", "nullable": true }, "cargo": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SocioAML": { "type": "object", "properties": { "cpf": { "type": "string", "nullable": true }, "nome": { "type": "string", "nullable": true }, "dataNascimento": { "type": "string", "nullable": true }, "genero": { "type": "string", "nullable": true }, "obito": { "type": "boolean", "nullable": true }, "dataObito": { "type": "string", "nullable": true }, "cnpj": { "type": "string", "nullable": true }, "razaoSocial": { "type": "string", "nullable": true }, "dataAbertura": { "type": "string", "nullable": true }, "baixada": { "type": "boolean", "nullable": true }, "dataBaixada": { "type": "string", "nullable": true }, "qualificacaoSocio": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SocioReceita": { "type": "object", "properties": { "nomeNomeEmpresarial": { "type": "string", "nullable": true }, "qualificacao": { "type": "string", "nullable": true }, "qualifRepLegal": { "type": "string", "nullable": true }, "nomeRepresLegal": { "type": "string", "nullable": true }, "isRepresentanteLegal": { "type": "boolean", "nullable": true }, "documentoSocio": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Socios": { "type": "object", "properties": { "documento": { "type": "string", "nullable": true }, "nomeEntidade": { "type": "string", "nullable": true }, "qualificacao": { "type": "string", "nullable": true }, "dataEntradaSociedade": { "type": "string", "nullable": true }, "percentualParticipacao": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "StateEntity": { "type": "object", "properties": { "state": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "distance": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "SubprocessosRecursos": { "type": "object", "properties": { "dataRecebimento": { "type": "string", "nullable": true }, "classe": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SuframaCNPJ": { "type": "object", "properties": { "quantidadeInscricoes": { "type": "integer", "format": "int32", "nullable": true }, "inscricoes": { "type": "array", "items": { "$ref": "#/components/schemas/Inscricao" }, "nullable": true } }, "additionalProperties": false }, "SuframaCNPJRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/SuframaCNPJ" } }, "additionalProperties": false }, "SuicaSECO": { "type": "object", "properties": { "nomeConsultado": { "type": "string", "nullable": true }, "resultadosEncontrados": { "type": "integer", "format": "int32" }, "observacoes": { "type": "string", "nullable": true }, "dataLista": { "type": "string", "nullable": true }, "sancoes": { "type": "array", "items": { "$ref": "#/components/schemas/SuicaSECOSancoes" }, "nullable": true } }, "additionalProperties": false }, "SuicaSECOApelidos": { "type": "object", "properties": { "tipo": { "type": "string", "nullable": true }, "qualidade": { "type": "string", "nullable": true }, "idioma": { "type": "string", "nullable": true }, "nome": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SuicaSECOAtributos": { "type": "object", "properties": { "chave": { "type": "string", "nullable": true }, "valor": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SuicaSECOIdentificacoes": { "type": "object", "properties": { "tipo": { "type": "string", "nullable": true }, "documento": { "type": "string", "nullable": true }, "pais": { "type": "string", "nullable": true }, "dataEmissao": { "type": "string", "nullable": true }, "dataExpiracao": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SuicaSECORetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/SuicaSECO" } }, "additionalProperties": false }, "SuicaSECOSancoes": { "type": "object", "properties": { "nome": { "type": "string", "nullable": true }, "tipoRegistro": { "type": "string", "nullable": true }, "dataNascimento": { "type": "string", "nullable": true }, "localNascimento": { "type": "string", "nullable": true }, "nacionalidade": { "type": "string", "nullable": true }, "genero": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "dataInclusaoLista": { "type": "string", "nullable": true }, "programas": { "type": "string", "nullable": true }, "apelidos": { "type": "array", "items": { "$ref": "#/components/schemas/SuicaSECOApelidos" }, "nullable": true }, "identificacoes": { "type": "array", "items": { "$ref": "#/components/schemas/SuicaSECOIdentificacoes" }, "nullable": true }, "enderecos": { "type": "array", "items": { "$ref": "#/components/schemas/EnderecoSancoesUtils" }, "nullable": true }, "atributos": { "type": "array", "items": { "$ref": "#/components/schemas/SuicaSECOAtributos" }, "nullable": true } }, "additionalProperties": false }, "TCUCertidaoNegativaLicitanteInidoneo": { "type": "object", "properties": { "nomeEntidade": { "type": "string", "nullable": true }, "documentoConsultado": { "type": "string", "nullable": true }, "dataEmissao": { "type": "string", "nullable": true }, "dataValidade": { "type": "string", "nullable": true }, "possuiSancao": { "type": "boolean", "nullable": true }, "status": { "type": "string", "nullable": true }, "codigoValidacao": { "type": "string", "nullable": true }, "sancoes": { "type": "array", "items": { "$ref": "#/components/schemas/TCUSancaoLicitanteInidoneo" }, "nullable": true } }, "additionalProperties": false }, "TCUCertidaoNegativaLicitanteInidoneoRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/TCUCertidaoNegativaLicitanteInidoneo" } }, "additionalProperties": false }, "TCUCertidaoNegativaProcesso": { "type": "object", "properties": { "documentoConsultado": { "type": "string", "nullable": true }, "nomeEntidade": { "type": "string", "nullable": true }, "dataEmissao": { "type": "string", "nullable": true }, "dataValidade": { "type": "string", "nullable": true }, "possuiProcesso": { "type": "boolean", "nullable": true }, "status": { "type": "string", "nullable": true }, "codigoCertidao": { "type": "string", "nullable": true }, "processos": { "type": "array", "items": { "$ref": "#/components/schemas/ProcessoTCU" }, "nullable": true } }, "additionalProperties": false }, "TCUCertidaoNegativaProcessoRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/TCUCertidaoNegativaProcesso" } }, "additionalProperties": false }, "TCUConsultaConsolidadaPessoaJuridica": { "type": "object", "properties": { "razaoSocial": { "type": "string", "nullable": true }, "nomeFantasia": { "type": "string", "nullable": true }, "cnpj": { "type": "string", "nullable": true }, "uf": { "type": "string", "nullable": true }, "certidoes": { "type": "array", "items": { "$ref": "#/components/schemas/Certidao" }, "nullable": true }, "constamSancoes": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "TCUConsultaConsolidadaPessoaJuridicaRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/TCUConsultaConsolidadaPessoaJuridica" } }, "additionalProperties": false }, "TCUSancaoLicitanteInidoneo": { "type": "object", "properties": { "processo": { "type": "string", "nullable": true }, "acordao": { "type": "string", "nullable": true }, "entradaCadastro": { "type": "string", "nullable": true }, "saidaCadastro": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TJCertidaoCivelCriminalFiscal": { "type": "object", "properties": { "nomeEntidade": { "type": "string", "nullable": true }, "documentoConsultado": { "type": "string", "nullable": true }, "tipoCertidao": { "type": "string", "nullable": true }, "uf": { "type": "string", "nullable": true }, "dataEmissao": { "type": "string", "nullable": true }, "dataValidade": { "type": "string", "nullable": true }, "possuiOcorrencia": { "type": "string", "nullable": true }, "numeroCertidao": { "type": "string", "nullable": true }, "codigoValidacao": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "observacao": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TJCertidaoCivelCriminalFiscalRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/TJCertidaoCivelCriminalFiscal" } }, "additionalProperties": false }, "TSECertidaoCrimesEleitorais": { "type": "object", "properties": { "nome": { "type": "string", "nullable": true }, "documentoConsultado": { "type": "string", "nullable": true }, "inscricao": { "type": "string", "nullable": true }, "municipio": { "type": "string", "nullable": true }, "dataNascimento": { "type": "string", "nullable": true }, "filiacao": { "type": "string", "nullable": true }, "zona": { "type": "string", "nullable": true }, "secao": { "type": "string", "nullable": true }, "uf": { "type": "string", "nullable": true }, "domicilioDesde": { "type": "string", "nullable": true }, "dataEmissao": { "type": "string", "nullable": true }, "codigoValidacao": { "type": "string", "nullable": true }, "isRegular": { "type": "boolean", "nullable": true }, "status": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TSECertidaoCrimesEleitoraisRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/TSECertidaoCrimesEleitorais" } }, "additionalProperties": false }, "TSECertidaodeQuitacaoEleitoral": { "type": "object", "properties": { "nome": { "type": "string", "nullable": true }, "documentoConsultado": { "type": "string", "nullable": true }, "inscricao": { "type": "string", "nullable": true }, "municipio": { "type": "string", "nullable": true }, "dataNascimento": { "type": "string", "nullable": true }, "filiacao": { "type": "string", "nullable": true }, "zona": { "type": "string", "nullable": true }, "secao": { "type": "string", "nullable": true }, "uf": { "type": "string", "nullable": true }, "domicilioDesde": { "type": "string", "nullable": true }, "ocupacaoDeclarada": { "type": "string", "nullable": true }, "isRegular": { "type": "boolean", "nullable": true }, "status": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TSECertidaodeQuitacaoEleitoralRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/TSECertidaodeQuitacaoEleitoral" } }, "additionalProperties": false }, "TSTCertidaoNegativaDebitosTrabalhistas": { "type": "object", "properties": { "nome": { "type": "string", "nullable": true }, "documentoConsultado": { "type": "string", "nullable": true }, "numeroCertidao": { "type": "string", "nullable": true }, "dataExpedicao": { "type": "string", "nullable": true }, "dataValidade": { "type": "string", "nullable": true }, "possuiProcesso": { "type": "boolean", "nullable": true }, "totalProcessos": { "type": "integer", "format": "int32", "nullable": true }, "status": { "type": "string", "nullable": true }, "processos": { "type": "array", "items": { "$ref": "#/components/schemas/ProcessoTST" }, "nullable": true } }, "additionalProperties": false }, "TSTCertidaoNegativaDebitosTrabalhistasRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/TSTCertidaoNegativaDebitosTrabalhistas" } }, "additionalProperties": false }, "TabelaVeicularFipe": { "type": "object", "properties": { "mes": { "type": "string", "nullable": true }, "ano": { "type": "string", "nullable": true }, "valor": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Telefone": { "type": "object", "properties": { "telefoneComDDD": { "type": "string", "nullable": true }, "telemarketingBloqueado": { "type": "boolean", "nullable": true }, "operadora": { "type": "string", "nullable": true }, "tipoTelefone": { "type": "string", "nullable": true }, "whatsApp": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "TelefoneBase": { "type": "object", "properties": { "ddd": { "type": "string", "nullable": true }, "numero": { "type": "string", "nullable": true }, "telefoneComDDD": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Telephone": { "type": "object", "properties": { "phoneNumber": { "type": "string", "nullable": true }, "phoneType": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TitularDAP": { "type": "object", "properties": { "numeroTitular": { "type": "integer", "format": "int32" }, "cpf": { "type": "string", "nullable": true }, "rg": { "type": "string", "nullable": true }, "nis": { "type": "string", "nullable": true }, "nome": { "type": "string", "nullable": true }, "nomeMae": { "type": "string", "nullable": true }, "dataNascimento": { "type": "string", "nullable": true }, "sexo": { "type": "string", "nullable": true }, "estadoCivil": { "type": "string", "nullable": true }, "regimeCasamento": { "type": "string", "nullable": true }, "escolaridade": { "type": "string", "nullable": true }, "naturalidade": { "type": "string", "nullable": true }, "endereco": { "$ref": "#/components/schemas/EnderecoDAP" } }, "additionalProperties": false }, "TituloBasica": { "type": "object", "properties": { "valorProtestado": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TituloCompleta": { "type": "object", "properties": { "dataProtesto": { "type": "string", "nullable": true }, "valorProtestado": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TituloLocalDeVotacaoRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/TituloLocalVotacao" } }, "additionalProperties": false }, "TituloLocalVotacao": { "type": "object", "properties": { "identificacao": { "$ref": "#/components/schemas/Identificacao" }, "domicilioEleitoral": { "$ref": "#/components/schemas/DomicilioEleitoral" }, "biometriaColetada": { "type": "boolean", "nullable": true }, "status": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TituloOnline": { "type": "object", "properties": { "dataProtesto": { "type": "string", "nullable": true }, "valorProtestado": { "type": "string", "nullable": true }, "documento": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TotaisNFe": { "type": "object", "properties": { "baseICMS": { "type": "string", "nullable": true }, "valorICMS": { "type": "string", "nullable": true }, "baseIBS": { "type": "string", "nullable": true }, "valorIBS": { "type": "string", "nullable": true }, "baseCBS": { "type": "string", "nullable": true }, "valorCBS": { "type": "string", "nullable": true }, "valorProdutos": { "type": "string", "nullable": true }, "valorFrete": { "type": "string", "nullable": true }, "valorSeguro": { "type": "string", "nullable": true }, "valorDesconto": { "type": "string", "nullable": true }, "valorOutros": { "type": "string", "nullable": true }, "valorIPI": { "type": "string", "nullable": true }, "valorPIS": { "type": "string", "nullable": true }, "valorCOFINS": { "type": "string", "nullable": true }, "valorTotalNFe": { "type": "string", "nullable": true }, "valorTotalTributos": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TransporteNFe": { "type": "object", "properties": { "modalidadeFrete": { "type": "string", "nullable": true }, "cnpj": { "type": "string", "nullable": true }, "razaoSocial": { "type": "string", "nullable": true }, "volume": { "$ref": "#/components/schemas/VolumeNFe" } }, "additionalProperties": false }, "TribunalJustica": { "type": "object", "properties": { "dataConsulta": { "type": "string", "nullable": true }, "nomeParte": { "type": "string", "nullable": true }, "documento": { "type": "string", "nullable": true }, "numeroProcesso": { "type": "string", "nullable": true }, "grau": { "type": "integer", "format": "int32", "nullable": true }, "uf": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "primeiroGrau": { "$ref": "#/components/schemas/PrimeiroGrau" }, "segundoGrau": { "$ref": "#/components/schemas/SegundoGrau" } }, "additionalProperties": false }, "TribunalJusticaRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/TribunalJustica" } }, "additionalProperties": false }, "TribunalRegionalFederal": { "type": "object", "properties": { "codigoValidacao": { "type": "string", "nullable": true }, "dataEmissao": { "type": "string", "nullable": true }, "dataValidade": { "type": "string", "nullable": true }, "documento": { "type": "string", "nullable": true }, "nomeEntidade": { "type": "string", "nullable": true }, "numeroCertidao": { "type": "string", "nullable": true }, "possuiProcesso": { "type": "boolean", "nullable": true }, "processos": { "type": "array", "items": { "$ref": "#/components/schemas/Processo" }, "nullable": true }, "status": { "type": "string", "nullable": true }, "tipoCertidao": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TribunalRegionalFederalRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/TribunalRegionalFederal" } }, "additionalProperties": false }, "TribunalRegionalTrabalho": { "type": "object", "properties": { "documento": { "type": "string", "nullable": true }, "regiao": { "type": "string", "nullable": true }, "tipoConsultado": { "type": "string", "nullable": true }, "nome": { "type": "string", "nullable": true }, "numeroCertidao": { "type": "string", "nullable": true }, "dataEmissao": { "type": "string", "nullable": true }, "dataValidade": { "type": "string", "nullable": true }, "dataConsulta": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "codigoAutenticidade": { "type": "string", "nullable": true }, "possuiProcesso": { "type": "boolean", "nullable": true }, "constaProcessoTST": { "type": "boolean", "nullable": true }, "observacao": { "type": "string", "nullable": true }, "processos": { "type": "array", "items": { "$ref": "#/components/schemas/ProcessoTRT" }, "nullable": true } }, "additionalProperties": false }, "TribunalRegionalTrabalhoRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/TribunalRegionalTrabalho" } }, "additionalProperties": false }, "UKAddress": { "type": "object", "properties": { "enderecoCompleto": { "type": "string", "nullable": true }, "codigoPostal": { "type": "string", "nullable": true }, "pais": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UKDocumento": { "type": "object", "properties": { "detalhes": { "type": "string", "nullable": true }, "documento": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UKHmTreasury": { "type": "object", "properties": { "nomeConsultado": { "type": "string", "nullable": true }, "resultadosEncontrados": { "type": "integer", "format": "int32" }, "observacoes": { "type": "string", "nullable": true }, "sancoes": { "type": "array", "items": { "$ref": "#/components/schemas/UKSancoes" }, "nullable": true } }, "additionalProperties": false }, "UKSancoes": { "type": "object", "properties": { "groupID": { "type": "string", "nullable": true }, "nome": { "type": "string", "nullable": true }, "regime": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "tipo": { "type": "string", "nullable": true }, "nacionalidade": { "type": "string", "nullable": true }, "endereco": { "$ref": "#/components/schemas/UKAddress" }, "dataNascimento": { "type": "string", "nullable": true }, "cidadeNascimento": { "type": "string", "nullable": true }, "paisNascimento": { "type": "string", "nullable": true }, "posicao": { "type": "string", "nullable": true }, "documentos": { "type": "array", "items": { "$ref": "#/components/schemas/UKDocumento" }, "nullable": true }, "dataInclusaoLista": { "type": "string", "nullable": true }, "dataUltimaAtualizacao": { "type": "string", "nullable": true }, "outrasInformacoes": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UKSancoesRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/UKHmTreasury" } }, "additionalProperties": false }, "UNSLDocumentos": { "type": "object", "properties": { "documento": { "type": "string", "nullable": true }, "tipo": { "type": "string", "nullable": true }, "dataEmissao": { "type": "string", "nullable": true }, "observacao": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UNSLSancoes": { "type": "object", "properties": { "numeroRegistro": { "type": "string", "nullable": true }, "versao": { "type": "string", "nullable": true }, "nome": { "type": "string", "nullable": true }, "sobrenome": { "type": "string", "nullable": true }, "nomeEscritaOriginal": { "type": "string", "nullable": true }, "tipo": { "type": "string", "nullable": true }, "referencia": { "type": "string", "nullable": true }, "observacao": { "type": "string", "nullable": true }, "dataInclusao": { "type": "string", "nullable": true }, "sexo": { "type": "string", "nullable": true }, "dataNascimento": { "type": "string", "nullable": true }, "localNascimento": { "type": "string", "nullable": true }, "unLista": { "type": "string", "nullable": true }, "designacoes": { "type": "array", "items": { "type": "string" }, "nullable": true }, "nacionalidades": { "type": "array", "items": { "type": "string" }, "nullable": true }, "documentos": { "type": "array", "items": { "$ref": "#/components/schemas/UNSLDocumentos" }, "nullable": true }, "enderecos": { "type": "array", "items": { "$ref": "#/components/schemas/EnderecoSancoesUtils" }, "nullable": true }, "alcunhas": { "type": "array", "items": { "type": "string" }, "nullable": true }, "titulos": { "type": "array", "items": { "type": "string" }, "nullable": true }, "datasAtualizacoes": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "UltimaMovimentacao": { "type": "object", "properties": { "data": { "type": "string", "nullable": true }, "descricao": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UnidadeGestoraViagem": { "type": "object", "properties": { "codigo": { "type": "string", "nullable": true }, "nome": { "type": "string", "nullable": true }, "orgaoVinculado": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UnitedNationsSecurityList": { "type": "object", "properties": { "nomeConsultado": { "type": "string", "nullable": true }, "resultadosEncontrados": { "type": "integer", "format": "int32", "nullable": true }, "observacoes": { "type": "string", "nullable": true }, "sancoes": { "type": "array", "items": { "$ref": "#/components/schemas/UNSLSancoes" }, "nullable": true } }, "additionalProperties": false }, "UnitedNationsSecurityListRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/UnitedNationsSecurityList" } }, "additionalProperties": false }, "UsoRestrito": { "type": "object", "properties": { "area": { "type": "string", "nullable": true }, "recompor": { "type": "string", "nullable": true } }, "additionalProperties": false }, "VSEntidadePessoaFisica": { "type": "object", "properties": { "pep": { "type": "boolean", "nullable": true }, "dataNascimento": { "type": "string", "nullable": true }, "obito": { "type": "boolean", "nullable": true }, "situacaoCadastral": { "type": "string", "nullable": true }, "endereco": { "$ref": "#/components/schemas/Endereco" } }, "additionalProperties": false }, "VSEntidadePessoaJuridica": { "type": "object", "properties": { "matriz": { "type": "boolean", "nullable": true }, "dataAbertura": { "type": "string", "nullable": true }, "baixada": { "type": "boolean", "nullable": true }, "dataEncerramento": { "type": "string", "nullable": true }, "recuperacaoJudicial": { "type": "boolean", "nullable": true }, "situacaoCadastral": { "type": "string", "nullable": true }, "endereco": { "$ref": "#/components/schemas/Endereco" } }, "additionalProperties": false }, "ValeGas": { "type": "object", "properties": { "cnpjEstabelecimento": { "type": "string", "description": "Competência no formato AAAAMM, como o Portal publica (ex: \"202606\").", "nullable": true }, "estabelecimento": { "type": "string", "nullable": true }, "uf": { "type": "string", "nullable": true }, "municipio": { "type": "string", "nullable": true }, "quantidadePessoasFamilia": { "type": "integer", "format": "int32", "nullable": true }, "periodoValidadeMeses": { "type": "integer", "format": "int32", "nullable": true }, "dataInicioVigencia": { "type": "string", "nullable": true }, "dataFimVigencia": { "type": "string", "nullable": true }, "dataRetirada": { "type": "string", "nullable": true }, "valor": { "type": "string", "nullable": true }, "competencia": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Um vale do Gás do Povo. Espelha DirectData.LibraryAPI.Consultas.Gas_do_Povo.ValeGas —\r\nalteração aqui exige a mesma alteração lá, senão a desserialização do JSON de\r\nretorno perde o campo em silêncio." }, "Veiculo": { "type": "object", "properties": { "renavam": { "type": "string", "nullable": true }, "placa": { "type": "string", "nullable": true }, "uf": { "type": "string", "nullable": true }, "chassi": { "type": "string", "nullable": true }, "municipio": { "type": "string", "nullable": true }, "marca": { "type": "string", "nullable": true }, "modelo": { "type": "string", "nullable": true }, "anoModelo": { "type": "string", "nullable": true }, "anoFabricacao": { "type": "string", "nullable": true }, "tipo": { "type": "string", "nullable": true }, "combustivel": { "type": "string", "nullable": true }, "cor": { "type": "string", "nullable": true }, "numeroMotor": { "type": "string", "nullable": true }, "numeroCambio": { "type": "string", "nullable": true }, "numeroCarroceria": { "type": "string", "nullable": true }, "numeroEixoTraseiro": { "type": "string", "nullable": true }, "numeroEixos": { "type": "string", "nullable": true }, "numeroDoEixoAuxiliar": { "type": "string", "nullable": true }, "especie": { "type": "string", "nullable": true }, "situacaoVeiculo": { "type": "string", "nullable": true }, "procedenciaVeiculo": { "type": "string", "nullable": true }, "capacidadedePassageiros": { "type": "string", "nullable": true }, "cilindrada": { "type": "string", "nullable": true }, "capacidaDeCarga": { "type": "string", "nullable": true }, "dataEmissaoCrlv": { "type": "string", "nullable": true }, "dataEmissaoCrv": { "type": "string", "nullable": true }, "indicadorRemarcacaoChassi": { "type": "boolean", "nullable": true }, "descricaoRemarcacaoChassi": { "type": "string", "nullable": true }, "tipoCarroceria": { "type": "string", "nullable": true }, "categoria": { "type": "string", "nullable": true }, "potencia": { "type": "integer", "format": "int32", "nullable": true }, "pesoBrutoTotal": { "type": "string", "nullable": true }, "capacidadeMaximaTracao": { "type": "string", "nullable": true }, "capacidadeMaximaCarga": { "type": "string", "nullable": true }, "restricoes": { "type": "array", "items": { "type": "string" }, "nullable": true }, "faturado": { "$ref": "#/components/schemas/FaturadoVeiculo" }, "importacao": { "$ref": "#/components/schemas/ImportacaoVeiculo" }, "indicadores": { "$ref": "#/components/schemas/IndicadoresVeiculo" } }, "additionalProperties": false }, "VeiculoEstadual": { "type": "object", "properties": { "marcaModelo": { "type": "string", "nullable": true }, "marca": { "type": "string", "nullable": true }, "modelo": { "type": "string", "nullable": true }, "anoFabricacao": { "type": "string", "nullable": true }, "anoModelo": { "type": "string", "nullable": true }, "tipo": { "type": "string", "nullable": true }, "carroceria": { "type": "string", "nullable": true }, "cor": { "type": "string", "nullable": true }, "especie": { "type": "string", "nullable": true }, "categoria": { "type": "string", "nullable": true }, "combustivel": { "type": "string", "nullable": true }, "potencia": { "type": "integer", "format": "int32", "nullable": true }, "cilindrada": { "type": "string", "nullable": true }, "capacidadeCarga": { "type": "string", "nullable": true }, "procedencia": { "type": "string", "nullable": true }, "capacidadePassageiros": { "type": "string", "nullable": true }, "motor": { "type": "string", "nullable": true }, "numeroCambio": { "type": "string", "nullable": true }, "numeroCarroceria": { "type": "string", "nullable": true }, "numeroEixoTraseiro": { "type": "string", "nullable": true }, "numeroEixoTerceiro": { "type": "string", "nullable": true }, "cmt": { "type": "string", "nullable": true }, "pbt": { "type": "string", "nullable": true }, "eixos": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "VeiculoFipe": { "type": "object", "properties": { "renavam": { "type": "string", "nullable": true }, "placa": { "type": "string", "nullable": true }, "uf": { "type": "string", "nullable": true }, "chassi": { "type": "string", "nullable": true }, "municipio": { "type": "string", "nullable": true }, "marca": { "type": "string", "nullable": true }, "modelo": { "type": "string", "nullable": true }, "anoModelo": { "type": "string", "nullable": true }, "anoFabricacao": { "type": "string", "nullable": true }, "tipo": { "type": "string", "nullable": true }, "combustivel": { "type": "string", "nullable": true }, "cor": { "type": "string", "nullable": true }, "numeroMotor": { "type": "string", "nullable": true }, "numeroCambio": { "type": "string", "nullable": true }, "numeroCarroceria": { "type": "string", "nullable": true }, "numeroEixoTraseiro": { "type": "string", "nullable": true }, "numeroEixos": { "type": "string", "nullable": true }, "numeroDoEixoAuxiliar": { "type": "string", "nullable": true }, "especie": { "type": "string", "nullable": true }, "situacaoVeiculo": { "type": "string", "nullable": true }, "procedenciaVeiculo": { "type": "string", "nullable": true }, "capacidadedePassageiros": { "type": "string", "nullable": true }, "cilindrada": { "type": "string", "nullable": true }, "capacidaDeCarga": { "type": "string", "nullable": true }, "fipe": { "$ref": "#/components/schemas/TabelaVeicularFipe" } }, "additionalProperties": false }, "VeiculoGravame": { "type": "object", "properties": { "marcaModelo": { "type": "string", "nullable": true }, "tipo": { "type": "string", "nullable": true }, "anoFabricacao": { "type": "string", "nullable": true }, "anoModelo": { "type": "string", "nullable": true }, "cor": { "type": "string", "nullable": true }, "especie": { "type": "string", "nullable": true }, "combustivel": { "type": "string", "nullable": true }, "cambio": { "type": "string", "nullable": true }, "motor": { "type": "string", "nullable": true }, "capacidadeCarga": { "type": "string", "nullable": true }, "capacidadeCilindrada": { "type": "string", "nullable": true }, "cmt": { "type": "string", "nullable": true }, "pbt": { "type": "string", "nullable": true }, "potencia": { "type": "string", "nullable": true }, "procedencia": { "type": "string", "nullable": true }, "quantidadePassageiros": { "type": "string", "nullable": true }, "situacaoChassi": { "type": "string", "nullable": true }, "tipoCarroceria": { "type": "string", "nullable": true }, "tipoMontagem": { "type": "string", "nullable": true }, "docImportador": { "type": "string", "nullable": true }, "eixoAuxiliar": { "type": "string", "nullable": true }, "eixoTraseiro": { "type": "string", "nullable": true }, "eixoQuantidade": { "type": "string", "nullable": true } }, "additionalProperties": false }, "VeiculoRouboFurto": { "type": "object", "properties": { "municipio": { "type": "string", "nullable": true }, "uf": { "type": "string", "nullable": true }, "marcaModelo": { "type": "string", "nullable": true }, "tipoVeiculo": { "type": "string", "nullable": true }, "anoFabricacao": { "type": "integer", "format": "int32", "nullable": true }, "anoModelo": { "type": "integer", "format": "int32", "nullable": true }, "procedencia": { "type": "string", "nullable": true }, "especie": { "type": "string", "nullable": true }, "combustivel": { "type": "string", "nullable": true }, "cilindrada": { "type": "integer", "format": "int32", "nullable": true }, "cor": { "type": "string", "nullable": true }, "potencia": { "type": "integer", "format": "int32", "nullable": true }, "capacidadePassageiros": { "type": "integer", "format": "int32", "nullable": true }, "capacidadeCarga": { "type": "integer", "format": "int32", "nullable": true }, "cmt": { "type": "integer", "format": "int32", "nullable": true }, "pbt": { "type": "integer", "format": "int32", "nullable": true }, "motor": { "type": "string", "nullable": true }, "caixaCambio": { "type": "string", "nullable": true }, "numCarroceria": { "type": "string", "nullable": true }, "numEixo": { "type": "integer", "format": "int32", "nullable": true }, "numEixoAux": { "type": "integer", "format": "int32", "nullable": true }, "montagem": { "type": "string", "nullable": true }, "remarcacaoChassi": { "type": "string", "nullable": true }, "restricoes": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "VeiculosFrotas": { "type": "object", "properties": { "placa": { "type": "string", "nullable": true }, "marcaModelo": { "type": "string", "nullable": true }, "cor": { "type": "string", "nullable": true }, "anoFabricacao": { "type": "string", "nullable": true }, "anoModelo": { "type": "string", "nullable": true }, "uf": { "type": "string", "nullable": true }, "tipoVeiculo": { "type": "string", "nullable": true }, "chassi": { "type": "string", "nullable": true }, "renavam": { "type": "string", "nullable": true }, "motor": { "type": "string", "nullable": true } }, "additionalProperties": false }, "VerificacaoEmpregadorTrabalhoForcado": { "type": "object", "properties": { "documentoConsultado": { "type": "string", "nullable": true }, "empregador": { "type": "string", "nullable": true }, "locais": { "type": "array", "items": { "$ref": "#/components/schemas/Local" }, "nullable": true }, "status": { "type": "string", "nullable": true }, "possuiTrabalhoForcado": { "type": "boolean", "nullable": true }, "totalTrabalhadores": { "type": "integer", "format": "int32", "nullable": true }, "dataConsulta": { "type": "string", "nullable": true } }, "additionalProperties": false }, "VerificacaoEmpregadorTrabalhoForcadoRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/VerificacaoEmpregadorTrabalhoForcado" } }, "additionalProperties": false }, "ViagemServico": { "type": "object", "properties": { "numeroPCDP": { "type": "string", "nullable": true }, "ano": { "type": "string", "nullable": true }, "situacao": { "type": "string", "nullable": true }, "tipoViagem": { "type": "string", "nullable": true }, "motivo": { "type": "string", "nullable": true }, "viagemUrgente": { "type": "string", "nullable": true }, "justificativaUrgencia": { "type": "string", "nullable": true }, "cargo": { "type": "string", "nullable": true }, "funcao": { "type": "string", "nullable": true }, "orgao": { "$ref": "#/components/schemas/OrgaoViagem" }, "orgaoPagamento": { "$ref": "#/components/schemas/OrgaoViagem" }, "unidadeGestora": { "$ref": "#/components/schemas/UnidadeGestoraViagem" }, "dataInicioAfastamento": { "type": "string", "nullable": true }, "dataFimAfastamento": { "type": "string", "nullable": true }, "valorDiarias": { "type": "string", "nullable": true }, "valorPassagens": { "type": "string", "nullable": true }, "valorDevolucao": { "type": "string", "nullable": true }, "valorRestituicao": { "type": "string", "nullable": true }, "valorMulta": { "type": "string", "nullable": true }, "valorTaxaAgenciamento": { "type": "string", "nullable": true }, "valorTotalViagem": { "type": "string", "nullable": true } }, "additionalProperties": false }, "VinculoEmpregaticioRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/Empresa" } }, "additionalProperties": false }, "VinculoHistorico": { "type": "object", "properties": { "tipoVinculo": { "type": "string", "nullable": true }, "dataInicio": { "type": "string", "nullable": true }, "dataTermino": { "type": "string", "nullable": true }, "localExercicio": { "type": "string", "nullable": true }, "orgaoLotacao": { "type": "string", "nullable": true }, "cargo": { "type": "string", "nullable": true } }, "additionalProperties": false }, "VinculoServidorFederal": { "type": "object", "properties": { "tipoServidor": { "type": "string", "nullable": true }, "situacao": { "type": "string", "nullable": true }, "matricula": { "type": "string", "nullable": true }, "cargo": { "type": "string", "nullable": true }, "funcao": { "type": "string", "nullable": true }, "orgaoLotacao": { "$ref": "#/components/schemas/OrgaoServidorFederal" }, "orgaoExercicio": { "$ref": "#/components/schemas/OrgaoServidorFederal" }, "ufExercicio": { "type": "string", "nullable": true }, "afastado": { "type": "boolean", "nullable": true }, "nomeInstituidorPensao": { "type": "string", "nullable": true }, "cpfInstituidorPensao": { "type": "string", "nullable": true }, "nomeRepresentanteLegal": { "type": "string", "nullable": true }, "cpfRepresentanteLegal": { "type": "string", "nullable": true }, "fichas": { "type": "array", "items": { "$ref": "#/components/schemas/FichaFuncional" }, "nullable": true } }, "additionalProperties": false }, "VinculoVigente": { "type": "object", "properties": { "tipoVinculo": { "type": "string", "nullable": true }, "cargo": { "type": "string", "nullable": true }, "classeCargo": { "type": "string", "nullable": true }, "padraoCargo": { "type": "string", "nullable": true }, "nivelCargo": { "type": "string", "nullable": true }, "funcao": { "type": "string", "nullable": true }, "regimeJuridico": { "type": "string", "nullable": true }, "situacaoVinculo": { "type": "string", "nullable": true }, "jornadaTrabalho": { "type": "string", "nullable": true }, "matricula": { "type": "string", "nullable": true }, "atoNomeacaoContratacao": { "type": "string", "nullable": true }, "formaIngresso": { "type": "string", "nullable": true }, "localTrabalho": { "type": "string", "nullable": true }, "afastado": { "type": "boolean", "nullable": true }, "dataIngressoCargo": { "type": "string", "nullable": true }, "dataIngressoOrgaoLotacao": { "type": "string", "nullable": true }, "dataIngressoServicoPublico": { "type": "string", "nullable": true }, "dataPublicacaoDocumentoIngresso": { "type": "string", "nullable": true }, "tipoReformaReserva": { "type": "string", "nullable": true }, "dataReformaReserva": { "type": "string", "nullable": true }, "tipoPensao": { "type": "string", "nullable": true }, "dataInicioPensao": { "type": "string", "nullable": true }, "proporcaoPensao": { "type": "string", "nullable": true }, "nomeInstituidor": { "type": "string", "nullable": true }, "cpfInstituidor": { "type": "string", "nullable": true }, "nomeRepresentanteLegal": { "type": "string", "nullable": true }, "cpfRepresentanteLegal": { "type": "string", "nullable": true }, "exercicio": { "$ref": "#/components/schemas/OrgaoVinculo" }, "lotacao": { "$ref": "#/components/schemas/OrgaoVinculo" } }, "additionalProperties": false }, "VinculosSocietarios": { "type": "object", "properties": { "documentoConsultado": { "type": "string", "nullable": true }, "nomeEntidade": { "type": "string", "nullable": true }, "detalhesPessoaFisica": { "$ref": "#/components/schemas/VSEntidadePessoaFisica" }, "detalhesPessoaJuridica": { "$ref": "#/components/schemas/VSEntidadePessoaJuridica" }, "relacionamentos": { "type": "array", "items": { "$ref": "#/components/schemas/VinculosSocietariosRelacionamentos" }, "nullable": true } }, "additionalProperties": false }, "VinculosSocietariosHistorico": { "type": "object", "properties": { "cargo": { "type": "string", "nullable": true }, "status": { "type": "boolean", "nullable": true }, "dataInicio": { "type": "string", "nullable": true }, "dataFim": { "type": "string", "nullable": true } }, "additionalProperties": false }, "VinculosSocietariosRelacionamentos": { "type": "object", "properties": { "documento": { "type": "string", "nullable": true }, "nomeEntidade": { "type": "string", "nullable": true }, "detalhesPessoaFisica": { "$ref": "#/components/schemas/VSEntidadePessoaFisica" }, "detalhesPessoaJuridica": { "$ref": "#/components/schemas/VSEntidadePessoaJuridica" }, "nivel": { "type": "integer", "format": "int32", "nullable": true }, "tipo": { "type": "string", "nullable": true }, "grau": { "type": "string", "nullable": true }, "status": { "type": "boolean", "nullable": true }, "historicos": { "type": "array", "items": { "$ref": "#/components/schemas/VinculosSocietariosHistorico" }, "nullable": true }, "relacionamentos": { "type": "array", "items": { "$ref": "#/components/schemas/VinculosSocietariosRelacionamentos" }, "nullable": true } }, "additionalProperties": false }, "VinculosSocietariosRetorno": { "type": "object", "properties": { "metaDados": { "$ref": "#/components/schemas/MetaDados" }, "retorno": { "$ref": "#/components/schemas/VinculosSocietarios" } }, "additionalProperties": false }, "VolumeNFe": { "type": "object", "properties": { "quantidade": { "type": "integer", "format": "int64", "nullable": true }, "especie": { "type": "string", "nullable": true }, "pesoBruto": { "type": "string", "nullable": true }, "pesoLiquido": { "type": "string", "nullable": true } }, "additionalProperties": false } }, "securitySchemes": { "BEARER": { "type": "http", "description": "Forma recomendada de autenticar nas APIs da Direct Data.
Envie o seu Token da plataforma no header: Authorization: Bearer {seu-token}

Mantém o token fora da URL — e portanto fora de log de servidor, proxy e histórico de browser.", "scheme": "bearer", "bearerFormat": "GUID" }, "X-API-Token": { "type": "apiKey", "description": "Alternativa ao Authorization: Bearer, para integrações que não podem usar o header Authorization (gateways que o reescrevem, por exemplo).
Envie o seu Token da plataforma no header: X-API-Token: {seu-token}", "name": "X-API-Token", "in": "header" }, "TOKEN": { "type": "apiKey", "description": "Legado. Autenticação das APIs da Direct Data pela query string (?TOKEN={seu-token}). Continua funcionando normalmente, mas recomendamos migrar para o header Authorization: Bearer — o token na URL fica registrado em log de servidor, proxy e histórico de browser.

Insira o seu Token da plataforma.", "name": "TOKEN", "in": "query" } } }, "security": [ { "BEARER": [ ] }, { "X-API-Token": [ ] }, { "TOKEN": [ ] } ], "tags": [ { "name": "* API - Recuperar consulta pelo UID" }, { "name": "Acordos de Leniência" }, { "name": "AML - Anti Money Laundering (Vínculos Societários)" }, { "name": "Antifraude Chave PIX" }, { "name": "ANTT - Código Identificador Operação Transporte" }, { "name": "ANTT - Consulta de Regularidade da Transportadora" }, { "name": "APF Rural - Autorização Provisória de Funcionamento Rural" }, { "name": "Austrália DFAT - Sanções Internacionais" }, { "name": "Auxílio Emergencial" }, { "name": "Auxílio Reconstrução" }, { "name": "Banco Central - Quadro Geral de Inabilitados" }, { "name": "Banco Central - Quadro Geral de Proibidos" }, { "name": "Beneficiário Final" }, { "name": "Benefício de Prestação Continuada - BPC" }, { "name": "Benefícios Sociais - Pessoa Física" }, { "name": "Bet Safe Compliance " }, { "name": "Boa Vista - Acerta Completo Positivo Pessoa Física" }, { "name": "Boa Vista - Acerta Mais Positivo Pessoa Física" }, { "name": "Boa Vista - Define Limite Positivo Pessoa Jurídica" }, { "name": "Boa Vista - Risco Positivo Pessoa Jurídica" }, { "name": "Bolsa Família" }, { "name": "Cadastro - Pessoa Física - Básica" }, { "name": "Cadastro - Pessoa Física - Plus" }, { "name": "Cadastro - Pessoa Jurídica - Básica" }, { "name": "Cadastro - Pessoa Jurídica - Plus" }, { "name": "Cadastro + Receita Federal - Pessoa Física" }, { "name": "CADIN - Secretaria da Fazenda - São Paulo" }, { "name": "CADIN - Secretaria da Fazenda" }, { "name": "CAF - Cadastro Nacional de Agricultura Familiar - PF" }, { "name": "CAF - Cadastro Nacional de Agricultura Familiar - PJ" }, { "name": "CAFIR - Cadastros de Imóveis Rurais" }, { "name": "Canada SEMA - Sanções Internacionais" }, { "name": "CAR - Cadastro Ambiental Rural" }, { "name": "CARF - Conselho Administrativo de Recursos Fiscais" }, { "name": "CCD - Certidão Conjunta de Débitos - Pessoa Física" }, { "name": "CCD - Certidão Conjunta de Débitos - Pessoa Jurídica" }, { "name": "CEAF - Cadastro de Expulsões da Administração Federal" }, { "name": "CEIS - Cadastro de Empresas Inidôneas e Suspensas" }, { "name": "CEPIM - Cadastro de Entidades Privadas Sem Fins Lucrativos Impedidas" }, { "name": "Certificado Anbima EDU" }, { "name": "CFM - Conselho Federal de Medicina" }, { "name": "CND - Certidão Negativa de Débitos Estaduais" }, { "name": "CNDIR - Certidão Negativa de Débitos e Dívida Ativa da União de Imóvel Rural" }, { "name": "CNDM - Certidão Negativa de Débitos Municipal" }, { "name": "CNEP - Cadastro Nacional de Empresas Punidas" }, { "name": "CNH - Carteira Nacional de Habilitação Completa" }, { "name": "CNH - Carteira Nacional de Habilitação Plus" }, { "name": "CNH - Carteira Nacional de Habilitação" }, { "name": "CNIA - Cadastro Nacional de Condenações Cíveis por Ato de Improbidade Administrativa e Inelegibilidade" }, { "name": "CNJ - Mandados de Prisão" }, { "name": "CONFEA/CREA - Conselho Federal de Engenharia e Agronomia" }, { "name": "Consulta Veicular - CRLV-e SP" }, { "name": "Consulta Veicular - Estadual" }, { "name": "Consulta Veicular - Frotas Nacional" }, { "name": "Consulta Veicular - Gravame" }, { "name": "Consulta Veicular - Histórico de Proprietários" }, { "name": "Consulta Veicular - Leilão Veicular" }, { "name": "Consulta Veicular - Nacional" }, { "name": "Consulta Veicular - Proprietário Atual" }, { "name": "Consulta Veicular - Recall" }, { "name": "Consulta Veicular - Renainf" }, { "name": "Consulta Veicular - Renajud" }, { "name": "Consulta Veicular - Roubo e Furto" }, { "name": "Consulta Veicular Serpro - Multas Radar" }, { "name": "Consultoria Geral da União - CGU" }, { "name": "Correios - Busca CEP" }, { "name": "CVM - Comissão de Valores Mobiliários" }, { "name": "CVM - Processos Administrativos Sancionadores" }, { "name": "DAP - Declaração de Aptidão ao Pronaf - Pessoa Física" }, { "name": "DAP - Declaração de Aptidão ao Pronaf - Pessoa Jurídica" }, { "name": "Detalhamento Negativo QUOD" }, { "name": "Dossiê QUOD - Completo" }, { "name": "Enriquecimento de Lead" }, { "name": "EU Financial Sanctions List " }, { "name": "FBI - Most Wanted" }, { "name": "FGTS - Regularidade do Empregador " }, { "name": "FINCEN - Financial Crimes Enforcement Network" }, { "name": "Garantia Safra" }, { "name": "Gás do Povo" }, { "name": "Histórico Veicular PF e PJ - Nacional" }, { "name": "Histórico Veicular PF e PJ - São Paulo" }, { "name": "IBAMA - Certidão Negativa de Débitos" }, { "name": "IBAMA - Certidão Negativa de Embargo" }, { "name": "IBAMA - Certificado de Regularidade" }, { "name": "IBAMA - Consulta de Autuações Ambientais" }, { "name": "Identity Verification - Argentina" }, { "name": "INTERPOL" }, { "name": "Ministério do Trabalho - PIS" }, { "name": "Ministério do Trabalho e do Emprego (MTE) - Infrações Trabalhistas" }, { "name": "Ministério Público do Estado de Mato Grosso (MPMT) - Procedimentos Investigatórios Extrajudiciais" }, { "name": "Ministério Público Federal - Certidão Negativa" }, { "name": "MPT - Ministério Público do Trabalho " }, { "name": "NFe - Nota Fiscal Eletrônica - Completa" }, { "name": "NFe - Nota Fiscal Eletrônica - Inutilizações" }, { "name": "Nível Socioeconômico e Renda Estimada" }, { "name": "OAB - Cadastro Nacional dos Advogados" }, { "name": "Óbito" }, { "name": "OFAC - Sanctions List (SND and Non-SDN)" }, { "name": "Offshore Leaks - ICIJ" }, { "name": "PEP - Pessoa Exposta Politicamente" }, { "name": "PEP Estendida - Pessoa Exposta Politicamente + Parentescos" }, { "name": "PETI - Programa de Erradicação do Trabalho Infantil" }, { "name": "PGFN - Lista de Devedores da União" }, { "name": "Polícia Civil - Antecedentes Criminais" }, { "name": "Polícia Federal - Antecedentes Criminais" }, { "name": "Polícia Rodoviária Federal - Infrações" }, { "name": "Portal da Transparência - Indicadores Pessoa Física" }, { "name": "Portal da Transparência - Indicadores Pessoa Jurídica" }, { "name": "Portal da Transparência - Servidores - Completa" }, { "name": "Portal da Transparência - Servidores - Remuneração" }, { "name": "Portal da Transparência - Servidores do Poder Executivo Federal" }, { "name": "Portal da Transparência - Servidores Viagens e despesas" }, { "name": "Processos Judiciais - Agrupada (Base)" }, { "name": "Processos Judiciais - Completa (Base)" }, { "name": "Processos Judiciais - Simplificada (Base)" }, { "name": "Protestos Nacional - IEPTB Básica" }, { "name": "Protestos Nacional - IEPTB Completa" }, { "name": "Protestos Nacional - IEPTB Online" }, { "name": "Receita Federal - Pessoa Física" }, { "name": "Receita Federal - Pessoa Jurídica - QSA + Participação Societária" }, { "name": "Receita Federal - Pessoa Jurídica" }, { "name": "Registration Data - Argentina" }, { "name": "Registration Data - Brazil" }, { "name": "Registration Data - México" }, { "name": "Restituição Imposto de Renda - IRPF" }, { "name": "Score de Crédito - QUOD" }, { "name": "SCR Analítico - Resumo BACEN" }, { "name": "SCR Detalhada - Resumo BACEN" }, { "name": "Seguro Defeso" }, { "name": "Similarity - Argentina" }, { "name": "Similarity - Brazil" }, { "name": "Similarity - México" }, { "name": "Simples Nacional" }, { "name": "Sintegra - Cadastro Centralizado de Contribuinte - CCC" }, { "name": "Sintegra - Cadastros Estaduais" }, { "name": "Sintegra - CCC - Completa" }, { "name": "STM - Certidão Negativa da União" }, { "name": "Suframa - CNPJ" }, { "name": "Suíça SECO - Sanções Internacionais" }, { "name": "TCU - Certidão Negativa de Licitante Inidôneo" }, { "name": "TCU - Certidão Negativa de Processo" }, { "name": "TCU - Consulta Consolidada de Pessoa Jurídica - APF" }, { "name": "TJ - Certidão Cível, Criminal e Fiscal - Tribunal de Justiça" }, { "name": "TJ - Tribunal de Justiça - Processos" }, { "name": "TRF - Tribunal Regional Federal (Certidão Cível, Eleitoral ou Criminal)" }, { "name": "TRT - Tribunal Regional do Trabalho" }, { "name": "TSE - Certidão de Crimes Eleitorais" }, { "name": "TSE - Certidão de Quitação Eleitoral" }, { "name": "TSE - Situação Eleitoral" }, { "name": "TSE - Título e Local de Votação" }, { "name": "TST - Certidão Negativa de Débitos Trabalhistas" }, { "name": "UK Hm Treasury - Financial Sanctions" }, { "name": "UNSCCL - United Nations Security Council Consolidated List" }, { "name": "Veículos - FIPE" }, { "name": "Verificação de Empregador - Trabalho Forçado" }, { "name": "Vínculo Empregatício" }, { "name": "Vínculos Societários" } ] }