KLEVER SASS REST CLIENT API
  1. serasa
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.
          PUT
        • Obter as informações de Serasa de uma empresa
          GET
        • Atualizar as informações de Serasa de uma pessoa.
          PUT
        • Obter as informações de Serasa de uma pessoa
          GET
      • 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.
  1. serasa

Atualizar as informações de Serasa de uma empresa.

Prod Env
https://api.klever.tec.br/api
Prod Env
https://api.klever.tec.br/api
PUT
/external_resource/serasa/company/update
Atualizar as informações de Serasa de uma empresa dado o CNPJ.

Requisição

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

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 PUT 'https://api.klever.tec.br/api/external_resource/serasa/company/update?document=12456606000115'

Respostas

🟢200OK
application/json
Body

Exemplo
{
    "created": "2019-08-24T14:15:22Z",
    "facts": {
        "bankrupts": {
            "response": [
                {
                    "city": "string",
                    "eventDate": "2019-08-24",
                    "eventType": "string",
                    "origin": "string",
                    "state": "string"
                }
            ],
            "summary": {
                "balance": 0,
                "count": 0
            }
        },
        "judgementFilings": {
            "response": [
                {
                    "amount": 0,
                    "city": "string",
                    "civilCourt": "string",
                    "distributor": "string",
                    "legalNature": "string",
                    "legalNatureId": "string",
                    "occurrenceDate": "2019-08-24",
                    "state": "string"
                }
            ],
            "summary": {
                "balance": 0,
                "count": 0
            }
        }
    },
    "negativeData": {
        "check": {
            "response": [
                {
                    "alinea": 0,
                    "bankAgencyId": 0,
                    "bankId": 0,
                    "bankName": "string",
                    "checkCount": 0,
                    "checkNumber": "string",
                    "city": "string",
                    "federalUnit": "string",
                    "occurrenceDate": "2019-08-24"
                }
            ],
            "summary": {
                "balance": 0,
                "count": 0
            }
        },
        "overdueDebts": {
            "response": [
                {
                    "amount": 0,
                    "city": "string",
                    "contractId": "string",
                    "creditorName": "string",
                    "federalUnit": "string",
                    "legalNature": "string",
                    "legalNatureId": "string",
                    "occurrenceDate": "2019-08-24",
                    "principal": true
                }
            ],
            "summary": {
                "balance": 0,
                "count": 0
            }
        },
        "pefin": {
            "response": [
                {
                    "amount": 0,
                    "contractId": "string",
                    "creditorName": "string",
                    "federalUnit": "string",
                    "legalNature": "string",
                    "legalNatureId": "string",
                    "occurrenceDate": "2019-08-24",
                    "principal": true
                }
            ],
            "summary": {
                "balance": 0,
                "count": 0
            }
        },
        "protests": {
            "response": [
                {
                    "amount": 0,
                    "city": "string",
                    "federalUnit": "string",
                    "occurrenceDate": "2019-08-24",
                    "officeNumber": "string"
                }
            ],
            "summary": {
                "balance": 0,
                "count": 0
            }
        },
        "refin": {
            "response": [
                {
                    "amount": 0,
                    "contractId": "string",
                    "creditorName": "string",
                    "federalUnit": "string",
                    "legalNature": "string",
                    "legalNatureId": "string",
                    "occurrenceDate": "2019-08-24",
                    "principal": true
                }
            ],
            "summary": {
                "balance": 0,
                "count": 0
            }
        }
    },
    "optionalFeatures": {
        "decisionLimitCredit": {
            "code": 0,
            "data": {
                "analyzedCriteria": {
                    "documentActive": true,
                    "foundationTime": "2019-08-24",
                    "noRestrictiveActive": true,
                    "statusRegistration": true
                },
                "companyName": "string",
                "creationDate": "2019-08-24",
                "document": "string",
                "proposalNumber": "string",
                "recommendationSaleType": "string",
                "recommendationType": "string",
                "recommendedLimitValue": 0,
                "riskLevelCode": 0,
                "saleType": "string",
                "saleTypeCode": 0,
                "transactionValue": 0
            },
            "message": "string"
        },
        "director": {
            "DirectorResponse": {
                "results": [
                    {
                        "documentId": "string",
                        "hasNegative": true,
                        "name": "string",
                        "role": "string"
                    }
                ]
            }
        },
        "inquiryCompanyResponse": {
            "inquiryCompanyResponse": {
                "results": [
                    {
                        "companyDocumentId": "string",
                        "companyName": "string",
                        "daysQuantity": 0,
                        "occurrenceDate": "2019-08-24"
                    }
                ]
            },
            "quantity": {
                "actual": 0,
                "bankActual": 0,
                "historical": {
                    "bankOccurrences": 0,
                    "inquiryDate": "2019-08-24",
                    "occurrences": 0
                }
            }
        },
        "partner": {
            "PartnerResponse": {
                "results": [
                    {
                        "criminalProcess": [
                            "string"
                        ],
                        "dead": true,
                        "document": "string",
                        "levelPreparation": "string",
                        "levelPreparationRF": "string",
                        "name": "string",
                        "originCountry": "string",
                        "participation": 0,
                        "participationRF": 0,
                        "participationSocialCapital": 0,
                        "participationSocialCapitalRF": 0,
                        "qualification": "string",
                        "qualificationRF": "string"
                    }
                ]
            }
        },
        "qsaCompleteReport": {
            "directors": [
                {
                    "address": {
                        "addressLine": "string",
                        "city": "string",
                        "country": "string",
                        "countryCode": "string",
                        "district": "string",
                        "state": "string",
                        "zipCode": "string"
                    },
                    "birthDate": "2019-08-24",
                    "debts": [
                        {
                            "debtType": "string",
                            "summary": {
                                "balance": 0,
                                "count": 0
                            }
                        }
                    ],
                    "document": "string",
                    "documentBranch": "string",
                    "documentDigit": "string",
                    "documentSequence": "string",
                    "endDateTerm": "2019-08-24",
                    "entryDate": "2019-08-24",
                    "idNumber": "string",
                    "kindPerson": "string",
                    "maritalStatus": "string",
                    "name": "string",
                    "nationality": "string",
                    "office": "string",
                    "phone": {
                        "areaCode": "string",
                        "phoneNumber": "string"
                    },
                    "relationship": "string",
                    "restrictionIndicator": true,
                    "startDateTerm": "2019-08-24",
                    "updateDate": "2019-08-24"
                }
            ],
            "infoMessages": "string",
            "partners": [
                {
                    "address": {
                        "addressLine": "string",
                        "city": "string",
                        "country": "string",
                        "countryCode": "string",
                        "district": "string",
                        "state": "string",
                        "zipCode": "string"
                    },
                    "debts": [
                        {
                            "debtType": "string",
                            "summary": {
                                "balance": 0,
                                "count": 0
                            }
                        }
                    ],
                    "document": "string",
                    "documentBranch": "string",
                    "documentDigit": "string",
                    "documentSequence": "string",
                    "entryDate": "2019-08-24",
                    "foundationDate": "2019-08-24",
                    "idNumber": "string",
                    "kindPerson": "string",
                    "name": "string",
                    "nationality": "string",
                    "percentageCapital": 0,
                    "percentageVotingCapital": 0,
                    "phone": {
                        "areaCode": "string",
                        "phoneNumber": "string"
                    },
                    "relationship": "string",
                    "restrictionIndicator": true
                }
            ],
            "shareCapital": {
                "capitalValue": 0,
                "control": "string",
                "nature": "string",
                "origin": "string",
                "realizedCapitalValue": 0,
                "updateDate": "2019-08-24"
            }
        },
        "scores": {
            "scoreResponse": [
                {
                    "defaultRate": "string",
                    "message": "string",
                    "score": 0,
                    "scoreModel": "string",
                    "scoreParam": [
                        {
                            "key": "string",
                            "value": 0
                        }
                    ]
                }
            ]
        },
        "spcAnnotations": {
            "spcAnnotations": [
                {
                    "amount": 0,
                    "city": "string",
                    "contractId": "string",
                    "creditorName": "string",
                    "federalUnit": "string",
                    "inclusionDate": "2019-08-24",
                    "occurrenceDate": "2019-08-24",
                    "origin": "string",
                    "principal": true
                }
            ],
            "summary": {
                "balance": 0,
                "count": 0
            }
        },
        "spcMarketInquiries": {
            "spcMarketInquiriesResponseList": [
                {
                    "companyDocumentId": "string",
                    "companyName": "string",
                    "daysQuantity": 0,
                    "occurrenceDate": "2019-08-24"
                }
            ],
            "spcMarketInquirySummary": [
                {
                    "inquiryQuantity": {
                        "actual": 0,
                        "creditInquiriesQuantity": {
                            "firstOccurrence": "2019-08-24",
                            "occurrences": 0
                        }
                    }
                }
            ]
        }
    },
    "registration": {
        "address": {
            "city": "string",
            "state": "string"
        },
        "companyDocument": "string",
        "companyName": "string",
        "foundationDate": "2019-08-24",
        "statusRegistration": "string"
    },
    "score": {
        "defaultRate": "string",
        "message": "string",
        "score": 0
    }
}
🟠404CNPJ não encontrado
🟠422Erro inesperado
Modificado em 2024-10-09 19:50:45
Página anterior
Obter todas as autorizações power of attorney da organização ativa.
Próxima página
Obter as informações de Serasa de uma empresa
Built with