KLEVER SASS REST CLIENT API
  1. Kyc
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
            POST
          • Atualizar dados do KYC pelo documento
            POST
          • Obter dados KYC dos sócios da empresa pelo documento
            GET
          • Obter dados do KYC pelo documento
            GET
        • 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. Kyc

Obter dados KYC dos sócios da empresa pelo documento

Em desenvolvimento
Prod Env
https://api.klever.tec.br/api
Prod Env
https://api.klever.tec.br/api
GET
/v2/ondemand/kyc/{document}/owners
Ondemand kyc v2.
Recupera os dados KYC dos sócios associados ao documento (CPF ou CNPJ) fornecido. Retorna um código de status HTTP 200 (OK) se os dados KYC dos sócios forem recuperados com sucesso.

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
document
string 
requerido
O documento (CPF ou CNPJ).

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/kyc//owners'

Respostas

🟢200Dados KYC dos sócios recuperados com sucesso.
application/json
Body
Os dados owner kyc.
activeOwners
array[string]
opcional
Lista de sócios ativos segundo o quadro QSA da fonte.
averageSanctionsPerOwner
integer <int32>
opcional
Média de sanções por sócio.
creationDate
string <date-time>
opcional
Data de criação.
document
string 
opcional
CPF o CNPJ.
firstPEPOccurenceDate
string 
opcional
Data do primeiro registro de PEP encontrado para o indivíduo.
firstSanctionDate
string 
opcional
Data do primeiro registro de sanções encontrado para o indivíduo.
id
string 
opcional
O ID.
inactiveOwners
array[string]
opcional
Lista de sócios inativos segundo o quadro QSA da fonte.
last180DaysSanctions
integer <int32>
opcional
Quantidade de sanções e restrições encontradas nos últimos 180 dias.
last30DaysSanctions
integer <int32>
opcional
Quantidade de sanções e restrições encontradas nos últimos 30 dias.
last365DaysSanctions
integer <int32>
opcional
Quantidade de sanções e restrições encontradas nos últimos 365 dias.
last3YearPEPOccurence
integer <int32>
opcional
Quantidade de registros de PEP encontrados nos últimos 3 anos.
last5PlusYearsPEPOccurence
integer <int32>
opcional
Quantidade de registros de PEP encontrados nos últimos 5 anos ou mais.
last5YearPEPOccurence
integer <int32>
opcional
Quantidade de registros de PEP encontrados nos últimos 5 anos.
last90DaysSanctions
integer <int32>
opcional
Quantidade de sanções e restrições encontradas nos últimos 90 dias.
lastPEPOccurenceDate
string 
opcional
Data do último registro de PEP encontrado para o indivíduo.
lastSanctionDate
string 
opcional
Data do último registro de sanções encontrado para o indivíduo.
lastUpdateDate
string <date-time>
opcional
Data de ultima atualização para esse registro.
lastYearPEPOccurence
integer <int32>
opcional
Quantidade de registros de PEP encontrados no último ano.
ownerMaxSanctions
integer <int32>
opcional
Número máximo de sanções de um sócio.
ownerMinSanctions
integer <int32>
opcional
Número mínimo de sanções de um sócio.
ownersKycDataMap
object 
opcional
Dicionário que relaciona a cada documento (chave) um objeto com os detalhes de KYC e Compliance.
Additional properties
object (KycDataDto) 
opcional
Os dados kyc.
pepPercentage
integer <int32>
opcional
Percentual de pessoas politicamente expostas.
totalCurrentlyPEP
integer <int32>
opcional
Número de pessoas atualmente policamente expostas.
totalCurrentlySanctioned
integer <int32>
opcional
Número de pessoas atualmente sob sanções.
totalHistoricallyPEP
integer <int32>
opcional
Número de pessoas com histórico de policamente exposta.
totalHistoricallySanctioned
integer <int32>
opcional
Número de pessoas historicamente sancionadas.
Exemplo
{
    "activeOwners": [
        "string"
    ],
    "averageSanctionsPerOwner": 0,
    "creationDate": "2019-08-24T14:15:22Z",
    "document": "string",
    "firstPEPOccurenceDate": "string",
    "firstSanctionDate": "string",
    "id": "string",
    "inactiveOwners": [
        "string"
    ],
    "last180DaysSanctions": 0,
    "last30DaysSanctions": 0,
    "last365DaysSanctions": 0,
    "last3YearPEPOccurence": 0,
    "last5PlusYearsPEPOccurence": 0,
    "last5YearPEPOccurence": 0,
    "last90DaysSanctions": 0,
    "lastPEPOccurenceDate": "string",
    "lastSanctionDate": "string",
    "lastUpdateDate": "2019-08-24T14:15:22Z",
    "lastYearPEPOccurence": 0,
    "ownerMaxSanctions": 0,
    "ownerMinSanctions": 0,
    "ownersKycDataMap": {
        "property1": {
            "amnestiesHistory": [
                {
                    "amnestiesDetails": {
                        "creationDate": "2019-08-24T14:15:22Z",
                        "decreeStartDate": "2019-08-24T14:15:22Z",
                        "effectiveStartDate": "2019-08-24T14:15:22Z",
                        "lastUpdateDate": "2019-08-24T14:15:22Z"
                    },
                    "matchRate": 0,
                    "nameUniquenessScore": 0,
                    "source": "string",
                    "type": "string"
                }
            ],
            "created": "2019-08-24T14:15:22Z",
            "creationDate": "2019-08-24T14:15:22Z",
            "currentlyElectoralDonor": true,
            "currentlyPEP": true,
            "currentlySanctioned": true,
            "document": "string",
            "firstPEPOccurenceDate": "string",
            "firstSanctionDate": "string",
            "hiredByPublicAgency": true,
            "hiredForPolitalCampaign": true,
            "historicalElectoralDonor": true,
            "historicallyHiredByPublicAgency": true,
            "historicallyHiredForPoliticalCampaign": true,
            "id": "string",
            "last180DaysSanctions": 0,
            "last30DaysSanctions": 0,
            "last365DaysSanctions": 0,
            "last3YearPEPOccurence": 0,
            "last5PlusYearsPEPOccurence": 0,
            "last5YearPEPOccurence": 0,
            "last90DaysSanctions": 0,
            "lastPEPOccurenceDate": "string",
            "lastSanctionDate": "string",
            "lastUpdateDate": "2019-08-24T14:15:22Z",
            "lastYearPEPOccurence": 0,
            "pepHistory": [
                {
                    "creationDate": "2019-08-24T14:15:22Z",
                    "currentlyElectoralDonor": true,
                    "department": "string",
                    "endDate": "2019-08-24T14:15:22Z",
                    "hiredByPublicAgency": true,
                    "hiredForPolitalCampaign": true,
                    "historicalElectoralDonor": true,
                    "historicallyHiredByPublicAgency": true,
                    "historicallyHiredForPoliticalCampaign": true,
                    "jobTitle": "string",
                    "lastUpdateDate": "2019-08-24T14:15:22Z",
                    "level": "string",
                    "motive": "string",
                    "politicalEngagementLevel": "string",
                    "source": "string",
                    "startDate": "2019-08-24T14:15:22Z",
                    "taxId": "string",
                    "totalElectoralDonationAmount": 0,
                    "totalElectoralDonationAmountLastTwoElections": 0,
                    "totalElectoralDonations": 0,
                    "totalElectoralDonationsLastTwoElections": 0
                }
            ],
            "politicalEngagementLevel": "string",
            "sanctionsHistory": [
                {
                    "matchRate": 0,
                    "nameUniquenessScore": 0,
                    "sanctionsDetails": {
                        "creationDate": "2019-08-24T14:15:22Z",
                        "currentlyPresentOnSource": true,
                        "endDate": "2019-08-24T14:15:22Z",
                        "lastUpdateDate": "2019-08-24T14:15:22Z",
                        "startDate": "2019-08-24T14:15:22Z",
                        "wasRecentlyPresentOnSource": true
                    },
                    "source": "string",
                    "standardizedSanctionType": "string",
                    "type": "string"
                }
            ],
            "totalElectoralDonationAmount": 0,
            "totalElectoralDonationAmountLastTwoElections": 0,
            "totalElectoralDonations": 0,
            "totalElectoralDonationsLastTwoElections": 0,
            "wasPreviouslySanctioned": true
        },
        "property2": {
            "amnestiesHistory": [
                {
                    "amnestiesDetails": {
                        "creationDate": "2019-08-24T14:15:22Z",
                        "decreeStartDate": "2019-08-24T14:15:22Z",
                        "effectiveStartDate": "2019-08-24T14:15:22Z",
                        "lastUpdateDate": "2019-08-24T14:15:22Z"
                    },
                    "matchRate": 0,
                    "nameUniquenessScore": 0,
                    "source": "string",
                    "type": "string"
                }
            ],
            "created": "2019-08-24T14:15:22Z",
            "creationDate": "2019-08-24T14:15:22Z",
            "currentlyElectoralDonor": true,
            "currentlyPEP": true,
            "currentlySanctioned": true,
            "document": "string",
            "firstPEPOccurenceDate": "string",
            "firstSanctionDate": "string",
            "hiredByPublicAgency": true,
            "hiredForPolitalCampaign": true,
            "historicalElectoralDonor": true,
            "historicallyHiredByPublicAgency": true,
            "historicallyHiredForPoliticalCampaign": true,
            "id": "string",
            "last180DaysSanctions": 0,
            "last30DaysSanctions": 0,
            "last365DaysSanctions": 0,
            "last3YearPEPOccurence": 0,
            "last5PlusYearsPEPOccurence": 0,
            "last5YearPEPOccurence": 0,
            "last90DaysSanctions": 0,
            "lastPEPOccurenceDate": "string",
            "lastSanctionDate": "string",
            "lastUpdateDate": "2019-08-24T14:15:22Z",
            "lastYearPEPOccurence": 0,
            "pepHistory": [
                {
                    "creationDate": "2019-08-24T14:15:22Z",
                    "currentlyElectoralDonor": true,
                    "department": "string",
                    "endDate": "2019-08-24T14:15:22Z",
                    "hiredByPublicAgency": true,
                    "hiredForPolitalCampaign": true,
                    "historicalElectoralDonor": true,
                    "historicallyHiredByPublicAgency": true,
                    "historicallyHiredForPoliticalCampaign": true,
                    "jobTitle": "string",
                    "lastUpdateDate": "2019-08-24T14:15:22Z",
                    "level": "string",
                    "motive": "string",
                    "politicalEngagementLevel": "string",
                    "source": "string",
                    "startDate": "2019-08-24T14:15:22Z",
                    "taxId": "string",
                    "totalElectoralDonationAmount": 0,
                    "totalElectoralDonationAmountLastTwoElections": 0,
                    "totalElectoralDonations": 0,
                    "totalElectoralDonationsLastTwoElections": 0
                }
            ],
            "politicalEngagementLevel": "string",
            "sanctionsHistory": [
                {
                    "matchRate": 0,
                    "nameUniquenessScore": 0,
                    "sanctionsDetails": {
                        "creationDate": "2019-08-24T14:15:22Z",
                        "currentlyPresentOnSource": true,
                        "endDate": "2019-08-24T14:15:22Z",
                        "lastUpdateDate": "2019-08-24T14:15:22Z",
                        "startDate": "2019-08-24T14:15:22Z",
                        "wasRecentlyPresentOnSource": true
                    },
                    "source": "string",
                    "standardizedSanctionType": "string",
                    "type": "string"
                }
            ],
            "totalElectoralDonationAmount": 0,
            "totalElectoralDonationAmountLastTwoElections": 0,
            "totalElectoralDonations": 0,
            "totalElectoralDonationsLastTwoElections": 0,
            "wasPreviouslySanctioned": true
        }
    },
    "pepPercentage": 0,
    "totalCurrentlyPEP": 0,
    "totalCurrentlySanctioned": 0,
    "totalHistoricallyPEP": 0,
    "totalHistoricallySanctioned": 0
}
Página anterior
Atualizar dados do KYC pelo documento
Próxima página
Obter dados do KYC pelo documento
Built with