- 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.POST
- Adicionar empresa dado o cnpj.POST
- Obter os dados de uma empresa dado o cnpj.GET
- Obter as imagens de geolocalização para um cnpj.GET
- Obter todas as informações de uma empresa por cnpjGET
- Atualizar dados de uma empresa dado o cnpj.PUT
- Obter as empresas da organização ativa.GET
- Excluir empresa a partir do Cnpj.DELETE
- Obter todas as informações de uma empresa por cnpj v2GET
- v2
- Acompanhamento
- Reportes
- Certificado Digital
- OnDemand
- Empresas
- Certificados de Debitos
- Sanções
- Pessoas
- 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
Adicionar empresa dado o cnpj.
Prod Env
https://api.klever.tec.br/api
Prod Env
https://api.klever.tec.br/api
POST
/external_resource/company/add
External Resource
Requisição
Authorization
Forneça seu token bearer no cabeçalho
Authorization
ao fazer requisições para recursos protegidos.Exemplo:
Authorization: Bearer ********************
Parâmetros Bodyapplication/json
12456606000115,15021849000119
cnpj
string
requerido
Exemplo
{
"cnpj": "string"
}
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/external_resource/company/add' \
--header 'Content-Type: application/json' \
--data-raw '{
"cnpj": "string"
}'
Respostas
🟢200OK
application/json
Body
Os dados da empresa.
activityLevel
string
opcional
address
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
affiliates
array[object (AffiliatedCompanyDto) {6}]
opcional
cnpj
string
opcional
municipality
string
opcional
openingDate
string <date-time>
opcional
registrationSituation
string
opcional
socialReason
string
opcional
uf
string
opcional
age
integer <int32>
opcional
aircraft
array[object (AircraftDto) {8}]
opcional
maker
string
opcional
model
string
opcional
operatorName
string
opcional
ownerName
string
opcional
productionYear
integer <int32>
opcional
registration
string
opcional
situation
string
opcional
statusRAB
string
opcional
anpFuelStation
object (AnpFuelStationDto)
opcional
currentFlag
string
opcional
equipments
array[object (AnpFuelStationEquipmentDto) {3}]
opcional
flags
array[object (AnpFuelStationFlagDto) {2}]
opcional
postType
string
opcional
stationAuthorization
string
opcional
totalSpikes
integer <int32>
opcional
totalTank
number <double>
opcional
anpSupplyPoints
array[object (AnpSupplyPointDto) {4}]
opcional
municipality
string
opcional
totalCapacityTanks
number <double>
opcional
totalNumberTanks
integer <int32>
opcional
uf
string
opcional
antt
object (AnttDto)
opcional
category
string
opcional
emissionDate
string <date>
opcional
expirationDate
string <date>
opcional
municipality
string
opcional
rntrcNumber
string
opcional
situation
string
opcional
uf
string
opcional
anvisa
object (AnvisaDto)
opcional
legalRepresentatives
array[string]
opcional
processes
array[object (AnvisaProcessDto) {4}]
opcional
technicalRepresentatives
array[string]
opcional
bankOperations
array[object (BankOperationDto) {11}]
opcional
amortizationPeriod
integer <int32>
opcional
contractedDate
string <date>
opcional
contractedValue
number <double>
opcional
financialAgent
string
opcional
financialCost
string
opcional
gracePeriod
integer <int32>
opcional
product
string
opcional
status
enum<string>
opcional
Valores permitidos:
ACTIVELIQUIDATEDOTHER
tax
number <double>
opcional
type
string
opcional
uf
string
opcional
beneficiaries
array[object (CompanyBeneficiaryDto) {7}]
opcional
dead
boolean
opcional
document
string
opcional
grade
integer <int32>
opcional
gradeQsa
integer <int32>
opcional
name
string
opcional
participation
number <double>
opcional
participationQsa
number <double>
opcional
bndesLastConsultDate
string <date-time>
opcional
cadastur
object (CadasturDto)
opcional
certificateNumber
string
opcional
idioms
array[string]
opcional
numberOfVehicles
integer <int32>
opcional
registered
boolean
opcional
segments
array[string]
opcional
services
array[string]
opcional
site
string
opcional
situation
string
opcional
uf
string
opcional
cafir
object (CafirDto)
opcional
propertiesRural
array[object (PropertyRuralDto) {7}]
opcional
quantityCondominiums
integer <int32>
opcional
quantityHolder
integer <int32>
opcional
totalArea
number <double>
opcional
ceis
array[object (CeisDto) {4}]
opcional
document
string
opcional
id
string
opcional
modified
string <date-time>
opcional
records
array[object (CeisRecordDto) {19}]
opcional
cepims
array[object (CepimDto) {4}]
opcional
document
string
opcional
id
string
opcional
modified
string <date-time>
opcional
records
array[object (CepimRecordDto) {6}]
opcional
cfcs
array[object (CfcDto) {4}]
opcional
crc
string
opcional
record
string
opcional
situation
string
opcional
type
string
opcional
cnaes
array[object (CnaeDto) {6}]
opcional
businessActivity
string
opcional
code
string
opcional
description
string
opcional
id
string
opcional
observations
array[string]
opcional
sector
string
opcional
cneps
array[object (CnepDto) {4}]
opcional
document
string
opcional
id
string
opcional
modified
string <date-time>
opcional
sanctions
array[object (CnepRecordDto) {20}]
opcional
cnjCnias
array[object (CnjCniaDto) {7}]
opcional
descriptionEntity
string
opcional
processNumber
string
opcional
registrationDate
string <date>
opcional
relatedIssues
array[string]
opcional
sphere
string
opcional
uf
string
opcional
value
number <double>
opcional
cnpj
string
opcional
companiesRelated
array[object (CompanyRelatedDto) {7}]
opcional
cnpj
string
opcional
descriptionCnae
string
opcional
level
string
opcional
municipality
string
opcional
openingDate
string <date-time>
opcional
socialReason
string
opcional
uf
string
opcional
companyClosingPropensity
string
opcional
companyEmecCourses
array[object (CompanyEmecCourseDto) {7}]
opcional
academicOrganization
string
opcional
administrativeCategory
string
opcional
codeLes
string
opcional
descriptionLes
string
opcional
municipality
string
opcional
situation
string
opcional
uf
string
opcional
companySize
string
opcional
covid19Individual
string
opcional
covid19Segment
string
opcional
created
string <date-time>
opcional
criCraDebentures
array[object (CriCraDebentureDto) {12}]
opcional
code
string
opcional
debtorIssuer
string
opcional
dueDate
string <date>
opcional
id
integer <int64>
opcional
indicativeValue
number <double>
opcional
insuranceSector
string
opcional
issueDate
string <date>
opcional
puParDebenture
number <double>
opcional
remuneration
string
opcional
seriesIssue
string
opcional
seriesVolumeOnIssueDate
number <double>
opcional
type
enum<string>
opcional
Valores permitidos:
CRICRADEBENTURE
crsfns
array[object (CrsfnDto) {5}]
opcional
agreedNumber
string
opcional
part
string
opcional
processNumber
string
opcional
resourceNumber
string
opcional
resourceType
string
opcional
cvm
object (CvmDto)
opcional
balanceYear
integer <int32>
opcional
grossProfit
number <double>
opcional
grossRevenue
number <double>
opcional
liquidAssets
number <double>
opcional
liquidBilling
number <double>
opcional
liquidProfit
number <double>
opcional
totalActive
number <double>
opcional
cvmRegistrationData
array[object (CvmParticipantDto) {9}]
opcional
activitySector
string
opcional
code
string
opcional
liquidAssets
number <double>
opcional
registrationDate
string <date>
opcional
registrationType
string
opcional
responsibleName
string
opcional
responsibleType
string
opcional
situationDate
string <date>
opcional
situationRecord
string
opcional
dateRegistrationSituation
string
opcional
dateSpecialSituation
string
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
deliveryPropensity
string
opcional
documents
array[object (DocumentMetadataDto) {5}]
opcional
created
string <date-time>
opcional
ext
string
opcional
name
string
opcional
type
enum<string>
opcional
Valores permitidos:
GENERICREGISTRATION_FORMSIMPLIFIED_CERTIFICATIONARCHIVED_DOCUMENTSCNDCREDIT_INFORMATIONCERTIFICATEBALANCEBALANCETEIRPFBILLING_STATEMENTBANK_DEBTSSPEDFISCAL_NOTEPGDASLOGOONE_PAGER_COMMENT
url
string
opcional
domains
array[object (DomainDto) {5}]
opcional
createdDate
string <date>
opcional
expirationDate
string <date>
opcional
modificationDate
string <date>
opcional
name
string
opcional
responsible
string
opcional
ecommercePropensity
string
opcional
employeeAnalystCount
integer <int32>
opcional
employeeBaseCount
integer <int32>
opcional
employeeBuyerCount
integer <int32>
opcional
employeeDoctorCount
integer <int32>
opcional
employeeEngineerCount
integer <int32>
opcional
employeeGrowths
array[object (EmployeeGrowthDto) {3}]
opcional
employeeGrowth
integer <int32>
opcional
growth
number <double>
opcional
year
integer <int32>
opcional
employeeLawyerCount
integer <int32>
opcional
employeeManagerCount
integer <int32>
opcional
employeeOtherCount
integer <int32>
opcional
employeePdvCount
integer <int32>
opcional
employeeSellerCount
integer <int32>
opcional
employeeSupervisorCount
integer <int32>
opcional
employeeTeacherCount
integer <int32>
opcional
employees
array[object (CompanyEmployeeDto) {5}]
opcional
admissionDate
string <date-time>
opcional
birthDate
string <date>
opcional
cpf
string
opcional
name
string
opcional
resignationYear
string
opcional
environmentalLicenses
array[object (EnvironmentalLicenseDto) {9}]
opcional
descriptionTypology
string
opcional
emitData
string <date>
opcional
municipality
string
opcional
processNumber
string
opcional
situation
string
opcional
type
string
opcional
typologyNumber
string
opcional
uf
string
opcional
updateData
string <date>
opcional
estimatedBilling
string
opcional
estimatedBillingGroup
string
opcional
exEmployees
array[object (CompanyEmployeeDto) {5}]
opcional
admissionDate
string <date-time>
opcional
birthDate
string <date>
opcional
cpf
string
opcional
name
string
opcional
resignationYear
string
opcional
exports
array[object (CompanyExportDto) {2}]
opcional
value
string
opcional
year
integer <int32>
opcional
fantasyName
string
opcional
financialActivity
object (FinancialActivityDto)
opcional
enablementDate
string <date>
opcional
enablementNumber
string
opcional
enablementSituation
string
opcional
queryDate
string <date>
opcional
segment
string
opcional
financialIndicators
array[object (FinancialIndicatorDto) {2}]
opcional
increase
number <double>
opcional
margin
number <double>
opcional
foreignCommerce
object (ForeignCommerceDto)
opcional
authorizedOperations
string
opcional
enabled
boolean
opcional
enabledSituation
string
opcional
modality
string
opcional
situationDate
string <date>
opcional
submodality
string
opcional
franchiseName
string
opcional
grossBilling
number <double>
opcional
groupMultinational
boolean
opcional
hasAccountantContact
boolean
opcional
hasDivergentQSA
boolean
opcional
hasFranchiseIndicative
boolean
opcional
healthEstablishments
array[object (HealthEstablishmentDto) {4}]
opcional
lastUpdate
string <date>
opcional
quantityBeds
integer <int32>
opcional
quantityProfessionals
integer <int32>
opcional
unitType
string
opcional
heavyVehicleInfo
object (HeavyVehicleInfoDto)
opcional
between2And5
integer <int32>
opcional
between5And10
integer <int32>
opcional
groupBetween2And5
integer <int32>
opcional
groupBetween5And10
integer <int32>
opcional
groupOver10
integer <int32>
opcional
groupUpTo1
integer <int32>
opcional
heavyVehicles
integer <int32>
opcional
heavyVehiclesGroup
integer <int32>
opcional
over10
integer <int32>
opcional
upto1
integer <int32>
opcional
vehicles
array[object (HeavyVehicleDto) {8}]
opcional
ibamaCnd
object (IbamaCndDto)
opcional
certificateNumber
string
opcional
emitDate
string <date>
opcional
situation
string
opcional
validDate
string <date>
opcional
ibge
object (IbgeDto)
opcional
created
string <date-time>
opcional
economicStatistics
object (EconomicStatisticsDto)
opcional
geographicStatistics
object (GeographicStatisticsDto)
opcional
municipality
string
opcional
uf
string
opcional
workPerformanceStatistics
object (WorkPerformanceStatisticsDto)
opcional
ibgeLastConsultDate
string <date-time>
opcional
id
string
opcional
imports
array[object (CompanyExportDto) {2}]
opcional
value
string
opcional
year
integer <int32>
opcional
inpiBrands
array[object (InpiBrandDto) {5}]
opcional
brand
string
opcional
classBrand
string
opcional
depositDate
string <date>
opcional
processNumber
string
opcional
situation
string
opcional
inpiPatents
array[object (InpiPatentDto) {8}]
opcional
concessionDate
string <date-time>
opcional
depositDate
string <date>
opcional
depositor
string
opcional
inventors
array[string]
opcional
processNumber
string
opcional
procurator
string
opcional
publicationDate
string <date>
opcional
title
string
opcional
inpiSoftwares
array[object (InpiSoftwareDto) {5}]
opcional
authors
array[string]
opcional
depositDate
string <date>
opcional
processNumber
string
opcional
procurator
string
opcional
title
string
opcional
internationalLists
array[object (InternationalListDto) {2}]
opcional
name
string
opcional
queryDate
string <date>
opcional
judicialProcess
object (JudicialProcessesSummaryDto)
opcional
judicialProcessQuantities
array[object (JudicialProcessQuantityDto) {6}]
opcional
totalActiveValue
number <double>
opcional
totalOthersValue
number <double>
opcional
totalPassiveValue
number <double>
opcional
totalValue
number <double>
opcional
lastUpdate
string <date-time>
opcional
legalNatureCode
string
opcional
legalNatureDescription
string
opcional
mainCnae
object (CnaeDto)
opcional
managementContract
object (ManagementContractDto)
opcional
contracts
array[object (ContractDto) {8}]
opcional
modalityContracts
array[object (ModalityContractDto) {2}]
opcional
quantity
integer <int32>
opcional
totalValue
number <double>
opcional
matrix
boolean
opcional
matrixInfo
object (AffiliatedCompanyDto)
opcional
multinational
boolean
opcional
openCapital
object (OpenCapitalDto)
opcional
complementLogradouroInvestmentDirector
string
opcional
emailInvestmentDirector
string
opcional
logradouroInvestmentDirector
string
opcional
mainActivity
string
opcional
municipalityInvestmentDirector
string
opcional
nameInvestmentDirector
string
opcional
negotiationCode
string
opcional
numberInvestmentDirector
string
opcional
openCapitalActionPositions
array[object (OpenCapitalActionPositionDto) {4}]
opcional
openCapitalPatrimonialBalances
array[object (OpenCapitalPatrimonialBalanceDto) {5}]
opcional
openCapitalPenalties
array[object (OpenCapitalPenaltyDto) {2}]
opcional
openCapitalResultDemonstrations
array[object (OpenCapitalResultDemonstrationDto) {8}]
opcional
phoneInvestmentDirector
string
opcional
sectorialClassification
string
opcional
site
string
opcional
tradingFloorCode
string
opcional
ufInvestmentDirector
string
opcional
zipInvestmentDirector
string
opcional
openingDate
string <date-time>
opcional
originCountry
string
opcional
partners
array[object (CompanyPartnerDto) {13}]
opcional
criminalProcess
array[string]
opcional
dead
boolean
opcional
document
string
opcional
levelPreparation
string
opcional
levelPreparationRF
string
opcional
name
string
opcional
originCountry
string
opcional
participation
number <double>
opcional
participationRF
number <double>
opcional
participationSocialCapital
number <double>
opcional
participationSocialCapitalRF
number <double>
opcional
qualification
string
opcional
qualificationRF
string
opcional
passiveIISS
boolean
opcional
pat
object (PatDto)
opcional
benefitedEmployees
integer <int32>
opcional
exerciseDate
string <date>
opcional
inscription
string
opcional
mealProvides
array[object (PatMealProvidedDto) {2}]
opcional
modalities
array[object (PatModalityDto) {6}]
opcional
registrationSituation
string
opcional
responsibleCpf
string
opcional
responsibleEmail
string
opcional
responsibleName
string
opcional
personPartners
array[object (PersonDto) {44}]
opcional
age
integer <int32>
opcional
birthDate
string <date>
opcional
cafir
object (CafirDto)
opcional
cns
string
opcional
corporatesParticipation
array[object (CorporateParticipationDto) {20}]
opcional
cpf
string
opcional
dead
boolean
opcional
deadConfirmation
boolean
opcional
deadDate
integer <int32>
opcional
debitMte
object (DebitMteDto)
opcional
debitPgfnDau
object (DebitPgfnDauDto)
opcional
debitPgfnDauValue
string
opcional
deficiency
boolean
opcional
deficiencyType
string
opcional
disabilitiesBacens
array[object (DisabilitiesBacenDto) {4}]
opcional
educationLevel
string
opcional
email
string
opcional
fatherName
string
opcional
historicalCriminal
object (HistoricalCriminalDto)
opcional
historicalFunctional
array[object (HistoricalFunctionalDto) {5}]
opcional
id
string
opcional
inscriptionCpfDate
string
opcional
irpf
array[object (IrpfDto) {6}]
opcional
judicialProcess
object (JudicialProcessDto)
opcional
mainAddress
object (AddressDto)
opcional
motherCpf
string
opcional
motherName
string
opcional
name
string
opcional
nis
string
opcional
originCountry
string
opcional
otherAddresses
array[object (AddressDto) {26}]
opcional
phones
array[string]
opcional
professionCbo
string
opcional
professionNeoway
string
opcional
properties
array[object (PropertyDto) {13}]
opcional
protestLastConsultDate
string <date-time>
opcional
publicAgent
boolean
opcional
quantityQsaUnique
integer <int32>
opcional
registerSituation
string
opcional
relationships
array[object (RelationshipDto) {3}]
opcional
sex
string
opcional
situation
string
opcional
situationCpf
string
opcional
socialInscription
string
opcional
phones
array[string]
opcional
procon
object (ProconDto)
opcional
groupPenaltyValue
number <double>
opcional
name
string
opcional
proconGroups
array[object (ProconGroupDto) {2}]
opcional
proconProcesses
array[object (ProconProcessesDto) {3}]
opcional
totalPenaltyValue
number <double>
opcional
updateDate
string <date>
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
quantityActiveBranches
integer <int32>
opcional
quantityEmployee
integer <int32>
opcional
quantityExEmployee
integer <int32>
opcional
registrationSituation
string
opcional
registrationSituationReason
string
opcional
remoteWorkingCapacity
string
opcional
rfEmail
string
opcional
schools
array[object (SchoolDto) {5}]
opcional
category
string
opcional
functioning
string
opcional
link
string
opcional
name
string
opcional
totalEnrollment
integer <int32>
opcional
sidraLastConsultDate
string <date-time>
opcional
simpleNational
object (SimpleNationalDto)
opcional
simei
boolean
opcional
simeiDate
string <date>
opcional
simple
boolean
opcional
simpleDate
string <date>
opcional
simpleIrregular
boolean
opcional
sintegraInscriptions
array[object (SintegraInscriptionDto) {7}]
opcional
email
string
opcional
phone
string
opcional
regime
string
opcional
registrationNumber
string
opcional
registrationSituation
string
opcional
registrationSituationDate
string <date>
opcional
uf
string
opcional
socialCapital
number <double>
opcional
socialReason
string
opcional
specialSituation
string
opcional
suframa
object (SuframaDto)
opcional
expirationDate
string <date>
opcional
icms
string
opcional
ipi
string
opcional
pisCofins
string
opcional
registrationNumber
string
opcional
registrationSituation
string
opcional
taxHealth
object (TaxHealthDto)
opcional
cnds
array[object (CndsDto) {6}]
opcional
taxHealth
string
opcional
taxRegime
string
opcional
workMtes
array[object (WorkMteDto) {7}]
opcional
complement
string
opcional
fiscalActionYear
integer <int32>
opcional
municipality
string
opcional
neighborhood
string
opcional
provenanceDecisionDate
string <date>
opcional
quantityWorkers
integer <int32>
opcional
uf
string
opcional
Exemplo
🟠404CNPJ não encontrado
🟠422Erro inesperado