- 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
- 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.GET
- Gerar OCR do documento IRPFPOST
- Gerar OCR do documento IRPF with HookPOST
- Obter listagem de documentos da empresa ou pessoa pelo documento.GET
- Enviar documento de análise (PDF).POST
- Obter os dados de faturamento pelo documento.GET
- Obter endividamento pelo documento.GET
- Obter os dados de IRPF pelo documento.GET
- Balances
Obter os dados de OCR IRPF pelo id.
Prod Env
https://api.klever.tec.br/api
Prod Env
https://api.klever.tec.br/api
GET
/v2/ondemand/ocr/irpf/{id}
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
id
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/ocr/irpf/'Respostas
🟢200Success
application/json
Body
assetsRights
object
requerido
items
array [object {33}]
requerido
total
integer
requerido
debtsLinkedRuralActivity
object
requerido
items
array [object {6}]
requerido
total
integer
requerido
debtsRealEncumbrances
object
requerido
items
array [object {6}]
requerido
total
integer
requerido
declarationData
object (DeclarationDataDto)
requerido
controlNumber
string
requerido
declarationDate
string
requerido
declarationType
string
requerido
exerciseYear
integer
requerido
deductions
object
requerido
items
array [object {2}]
requerido
total
integer
requerido
dependents
object (DependentsDto)
requerido
bornDate
string
requerido
celular
string
requerido
code
string
requerido
cpf
string
requerido
email
string
requerido
liveOwner
string
requerido
name
string
requerido
donationsMade
object
requerido
items
array [object {5}]
requerido
total
integer
requerido
herdMovements
object
requerido
items
array [object {7}]
requerido
total
integer
requerido
id
string
requerido
identificationExploitedProperties
object
requerido
items
array [object {6}]
requerido
total
integer
requerido
nonTaxableIncomeExempt
object
requerido
items
array[object (BeneficiaryDto) {3}]
requerido
total
integer
requerido
othersInformations
object
requerido
items
array [object {2}]
requerido
total
integer
requerido
patrimonialEvolution
object
requerido
items
array [object {2}]
requerido
total
integer
requerido
paymentsMade
object
requerido
items
array [object {6}]
requerido
total
integer
requerido
person
object (PersonDto)
requerido
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
revenuesExpenses
object
requerido
items
array [object {3}]
requerido
total
integer
requerido
ruralActivityAssets
object
requerido
items
array [object {4}]
requerido
total
integer
requerido
status
string
requerido
taxPaidWithheld
object
requerido
items
array [object {2}]
requerido
total
integer
requerido
taxableIncome
object
requerido
items
array [object {2}]
requerido
total
integer
requerido
taxableIncomeExclusiveFinal
object
requerido
items
array [object {4}]
requerido
total
integer
requerido
taxableIncomePJHolder
object (TaxableIncomePJHolderItemDto)
requerido
document
string
requerido
fontName
string
requerido
incomeTaxSalary13
integer
requerido
salary13
integer
requerido
socialSecurityContribution
integer
requerido
taxableIncomeReceive
integer
requerido
withholdingTax
integer
requerido
Exemplo
{
"assetsRights": {
"items": [
{
"account": "string",
"acquisitionDate": "string",
"address": "string",
"agency": "string",
"area": "string",
"autoCustodian": "string",
"bank": "string",
"ceiCno": "string",
"cibNirf": "string",
"cnpj": "string",
"cnpjCustodian": "string",
"cnpjFund": "string",
"code": "string",
"countryCode": "string",
"countryName": "string",
"cpf": "string",
"currentValue": 0,
"description": "string",
"group": "string",
"municipalInscriptionIPTU": "string",
"municipality": "string",
"number": "string",
"owner": "string",
"plate": "string",
"previousValue": 0,
"registryOffice": "string",
"registryOfficeName": "string",
"renavam": "string",
"state": "string",
"tradedStockExchange": "string",
"unit": "string",
"vesselRegistry": "string",
"zip": "string"
}
],
"total": 0
},
"debtsLinkedRuralActivity": {
"items": [
{
"code": "string",
"currentValue": 0,
"description": "string",
"item": "string",
"previousValue": 0,
"value": 0
}
],
"total": 0
},
"debtsRealEncumbrances": {
"items": [
{
"code": "string",
"currentValue": 0,
"description": "string",
"item": "string",
"previousValue": 0,
"value": 0
}
],
"total": 0
},
"declarationData": {
"controlNumber": "string",
"declarationDate": "string",
"declarationType": "string",
"exerciseYear": 0
},
"deductions": {
"items": [
{
"description": "string",
"value": 0
}
],
"total": 0
},
"dependents": {
"list": [
{
"bornDate": "string",
"celular": "string",
"code": "string",
"cpf": "string",
"email": "string",
"liveOwner": "string",
"name": "string"
}
],
"totalDeduction": "string"
},
"donationsMade": {
"items": [
{
"code": "string",
"document": "string",
"name": "string",
"noDeductibleValue": 0,
"paidAmountValue": 0
}
],
"total": 0
},
"herdMovements": {
"items": [
{
"acquisitions": 0,
"births": 0,
"consumptionLosses": 0,
"finalStock": 0,
"initialStock": 0,
"sales": 0,
"species": "string"
}
],
"total": 0
},
"id": "string",
"identificationExploitedProperties": {
"items": [
{
"area": 0,
"cib": "string",
"code": "string",
"condition": "string",
"description": "string",
"participation": 0
}
],
"total": 0
},
"nonTaxableIncomeExempt": {
"items": [
{
"beneficiaryList": [
{
"formattedCpf": "string",
"name": "string",
"nis": "string"
}
],
"code": "string",
"description": "string",
"value": 0
}
],
"total": 0
},
"othersInformations": {
"items": [
{
"description": "string",
"value": 0
}
],
"total": 0
},
"patrimonialEvolution": {
"items": [
{
"description": "string",
"value": 0
}
],
"total": 0
},
"paymentsMade": {
"items": [
{
"code": "string",
"description": "string",
"document": "string",
"name": "string",
"noDeductibleValue": 0,
"paidAmountValue": 0
}
],
"total": 0
},
"person": {
"age": 0,
"birthDate": "2024-12-13",
"cns": "string",
"corporatesParticipation": [
{
"businessActivityCnae": "string",
"cnpj": "string",
"descriptionCnae": "string",
"entryDate": "2024-12-13T16:55:23.497Z",
"estimatedBilling": "string",
"estimatedBillingGroup": "string",
"levelPreparation": "string",
"levelPreparationRF": "string",
"municipality": "string",
"openingDate": "2024-12-13T16:55:23.497Z",
"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,
"debitPgfnDauValue": "string",
"deficiency": true,
"deficiencyType": "string",
"disabilitiesBacens": [
{
"duration": 0,
"penalty": "string",
"penaltyPeriodDate": "2024-12-13T16:55:23.498Z",
"publicationDate": "2024-12-13T16:55:23.498Z"
}
],
"educationLevel": "string",
"email": "string",
"fatherName": "string",
"historicalCriminal": {
"consultationDate": "2024-12-13",
"protocol": "string",
"situation": "string",
"status": "string"
},
"historicalFunctional": [
{
"admissionDate": "2024-12-13",
"cnpj": "string",
"dismissedDate": "2024-12-13",
"months": 0,
"socialReason": "string"
}
],
"id": "string",
"inscriptionCpfDate": "string",
"irpf": [
{
"agency": "string",
"availabilityDate": "2024-12-13",
"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": {
"addressLine": "string",
"city": "string",
"country": "string",
"district": "string",
"state": "string",
"zipCode": "string"
},
"motherCpf": "string",
"motherName": "string",
"name": "string",
"nis": "string",
"originCountry": "string",
"otherAddresses": [
{
"addressLine": "string",
"city": "string",
"country": "string",
"district": "string",
"state": "string",
"zipCode": "string"
}
],
"phones": [
"string"
],
"professionCbo": "string",
"professionNeoway": "string",
"protestLastConsultDate": "2024-12-13T16:55:23.499Z",
"publicAgent": true,
"quantityQsaUnique": 0,
"registerSituation": "string",
"relationships": [
{
"creationDate": "2024-12-13T16:55:23.499Z",
"datasource": "string",
"document": "string",
"documentCountry": "string",
"documentType": "string",
"lastUpdate": "2024-12-13T16:55:23.499Z",
"name": "string",
"relationDescription": "string",
"relationEndDate": "2024-12-13T16:55:23.499Z",
"relationLevel": "string",
"relationStartDate": "2024-12-13T16:55:23.499Z",
"relationType": "string"
}
],
"sex": "string",
"situation": "string",
"situationCpf": "string",
"socialInscription": "string"
},
"revenuesExpenses": {
"items": [
{
"expenses": 0,
"month": "string",
"revenues": 0
}
],
"total": 0
},
"ruralActivityAssets": {
"items": [
{
"code": "string",
"currentValue": 0,
"description": "string",
"previousValue": 0
}
],
"total": 0
},
"status": "string",
"taxPaidWithheld": {
"items": [
{
"description": "string",
"value": 0
}
],
"total": 0
},
"taxableIncome": {
"items": [
{
"description": "string",
"value": 0
}
],
"total": 0
},
"taxableIncomeExclusiveFinal": {
"items": [
{
"beneficiaryList": [
{
"formattedCpf": "string",
"name": "string",
"nis": "string"
}
],
"code": "string",
"description": "string",
"value": 0
}
],
"total": 0
},
"taxableIncomePJHolder": {
"items": [
{
"document": "string",
"fontName": "string",
"incomeTaxSalary13": 0,
"salary13": 0,
"socialSecurityContribution": 0,
"taxableIncomeReceive": 0,
"withholdingTax": 0
}
],
"total": 0
}
}