- DOCUMENTAÇÃO
- KLEVER SASS REST CLIENT API
- login
- 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
- report
- methodk
- certificate
- document_ocr
- fiscal_notes
- sped
- power_attorney
- serasa
- scr
- 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
- accompaniment
- v2
- Acompanhamento
- Reportes
- Certificado Digital
- OnDemand
- Empresas
- Certificados de Debitos
- Sanções
- Pessoas
- Cadastro
- Dados financeiros da Pessoa
- Dados gerais da pessoa
- Dados de relacionamentos comerciais de pessoa
- Serasa
- Auxílio emergencial
- Bolsa Familia
- Scr
- Protestos
- Kyc
- Processos Judiciais
- Ibge
- Documento de análise
- Notas Fiscais.
- Sped
- 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 uma pessoa pelo documento.
Em desenvolvimento
Prod Env
https://api.klever.tec.br/api
Prod Env
https://api.klever.tec.br/api
GET
/v2/ondemand/persons/{document}
Dados das pessoa v2
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
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/persons/'
Respostas
🟢200Dados da pessoa obtidos com sucesso.
application/json
Body
Os dados da pessoa.
age
integer <int32>
opcional
birthDate
string <date>
opcional
cafir
object (CafirDto)
opcional
propertiesRural
array[object (PropertyRuralDto) {7}]
opcional
quantityCondominiums
integer <int32>
opcional
quantityHolder
integer <int32>
opcional
totalArea
number <double>
opcional
cns
string
opcional
corporatesParticipation
array[object (CorporateParticipationDto) {20}]
opcional
businessActivityCnae
string
opcional
cnpj
string
opcional
descriptionCnae
string
opcional
entryDate
string <date-time>
opcional
estimatedBilling
string
opcional
estimatedBillingGroup
string
opcional
levelPreparation
string
opcional
levelPreparationRF
string
opcional
municipality
string
opcional
openingDate
string <date-time>
opcional
participation
number <double>
opcional
participationRF
number <double>
opcional
participationSocialCapital
number <double>
opcional
participationSocialCapitalRF
number <double>
opcional
qualification
string
opcional
qualificationRF
string
opcional
situation
string
opcional
socialCapital
string
opcional
socialReason
string
opcional
uf
string
opcional
cpf
string
opcional
dead
boolean
opcional
deadConfirmation
boolean
opcional
deadDate
integer <int32>
opcional
debitMte
object (DebitMteDto)
opcional
certificateType
string
opcional
code
string
opcional
debitSituation
string
opcional
emissionDate
string <date>
opcional
processes
array[object (DebitMteProcessDto) {4}]
opcional
debitPgfnDau
object (DebitPgfnDauDto)
opcional
debitPgfns
array[object (DebitPgfnDto) {3}]
opcional
totalDebits
number <double>
opcional
debitPgfnDauValue
string
opcional
deficiency
boolean
opcional
deficiencyType
string
opcional
disabilitiesBacens
array[object (DisabilitiesBacenDto) {4}]
opcional
duration
integer <int32>
opcional
penalty
string
opcional
penaltyPeriodDate
string <date-time>
opcional
publicationDate
string <date-time>
opcional
educationLevel
string
opcional
email
string
opcional
fatherName
string
opcional
historicalCriminal
object (HistoricalCriminalDto)
opcional
consultationDate
string <date>
opcional
protocol
string
opcional
situation
string
opcional
status
string
opcional
historicalFunctional
array[object (HistoricalFunctionalDto) {5}]
opcional
admissionDate
string <date>
opcional
cnpj
string
opcional
dismissedDate
string <date>
opcional
months
integer <int32>
opcional
socialReason
string
opcional
id
string
opcional
inscriptionCpfDate
string
opcional
irpf
array[object (IrpfDto) {6}]
opcional
agency
string
opcional
availabilityDate
string <date>
opcional
bank
string
opcional
lot
string
opcional
statementStatus
string
opcional
yearExercise
integer <int32>
opcional
judicialProcess
object (JudicialProcessDto)
opcional
judicialProcessQuantities
array[object (JudicialProcessQuantityDto) {6}]
opcional
totalActiveValue
number <double>
opcional
totalOthersValue
number <double>
opcional
totalPassiveValue
number <double>
opcional
totalValue
number <double>
opcional
mainAddress
object (AddressDto)
opcional
address1
string
opcional
address2
string
opcional
borderMunicipality
string
opcional
buildingType
string
opcional
codeCountry
string
opcional
codeMunicipality
string
opcional
collectiveBuilding
boolean
opcional
country
string
opcional
deliveryRestriction
boolean
opcional
formattedAddress
string
opcional
latestAddress
boolean
opcional
latitude
number <double>
opcional
longitude
number <double>
opcional
microRegion
string
opcional
mregion
string
opcional
municipality
string
opcional
neighborhood
string
opcional
number
string
opcional
originalNeighborhood
string
opcional
precision
string
opcional
region
string
opcional
registryUf
string
opcional
residentialAddress
boolean
opcional
rfPhones
array[string]
opcional
uf
string
opcional
zip
string
opcional
motherCpf
string
opcional
motherName
string
opcional
name
string
opcional
nis
string
opcional
originCountry
string
opcional
otherAddresses
array[object (AddressDto) {26}]
opcional
address1
string
opcional
address2
string
opcional
borderMunicipality
string
opcional
buildingType
string
opcional
codeCountry
string
opcional
codeMunicipality
string
opcional
collectiveBuilding
boolean
opcional
country
string
opcional
deliveryRestriction
boolean
opcional
formattedAddress
string
opcional
latestAddress
boolean
opcional
latitude
number <double>
opcional
longitude
number <double>
opcional
microRegion
string
opcional
mregion
string
opcional
municipality
string
opcional
neighborhood
string
opcional
number
string
opcional
originalNeighborhood
string
opcional
precision
string
opcional
region
string
opcional
registryUf
string
opcional
residentialAddress
boolean
opcional
rfPhones
array[string]
opcional
uf
string
opcional
zip
string
opcional
phones
array[string]
opcional
professionCbo
string
opcional
professionNeoway
string
opcional
properties
array[object (PropertyDto) {13}]
opcional
buildingData
string
opcional
builtArea
number <double>
opcional
complement
string
opcional
evaluationValue
number <double>
opcional
groundArea
number <double>
opcional
municipality
string
opcional
neighborhood
string
opcional
neighborhoodNumber
string
opcional
registerUf
string
opcional
registryNumber
string
opcional
street
string
opcional
uf
string
opcional
zip
string
opcional
protestLastConsultDate
string <date-time>
opcional
publicAgent
boolean
opcional
quantityQsaUnique
integer <int32>
opcional
registerSituation
string
opcional
relationships
array[object (RelationshipDto) {3}]
opcional
cpf
string
opcional
description
string
opcional
name
string
opcional
sex
string
opcional
situation
string
opcional
situationCpf
string
opcional
socialInscription
string
opcional
Exemplo
{
"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"
}