KLEVER SASS REST CLIENT API
  1. Cadastro
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.
              POST
            • Obter uma pessoa pelo documento.
              GET
            • Excluir uma pessoa pelo documento.
              DELETE
          • 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. Cadastro

Criar uma pessoa pelo documento.

Em desenvolvimento
Prod Env
https://api.klever.tec.br/api
Prod Env
https://api.klever.tec.br/api
POST
/v2/ondemand/persons/{document}
Dados das pessoa v2
Cria uma nova pessoa associada ao documento (CPF) fornecido. Retorna um código de status HTTP 201 (Created) se a criação for bem-sucedida.

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).

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 POST 'https://api.klever.tec.br/api/v2/ondemand/persons/'

Respostas

🟢201Pessoa criada com sucesso.
application/json
Body
The person organization data.
person
object (PersonDto) 
opcional
Os dados da pessoa.
age
integer <int32>
opcional
A idade.
birthDate
string <date>
opcional
A data de nascimento.
cafir
object (CafirDto) 
opcional
Os dados rurais da propriedade da empresa.
cns
string 
opcional
Número do Cartão Nacional de Saúde Individual.
corporatesParticipation
array[object (CorporateParticipationDto) {20}] 
opcional
A lista de participação das empresas.
cpf
string 
opcional
O CPF.
dead
boolean 
opcional
Indique se a pessoa é falecida.
deadConfirmation
boolean 
opcional
Indica se a pessoa tem registro de óbito.
deadDate
integer <int32>
opcional
O ano da morte.
debitMte
object (DebitMteDto) 
opcional
Os dados do débito Mte.
debitPgfnDau
object (DebitPgfnDauDto) 
opcional
Todos os dados de débito da PGFN DAU.
debitPgfnDauValue
string 
opcional
A dívida Pfgn Dau.
deficiency
boolean 
opcional
Indica se a pessoa tem deficiências.
deficiencyType
string 
opcional
O tipo de deficiência
disabilitiesBacens
array[object (DisabilitiesBacenDto) {4}] 
opcional
A lista de deficientes no BACEN.
educationLevel
string 
opcional
O nível de escolaridade.
email
string 
opcional
O e-mail.
fatherName
string 
opcional
O nome do pai.
historicalCriminal
object (HistoricalCriminalDto) 
opcional
Os dados dos antecedentes criminais.
historicalFunctional
array[object (HistoricalFunctionalDto) {5}] 
opcional
A lista do histórico funcional da pessoa.
id
string 
opcional
O id.
inscriptionCpfDate
string 
opcional
A data de registro do CPF.
irpf
array[object (IrpfDto) {6}] 
opcional
Os dados do Imposto de Renda e da Pessoa Física.
judicialProcess
object (JudicialProcessDto) 
opcional
Os dados do processo judicial.
mainAddress
object (AddressDto) 
opcional
Os dados de endereço da empresa.
motherCpf
string 
opcional
O CPF da mãe.
motherName
string 
opcional
O nome da mãe.
name
string 
opcional
O nome.
nis
string 
opcional
O número de inscrição atribuído pela Caixa Econômica Federal às pessoas que serão beneficiadas por projeto social e ainda não possuem inscrição no PIS.
originCountry
string 
opcional
O país de origem.
otherAddresses
array[object (AddressDto) {26}] 
opcional
A lista de endereços.
phones
array[string]
opcional
A lista telefônica.
professionCbo
string 
opcional
O código da profissão do trabalhador de acordo com a Classificação Brasileira de ocupações (CBO).
professionNeoway
string 
opcional
A profissão exercida pela pessoa física.
properties
array[object (PropertyDto) {13}] 
opcional
A lista de propriedades.
protestLastConsultDate
string <date-time>
opcional
publicAgent
boolean 
opcional
Indique se a pessoa é agente público.
quantityQsaUnique
integer <int32>
opcional
The number of companies in which the person has a shareholding registration referring to the registration of partners in the Federal Revenue and in the Commercial Registry.
registerSituation
string 
opcional
A situação do cadastro da pessoa no SICAF (CREDENCIADO/INATIVO).
relationships
array[object (RelationshipDto) {3}] 
opcional
A lista de relacionamentos.
sex
string 
opcional
O sexo.
situation
string 
opcional
A descrição da situação, considerando INIDONEO / IDONEO.
situationCpf
string 
opcional
A situação do CPF.
socialInscription
string 
opcional
The number of the Integração Social da Pessoa Física Program.
userData
object (UserLightDto) 
opcional
Os principais dados de resposta do usuário.
email
string 
opcional
O e-mail.
phone
string 
opcional
O numero do telefone.
userCpf
string 
opcional
O CPF.
userName
string 
opcional
O nome.
Exemplo
{
    "person": {
        "age": 0,
        "birthDate": "2019-08-24",
        "cafir": {
            "propertiesRural": [
                {
                    "area": 0,
                    "condominium": "string",
                    "municipality": "string",
                    "name": "string",
                    "nirf": "string",
                    "type": "string",
                    "uf": "string"
                }
            ],
            "quantityCondominiums": 0,
            "quantityHolder": 0,
            "totalArea": 0
        },
        "cns": "string",
        "corporatesParticipation": [
            {
                "businessActivityCnae": "string",
                "cnpj": "string",
                "descriptionCnae": "string",
                "entryDate": "2019-08-24T14:15:22Z",
                "estimatedBilling": "string",
                "estimatedBillingGroup": "string",
                "levelPreparation": "string",
                "levelPreparationRF": "string",
                "municipality": "string",
                "openingDate": "2019-08-24T14:15:22Z",
                "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,
        "debitMte": {
            "certificateType": "string",
            "code": "string",
            "debitSituation": "string",
            "emissionDate": "2019-08-24",
            "processes": [
                {
                    "infringementCapitulation": "string",
                    "infringementCategory": "string",
                    "number": "string",
                    "situation": "string"
                }
            ]
        },
        "debitPgfnDau": {
            "debitPgfns": [
                {
                    "debit": 0,
                    "inscriptionNumber": "string",
                    "nature": "string"
                }
            ],
            "totalDebits": 0
        },
        "debitPgfnDauValue": "string",
        "deficiency": true,
        "deficiencyType": "string",
        "disabilitiesBacens": [
            {
                "duration": 0,
                "penalty": "string",
                "penaltyPeriodDate": "2019-08-24T14:15:22Z",
                "publicationDate": "2019-08-24T14:15:22Z"
            }
        ],
        "educationLevel": "string",
        "email": "string",
        "fatherName": "string",
        "historicalCriminal": {
            "consultationDate": "2019-08-24",
            "protocol": "string",
            "situation": "string",
            "status": "string"
        },
        "historicalFunctional": [
            {
                "admissionDate": "2019-08-24",
                "cnpj": "string",
                "dismissedDate": "2019-08-24",
                "months": 0,
                "socialReason": "string"
            }
        ],
        "id": "string",
        "inscriptionCpfDate": "string",
        "irpf": [
            {
                "agency": "string",
                "availabilityDate": "2019-08-24",
                "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": {
            "address1": "string",
            "address2": "string",
            "borderMunicipality": "string",
            "buildingType": "string",
            "codeCountry": "string",
            "codeMunicipality": "string",
            "collectiveBuilding": true,
            "country": "string",
            "deliveryRestriction": true,
            "formattedAddress": "string",
            "latestAddress": true,
            "latitude": 0,
            "longitude": 0,
            "microRegion": "string",
            "mregion": "string",
            "municipality": "string",
            "neighborhood": "string",
            "number": "string",
            "originalNeighborhood": "string",
            "precision": "string",
            "region": "string",
            "registryUf": "string",
            "residentialAddress": true,
            "rfPhones": [
                "string"
            ],
            "uf": "string",
            "zip": "string"
        },
        "motherCpf": "string",
        "motherName": "string",
        "name": "string",
        "nis": "string",
        "originCountry": "string",
        "otherAddresses": [
            {
                "address1": "string",
                "address2": "string",
                "borderMunicipality": "string",
                "buildingType": "string",
                "codeCountry": "string",
                "codeMunicipality": "string",
                "collectiveBuilding": true,
                "country": "string",
                "deliveryRestriction": true,
                "formattedAddress": "string",
                "latestAddress": true,
                "latitude": 0,
                "longitude": 0,
                "microRegion": "string",
                "mregion": "string",
                "municipality": "string",
                "neighborhood": "string",
                "number": "string",
                "originalNeighborhood": "string",
                "precision": "string",
                "region": "string",
                "registryUf": "string",
                "residentialAddress": true,
                "rfPhones": [
                    "string"
                ],
                "uf": "string",
                "zip": "string"
            }
        ],
        "phones": [
            "string"
        ],
        "professionCbo": "string",
        "professionNeoway": "string",
        "properties": [
            {
                "buildingData": "string",
                "builtArea": 0,
                "complement": "string",
                "evaluationValue": 0,
                "groundArea": 0,
                "municipality": "string",
                "neighborhood": "string",
                "neighborhoodNumber": "string",
                "registerUf": "string",
                "registryNumber": "string",
                "street": "string",
                "uf": "string",
                "zip": "string"
            }
        ],
        "protestLastConsultDate": "2019-08-24T14:15:22Z",
        "publicAgent": true,
        "quantityQsaUnique": 0,
        "registerSituation": "string",
        "relationships": [
            {
                "cpf": "string",
                "description": "string",
                "name": "string"
            }
        ],
        "sex": "string",
        "situation": "string",
        "situationCpf": "string",
        "socialInscription": "string"
    },
    "userData": {
        "email": "string",
        "phone": "string",
        "userCpf": "string",
        "userName": "string"
    }
}
Página anterior
Obter Acordo de leniência pelo documento.
Próxima página
Obter uma pessoa pelo documento.
Built with