KLEVER SASS REST CLIENT API
  1. Documentos de análise.
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.
            GET
          • Gerar OCR do documento IRPF
            POST
          • Gerar OCR do documento IRPF with Hook
            POST
          • Obter listagem de documentos da empresa ou pessoa pelo documento.
            GET
          • Enviar documento de análise (PDF).
            POST
          • Obter os dados de faturamento pelo documento.
            GET
          • Obter endividamento pelo documento.
            GET
          • Obter os dados de IRPF pelo documento.
            GET
      • Balances
        • Obter o resumo do balanço pelo documento.
        • Obter balanço pelo documento.
  1. Documentos de análise.

Obter os dados de OCR IRPF pelo id.

Prod Env
https://api.klever.tec.br/api
Prod Env
https://api.klever.tec.br/api
GET
/v2/ondemand/ocr/irpf/{id}

Requisição

Authorization
Forneça seu token bearer no cabeçalho
Authorization
ao fazer requisições para recursos protegidos.
Exemplo:
Authorization: Bearer ********************
Parâmetros Path

Exemplos de Requisição

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.klever.tec.br/api/v2/ondemand/ocr/irpf/'

Respostas

🟢200Success
application/json
Body

Exemplo
{
    "assetsRights": {
        "items": [
            {
                "account": "string",
                "acquisitionDate": "string",
                "address": "string",
                "agency": "string",
                "area": "string",
                "autoCustodian": "string",
                "bank": "string",
                "ceiCno": "string",
                "cibNirf": "string",
                "cnpj": "string",
                "cnpjCustodian": "string",
                "cnpjFund": "string",
                "code": "string",
                "countryCode": "string",
                "countryName": "string",
                "cpf": "string",
                "currentValue": 0,
                "description": "string",
                "group": "string",
                "municipalInscriptionIPTU": "string",
                "municipality": "string",
                "number": "string",
                "owner": "string",
                "plate": "string",
                "previousValue": 0,
                "registryOffice": "string",
                "registryOfficeName": "string",
                "renavam": "string",
                "state": "string",
                "tradedStockExchange": "string",
                "unit": "string",
                "vesselRegistry": "string",
                "zip": "string"
            }
        ],
        "total": 0
    },
    "debtsLinkedRuralActivity": {
        "items": [
            {
                "code": "string",
                "currentValue": 0,
                "description": "string",
                "item": "string",
                "previousValue": 0,
                "value": 0
            }
        ],
        "total": 0
    },
    "debtsRealEncumbrances": {
        "items": [
            {
                "code": "string",
                "currentValue": 0,
                "description": "string",
                "item": "string",
                "previousValue": 0,
                "value": 0
            }
        ],
        "total": 0
    },
    "declarationData": {
        "controlNumber": "string",
        "declarationDate": "string",
        "declarationType": "string",
        "exerciseYear": 0
    },
    "deductions": {
        "items": [
            {
                "description": "string",
                "value": 0
            }
        ],
        "total": 0
    },
    "dependents": {
        "list": [
            {
                "bornDate": "string",
                "celular": "string",
                "code": "string",
                "cpf": "string",
                "email": "string",
                "liveOwner": "string",
                "name": "string"
            }
        ],
        "totalDeduction": "string"
    },
    "donationsMade": {
        "items": [
            {
                "code": "string",
                "document": "string",
                "name": "string",
                "noDeductibleValue": 0,
                "paidAmountValue": 0
            }
        ],
        "total": 0
    },
    "herdMovements": {
        "items": [
            {
                "acquisitions": 0,
                "births": 0,
                "consumptionLosses": 0,
                "finalStock": 0,
                "initialStock": 0,
                "sales": 0,
                "species": "string"
            }
        ],
        "total": 0
    },
    "id": "string",
    "identificationExploitedProperties": {
        "items": [
            {
                "area": 0,
                "cib": "string",
                "code": "string",
                "condition": "string",
                "description": "string",
                "participation": 0
            }
        ],
        "total": 0
    },
    "nonTaxableIncomeExempt": {
        "items": [
            {
                "beneficiaryList": [
                    {
                        "formattedCpf": "string",
                        "name": "string",
                        "nis": "string"
                    }
                ],
                "code": "string",
                "description": "string",
                "value": 0
            }
        ],
        "total": 0
    },
    "othersInformations": {
        "items": [
            {
                "description": "string",
                "value": 0
            }
        ],
        "total": 0
    },
    "patrimonialEvolution": {
        "items": [
            {
                "description": "string",
                "value": 0
            }
        ],
        "total": 0
    },
    "paymentsMade": {
        "items": [
            {
                "code": "string",
                "description": "string",
                "document": "string",
                "name": "string",
                "noDeductibleValue": 0,
                "paidAmountValue": 0
            }
        ],
        "total": 0
    },
    "person": {
        "age": 0,
        "birthDate": "2024-12-13",
        "cns": "string",
        "corporatesParticipation": [
            {
                "businessActivityCnae": "string",
                "cnpj": "string",
                "descriptionCnae": "string",
                "entryDate": "2024-12-13T16:55:23.497Z",
                "estimatedBilling": "string",
                "estimatedBillingGroup": "string",
                "levelPreparation": "string",
                "levelPreparationRF": "string",
                "municipality": "string",
                "openingDate": "2024-12-13T16:55:23.497Z",
                "participation": 0,
                "participationRF": 0,
                "participationSocialCapital": 0,
                "participationSocialCapitalRF": 0,
                "qualification": "string",
                "qualificationRF": "string",
                "situation": "string",
                "socialCapital": "string",
                "socialReason": "string",
                "uf": "string"
            }
        ],
        "cpf": "string",
        "dead": true,
        "deadConfirmation": true,
        "deadDate": 0,
        "debitPgfnDauValue": "string",
        "deficiency": true,
        "deficiencyType": "string",
        "disabilitiesBacens": [
            {
                "duration": 0,
                "penalty": "string",
                "penaltyPeriodDate": "2024-12-13T16:55:23.498Z",
                "publicationDate": "2024-12-13T16:55:23.498Z"
            }
        ],
        "educationLevel": "string",
        "email": "string",
        "fatherName": "string",
        "historicalCriminal": {
            "consultationDate": "2024-12-13",
            "protocol": "string",
            "situation": "string",
            "status": "string"
        },
        "historicalFunctional": [
            {
                "admissionDate": "2024-12-13",
                "cnpj": "string",
                "dismissedDate": "2024-12-13",
                "months": 0,
                "socialReason": "string"
            }
        ],
        "id": "string",
        "inscriptionCpfDate": "string",
        "irpf": [
            {
                "agency": "string",
                "availabilityDate": "2024-12-13",
                "bank": "string",
                "lot": "string",
                "statementStatus": "string",
                "yearExercise": 0
            }
        ],
        "judicialProcess": {
            "judicialProcessQuantities": [
                {
                    "quantityActive": 0,
                    "quantityActivePart": 0,
                    "quantityOthers": 0,
                    "quantityPassivePart": 0,
                    "quantityTotal": 0,
                    "type": "string"
                }
            ],
            "totalActiveValue": 0,
            "totalOthersValue": 0,
            "totalPassiveValue": 0,
            "totalValue": 0
        },
        "mainAddress": {
            "addressLine": "string",
            "city": "string",
            "country": "string",
            "district": "string",
            "state": "string",
            "zipCode": "string"
        },
        "motherCpf": "string",
        "motherName": "string",
        "name": "string",
        "nis": "string",
        "originCountry": "string",
        "otherAddresses": [
            {
                "addressLine": "string",
                "city": "string",
                "country": "string",
                "district": "string",
                "state": "string",
                "zipCode": "string"
            }
        ],
        "phones": [
            "string"
        ],
        "professionCbo": "string",
        "professionNeoway": "string",
        "protestLastConsultDate": "2024-12-13T16:55:23.499Z",
        "publicAgent": true,
        "quantityQsaUnique": 0,
        "registerSituation": "string",
        "relationships": [
            {
                "creationDate": "2024-12-13T16:55:23.499Z",
                "datasource": "string",
                "document": "string",
                "documentCountry": "string",
                "documentType": "string",
                "lastUpdate": "2024-12-13T16:55:23.499Z",
                "name": "string",
                "relationDescription": "string",
                "relationEndDate": "2024-12-13T16:55:23.499Z",
                "relationLevel": "string",
                "relationStartDate": "2024-12-13T16:55:23.499Z",
                "relationType": "string"
            }
        ],
        "sex": "string",
        "situation": "string",
        "situationCpf": "string",
        "socialInscription": "string"
    },
    "revenuesExpenses": {
        "items": [
            {
                "expenses": 0,
                "month": "string",
                "revenues": 0
            }
        ],
        "total": 0
    },
    "ruralActivityAssets": {
        "items": [
            {
                "code": "string",
                "currentValue": 0,
                "description": "string",
                "previousValue": 0
            }
        ],
        "total": 0
    },
    "status": "string",
    "taxPaidWithheld": {
        "items": [
            {
                "description": "string",
                "value": 0
            }
        ],
        "total": 0
    },
    "taxableIncome": {
        "items": [
            {
                "description": "string",
                "value": 0
            }
        ],
        "total": 0
    },
    "taxableIncomeExclusiveFinal": {
        "items": [
            {
                "beneficiaryList": [
                    {
                        "formattedCpf": "string",
                        "name": "string",
                        "nis": "string"
                    }
                ],
                "code": "string",
                "description": "string",
                "value": 0
            }
        ],
        "total": 0
    },
    "taxableIncomePJHolder": {
        "items": [
            {
                "document": "string",
                "fontName": "string",
                "incomeTaxSalary13": 0,
                "salary13": 0,
                "socialSecurityContribution": 0,
                "taxableIncomeReceive": 0,
                "withholdingTax": 0
            }
        ],
        "total": 0
    }
}
Modificado em 2024-12-13 17:15:14
Página anterior
Carregar Documento SPED (URL).
Próxima página
Gerar OCR do documento IRPF
Built with