KLEVER SASS REST CLIENT API
    KLEVER SASS REST CLIENT API
    • DOCUMENTAÇÃO
    • KLEVER SASS REST CLIENT API
      • login
        • Login de usuário do cliente de aplicativo.
      • v1
        • accompaniment
          • Cria um novo acompanhamento.
          • Obter todas as empresas de suporte para uma organização.
          • Obter pontuação das alertas de empresas em acompanhamento por ID da organização e cnpj.
          • Aplicar alertas dinâmicas por id da organização e cnpj, alertas manuais aplicados também são retornados.
          • Aplicar todos os vetos dinâmicos por ID da organização e CNPJ.
        • credit_analysis
          • Solicitar análise de crédito com certificado A1.
          • Solicitar análise de crédito a través do sped e notas fiscais.
          • Enviar o resultado para análise pelo cnpj para a url de callback da empresa.
        • report
          • Obter relatório de Serasa PJ em formato pdf.
          • Obter o relatório em (pdf) da análise de uma empresa.
          • Obter relatório scr em formato pdf.
          • Obter relatório scr em formato xlsx.
          • Gerar relatorio Método K em formato pdf.
          • Gerar relatorio Método K em formato xlsx.
        • methodk
          • Gerar Método K.
          • Obter o Histórico do Método K.
        • certificate
          • Carregar certificado Base64 RFC4648.
          • Enviar solicitação de autorização de Certificado Digital A1.
          • Obter dados de certificado digital.
        • document_ocr
          • Carregar documento em (pdf) para OCR.
          • Obter listagem de documentos da empresa.
          • Obter os dados de IRPF da empresa pelo CNPJ.
          • Obter os dados de endividamento da empresa pelo CNPJ.
          • Obter os dados de faturamento da empresa pelo CNPJ.
        • fiscal_notes
          • Obter análise vertical das notas fiscais.
          • Carregar Documento Nota Fiscal (Xml).
          • Obter análise de Nota Fiscal.
          • Obter análise horizontal das notas fiscais.
        • sped
          • Carregar Documento SPED (Txt).
          • Carregar Documento SPED (Base64).
          • Carregar Documento SPED (URL).
          • Obter balances pelo CNPJ
          • Obter análise do Sped.
        • power_attorney
          • Criar uma autorização de procuração.
          • Criar um pedido de autorização de procuração para um contato.
          • Obter todas as autorizações power of attorney da organização ativa.
        • serasa
          • Atualizar as informações de Serasa de uma empresa.
          • Obter as informações de Serasa de uma empresa
          • Atualizar as informações de Serasa de uma pessoa.
          • Obter as informações de Serasa de uma pessoa
        • scr
          • Criar autorização de SCR do BACEN.
          • Enviar solicitação de autorização de SCR do BACEN.
          • Atualizar as informações do SCR.
          • Obter as informações de SCR de uma empresa
          • Obter o análise do SCR para uma empresa
          • Obter todas as autorizações da organização ativa.
          • Atualizar estado de um análise
        • company
          • Adicionar lista de empresas.
          • Adicionar empresa dado o cnpj.
          • Obter os dados de uma empresa dado o cnpj.
          • Obter as imagens de geolocalização para um cnpj.
          • Obter todas as informações de uma empresa por cnpj
          • Atualizar dados de uma empresa dado o cnpj.
          • Obter as empresas da organização ativa.
          • Excluir empresa a partir do Cnpj.
          • Obter todas as informações de uma empresa por cnpj v2
      • v2
        • Acompanhamento
          • Aplicar todos os vetos dinâmicos pelo documento.
          • Aplicar alertas dinâmicas por ID da organização e documento.
          • Gerar pontuação das alertas de empresas em acompanhamento pelos documentos.
          • Criar um acompanhamento pelos CNPJs.
          • Obter todas as empresas em acompanhamento.
        • Reportes
          • Obter relatório dos dados da empresa em formato PDF.
          • Obter relatório SCR em formato PDF.
          • Obter relatório SCR em formato XLSX.
          • Obter relatório One Pager em formato PDF.
          • Obter relatório One Pager em formato XLSX.
        • Certificado Digital
          • Processa as informações do certificado para um documento e organização.
          • Carregar um certificado digital para a organização.
          • Obter dados de certificado digital.
          • Enviar solicitação de autorização de Certificado Digital A1.
          • Carregar um certificado digital para uma empresa.
        • OnDemand
          • Empresas
            • Cadastro
              • Obter uma empresa pelo documento.
              • Excluir empresa pelo documento.
              • Adicionar empresa pelo documento.
              • Obter todas as empresas.
            • Evolução da empresa.
              • Atualizar dados de evolução da empresa pelo documento
              • Obter dados de evolução da empresa pelo documento
            • Dados gerais da empresa.
              • Obter dados básicos da empresa pelo documento
              • Obter dados cadastrais da empresa pelo documento
              • Atualizar informações dos dados gerais da empresa pelo documento
              • Obter dados gerais da empresa pelo documento
            • Relacionamentos da empresa.
              • Atualizar relacionamentos da empresa pelo documento.
              • Obter relacionamentos da empresa pelo documento.
            • Bndes
              • Obter informações do BNDES pelo documento.
            • Geolocalização
              • Obter as imagens de geolocalização de uma empresa pelo documento
              • Obter os dados de geolocalização de uma empresa pelo documento
            • Informações históricas
              • Obter os dados de informações históricas de uma empresa pelo documento.
              • Atualizar os dados de informações históricas de uma empresa pelo documento.
            • Sidra
              • Obter a produção física industrial.
              • Atualizar a produção física industrial.
            • Cri Cra da empresa
              • Obter Cri ou Cra a partir do documento e o tipo do dado
              • Atualizar dados referente ao Cri ou Cra a partir do documento
            • Debentures da empresa
              • Obter Debentures a partir do documento
              • Atualizar dados referentes ao Debentures pelo documento
            • Serasa
              • Atualizar as informações do Serasa de uma empresa pelo documento.
              • Obter as informações do Serasa de uma empresa pelo documento.
            • Grupo econômico.
              • Obter grupo econômico da empresa pelo documento
              • Atualizar grupo econômico da empresa pelo documento
          • Certificados de Debitos
            • Siproquim
              • Obter informações do SIPROQUIM pelo documento.
              • Atualizar informações do SIPROQUIM pelo documento.
            • Certidão Negativa de Debitos Estadual
              • Obter informações do debt-absence pelo documento.
              • Atualizar informações do debt-absence pelo documento.
            • Certidão Negativa de Débitos Trabalhistas
              • Atualizar informações do labor-debts pelo documento.
              • Obter informações do labor-debts pelo documento.
            • FGTS
              • Obter informações do FGTS pelo documento.
              • Atualizar informações do FGTS pelo documento.
            • IBAMA
              • Obter informações do IBAMA pelo documento.
              • Atualizar informações do IBAMA pelo documento.
            • IRT
              • Obter informações do IRT pelo documento e nirf.
              • Atualizar informações do IRT pelo documento e nirf.
            • PGFN
              • Obter informações do PGFN pelo documento.
              • Atualizar informações do PGFN pelo documento.
          • Sanções
            • CEPIM
              • Obter informações do CEPIM pelo documento.
              • Atualiza os dados CEPIM com base no documento (CPF ou CNPJ) fornecido. Retorna um código de status HTTP 200 (OK) se a atualização for bem-sucedida.
            • CNEP
              • Obter informações do CNEP pelo documento.
              • Atualiza os dados do CNEP com base no documento (CPF ou CNPJ) fornecido. Retorna um código de status HTTP 200 (OK) se a atualização for bem-sucedida.
            • CEIS
              • Obter informações do CEIS pelo documento.
              • Atualizar dados CEIS pelo documento.
            • Acordos de leniência
              • Atualizar Acordo de leniência pelo documento.
              • Obter Acordo de leniência pelo documento.
          • Pessoas
            • Cadastro
              • Criar uma pessoa pelo documento.
              • Obter uma pessoa pelo documento.
              • Excluir uma pessoa pelo documento.
            • Dados financeiros da Pessoa
              • Obter dados financeiros da pessoa pelo documento.
              • Atualizar informações de dados financeiros da pessoa pelo documento.
            • Dados gerais da pessoa
              • Obter dados gerais da pessoa pelo documento.
              • Atualizar informações de dados gerais da pessoa pelo documento.
            • Dados de relacionamentos comerciais de pessoa
              • Atualizar relações comerciais de pessoa pelo documento.
              • Obter relações comerciais de pessoa pelo documento.
            • Serasa
              • Atualizar as informações do Serasa de uma pessoa pelo documento.
              • Obter as informações do Serasa de uma pessoa pelo documento.
            • Auxílio emergencial
              • Atualizar dados do Auxílio emergencial pelo documento.
              • Obter informações do Auxílio emergencial pelo documento.
            • Bolsa Familia
              • Obter Bolsa Família da pessoa pelo documento.
              • Atualizar Bolsa Família da pessoa pelo documento.
          • Scr
            • Criar autorização de SCR do BACEN.
            • Enviar solicitação de autorização de SCR do BACEN.
            • Atualizar informações de SCR.
            • Obter todas as autorizações da organização ativa.
            • Obter informações de SCR pelo documento.
            • Obter resumo da análise de SCR pelo documento.
          • Protestos
            • Obter informações de protesto pelo documento.
            • Atualizar informações de protesto pelo documento.
          • Kyc
            • Atualizar dados KYC dos sócios da empresa pelo documento
            • Atualizar dados do KYC pelo documento
            • Obter dados KYC dos sócios da empresa pelo documento
            • Obter dados do KYC pelo documento
          • Processos Judiciais
            • Obter processos judiciais pelo documento
            • Atualizar processos judiciais pelo documento
            • Obter resumo dos processos judiciais pelo documento
            • Obter dados de processos judiciais
          • Ibge
            • Atualizar informações do IBGE por Unidade Federal e município
            • Obter informações do IBGE por Unidade Federal e município
        • Documento de análise
          • Notas Fiscais.
            • Gerar análise de Nota Fiscal.
            • Gerar análise horizontal das notas fiscais.
            • Gerar análise vertical das notas fiscais.
            • Carregar Documento Nota Fiscal (Xml).
          • Sped
            • Obter análise do SPED.
            • Obter dados dos SPED por documento.
            • Carregar Documento SPED (Txt).
            • Carregar Documento SPED (Base64).
            • Carregar Documento SPED (URL).
          • Documentos de análise.
            • Obter os dados de OCR IRPF pelo id.
            • Gerar OCR do documento IRPF
            • Gerar OCR do documento IRPF with Hook
            • Obter listagem de documentos da empresa ou pessoa pelo documento.
            • Enviar documento de análise (PDF).
            • Obter os dados de faturamento pelo documento.
            • Obter endividamento pelo documento.
            • Obter os dados de IRPF pelo documento.
        • Balances
          • Obter o resumo do balanço pelo documento.
          • Obter balanço pelo documento.

    DOCUMENTAÇÃO

    📄 Documentação#

    Login de cliente
    Recurso Empresas
    Recurso SCR do BACEN
    Recurso de Procuração
    Recurso de SPED ECF
    Recurso de Notas Fiscais
    Recurso de OCR em documentos (PDF)
    Recurso de Certificado Digital
    Recurso de Método K
    Recurso de Relatório
    Recurso de Análise de Crédito
    Recurso de Acompanhamento

    Login de cliente#

    O primeiro passo é fazer login para isso tem duas alternativas. A primeira é menos flexível pois vai precisar desenvolver a lógica quando expirar o token e o tratamento do erro 401.
    image.png
    Consiste em fazer um request enviando clientId e secret que retorna o token que vai ser utilizado nas próximas solicitações.
    A segunda alternativa é seguindo o protocolo Oauth2 que pode ser configurado como mostra a seguinte imagem:
    image.png
    Seguindo este protocolo não precisa se preocupar pela expiração do token pois os framework backend tem a possibilidade de configurar isto.

    Recurso Empresas#

    Recursos para gestão de empresas na organização.

    Cadastrar empresa#

    Para cadastrar uma nova empresa na sua organização da Klever você deve fornecer somente o cnpj da empresa.
    image.png

    Ver dados de empresa#

    Para obter todos os dados de BigData de uma empresa basta solicitar usando o cnpj como mostra a imagem a seguir:
    image.png

    Atualizar dados de uma empresa#

    Para atualizar os dados de uma empresa você deve fornecer somente o cnpj da empresa.
    image.png

    Obter listagem de empresas na organização#

    Para obter a listagem de empresas na organização basta fazer o request como mostra a imagem abaixo.
    image.png

    Recurso SCR do BACEN#

    Recursos para gestão de SCR do BACEN.

    Criar autorização de SCR do BACEN#

    O primeiro passo, se você é o responsável da empresa é criar a autorização de SCR do BACEN para uma empresa.
    image.png

    Enviar solicitação de autorização de SCR do BACEN#

    Se você não é o responsável da empresa pode enviar uma solicitação de autorização de SCR do BACEN para um contato responsável da empresa. Deve fornecer (Nome, E-mail e CPF de contato, CNPJ da empresa).
    image.png

    Atualizar informações de SCR do BACEN#

    Quando desejar atualizar as informações de SCR do BACEN da empresa deve fornecer os seguintes dados (CNPJ da empresa e quantidade de meses para consultar).
    image.png

    Obter informações de SCR do BACEN de uma empresa#

    O endpoint de consulta de informações de SCR (Sistema de Informações de Crédito) do Banco Central do Brasil (BACEN) oferece uma maneira eficiente e segura de obter detalhes relevantes sobre a situação de crédito de uma empresa. Ao utilizar este endpoint, você poderá acessar informações cruciais que auxiliarão na avaliação de crédito, tomada de decisões financeiras e análise de risco associadas à empresa em questão.
    image.png

    Obter análise de informações de SCR do BACEN de uma empresa#

    Oferece uma solução poderosa para avaliar e interpretar de maneira aprofundada as informações de crédito de uma empresa. Ao utilizar este endpoint, você poderá realizar análises detalhadas das informações fornecidas pelo BACEN, permitindo uma compreensão abrangente da situação financeira e do perfil de crédito da empresa em foco.
    image.png

    Obter listagem de autorizações SCR do BACEN da organização#

    Obter listagem de autorizações SCR do BACEN da organização
    image.png

    Atualizar estado de uma autorização de SCR#

    Para atualizar o estado de uma autorização de SCR deve fornecer dados (Id e Status de autorização)
    image.png
    Próxima página
    KLEVER SASS REST CLIENT API
    Built with