- 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
- 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
Obter as informações de Serasa de uma empresa
Prod Env
https://api.klever.tec.br/api
Prod Env
https://api.klever.tec.br/api
GET
/external_resource/serasa/company/get
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 Query
document
string
requerido
Exemplo:
12456606000115
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/external_resource/serasa/company/get?document=12456606000115'Respostas
🟢200OK
application/json
Body
Relatórios de informações de empresa da Serasa.
created
string <date-time>
opcional
facts
object (CompanyFactDto)
opcional
bankrupts
object (CompanyBankruptsDto)
opcional
judgementFilings
object (CompanyJudgementFilingsDto)
opcional
negativeData
object (CompanyNegativeDataDto)
opcional
check
object (CompanyCheckDto)
opcional
overdueDebts
object (CompanyOverdueDebtsDto)
opcional
pefin
object (CompanyPefinDto)
opcional
protests
object (CompanyProtestDto)
opcional
refin
object (CompanyRefinDto)
opcional
optionalFeatures
object (CompanyOptionalFeaturesDto)
opcional
decisionLimitCredit
object (CompanyDecisionLimitCreditDto)
opcional
director
object (CompanyDirectorResponseDto)
opcional
inquiryCompanyResponse
object (CompanyCompanyInquiryResponseDto)
opcional
partner
object (CompanyPartnerResponseDto)
opcional
qsaCompleteReport
object (CompanyQsaCompleteReportDto)
opcional
scores
object (CompanyCreditLimitDto)
opcional
spcAnnotations
object (CompanySpcAnotationResponseDto)
opcional
spcMarketInquiries
object (CompanySpcMarketInquiryDto)
opcional
registration
object (CompanyRegistrationDto)
opcional
address
object (CompanyAddressDto)
opcional
companyDocument
string
opcional
companyName
string
opcional
foundationDate
string <date>
opcional
statusRegistration
string
opcional
score
object (CompanyScoreDto)
opcional
defaultRate
string
opcional
message
string
opcional
score
integer <int32>
opcional
Exemplo
{
"created": "2019-08-24T14:15:22Z",
"facts": {
"bankrupts": {
"response": [
{
"city": "string",
"eventDate": "2019-08-24",
"eventType": "string",
"origin": "string",
"state": "string"
}
],
"summary": {
"balance": 0,
"count": 0
}
},
"judgementFilings": {
"response": [
{
"amount": 0,
"city": "string",
"civilCourt": "string",
"distributor": "string",
"legalNature": "string",
"legalNatureId": "string",
"occurrenceDate": "2019-08-24",
"state": "string"
}
],
"summary": {
"balance": 0,
"count": 0
}
}
},
"negativeData": {
"check": {
"response": [
{
"alinea": 0,
"bankAgencyId": 0,
"bankId": 0,
"bankName": "string",
"checkCount": 0,
"checkNumber": "string",
"city": "string",
"federalUnit": "string",
"occurrenceDate": "2019-08-24"
}
],
"summary": {
"balance": 0,
"count": 0
}
},
"overdueDebts": {
"response": [
{
"amount": 0,
"city": "string",
"contractId": "string",
"creditorName": "string",
"federalUnit": "string",
"legalNature": "string",
"legalNatureId": "string",
"occurrenceDate": "2019-08-24",
"principal": true
}
],
"summary": {
"balance": 0,
"count": 0
}
},
"pefin": {
"response": [
{
"amount": 0,
"contractId": "string",
"creditorName": "string",
"federalUnit": "string",
"legalNature": "string",
"legalNatureId": "string",
"occurrenceDate": "2019-08-24",
"principal": true
}
],
"summary": {
"balance": 0,
"count": 0
}
},
"protests": {
"response": [
{
"amount": 0,
"city": "string",
"federalUnit": "string",
"occurrenceDate": "2019-08-24",
"officeNumber": "string"
}
],
"summary": {
"balance": 0,
"count": 0
}
},
"refin": {
"response": [
{
"amount": 0,
"contractId": "string",
"creditorName": "string",
"federalUnit": "string",
"legalNature": "string",
"legalNatureId": "string",
"occurrenceDate": "2019-08-24",
"principal": true
}
],
"summary": {
"balance": 0,
"count": 0
}
}
},
"optionalFeatures": {
"decisionLimitCredit": {
"code": 0,
"data": {
"analyzedCriteria": {
"documentActive": true,
"foundationTime": "2019-08-24",
"noRestrictiveActive": true,
"statusRegistration": true
},
"companyName": "string",
"creationDate": "2019-08-24",
"document": "string",
"proposalNumber": "string",
"recommendationSaleType": "string",
"recommendationType": "string",
"recommendedLimitValue": 0,
"riskLevelCode": 0,
"saleType": "string",
"saleTypeCode": 0,
"transactionValue": 0
},
"message": "string"
},
"director": {
"DirectorResponse": {
"results": [
{
"documentId": "string",
"hasNegative": true,
"name": "string",
"role": "string"
}
]
}
},
"inquiryCompanyResponse": {
"inquiryCompanyResponse": {
"results": [
{
"companyDocumentId": "string",
"companyName": "string",
"daysQuantity": 0,
"occurrenceDate": "2019-08-24"
}
]
},
"quantity": {
"actual": 0,
"bankActual": 0,
"historical": {
"bankOccurrences": 0,
"inquiryDate": "2019-08-24",
"occurrences": 0
}
}
},
"partner": {
"PartnerResponse": {
"results": [
{
"criminalProcess": [
"string"
],
"dead": true,
"document": "string",
"levelPreparation": "string",
"levelPreparationRF": "string",
"name": "string",
"originCountry": "string",
"participation": 0,
"participationRF": 0,
"participationSocialCapital": 0,
"participationSocialCapitalRF": 0,
"qualification": "string",
"qualificationRF": "string"
}
]
}
},
"qsaCompleteReport": {
"directors": [
{
"address": {
"addressLine": "string",
"city": "string",
"country": "string",
"countryCode": "string",
"district": "string",
"state": "string",
"zipCode": "string"
},
"birthDate": "2019-08-24",
"debts": [
{
"debtType": "string",
"summary": {
"balance": 0,
"count": 0
}
}
],
"document": "string",
"documentBranch": "string",
"documentDigit": "string",
"documentSequence": "string",
"endDateTerm": "2019-08-24",
"entryDate": "2019-08-24",
"idNumber": "string",
"kindPerson": "string",
"maritalStatus": "string",
"name": "string",
"nationality": "string",
"office": "string",
"phone": {
"areaCode": "string",
"phoneNumber": "string"
},
"relationship": "string",
"restrictionIndicator": true,
"startDateTerm": "2019-08-24",
"updateDate": "2019-08-24"
}
],
"infoMessages": "string",
"partners": [
{
"address": {
"addressLine": "string",
"city": "string",
"country": "string",
"countryCode": "string",
"district": "string",
"state": "string",
"zipCode": "string"
},
"debts": [
{
"debtType": "string",
"summary": {
"balance": 0,
"count": 0
}
}
],
"document": "string",
"documentBranch": "string",
"documentDigit": "string",
"documentSequence": "string",
"entryDate": "2019-08-24",
"foundationDate": "2019-08-24",
"idNumber": "string",
"kindPerson": "string",
"name": "string",
"nationality": "string",
"percentageCapital": 0,
"percentageVotingCapital": 0,
"phone": {
"areaCode": "string",
"phoneNumber": "string"
},
"relationship": "string",
"restrictionIndicator": true
}
],
"shareCapital": {
"capitalValue": 0,
"control": "string",
"nature": "string",
"origin": "string",
"realizedCapitalValue": 0,
"updateDate": "2019-08-24"
}
},
"scores": {
"scoreResponse": [
{
"defaultRate": "string",
"message": "string",
"score": 0,
"scoreModel": "string",
"scoreParam": [
{
"key": "string",
"value": 0
}
]
}
]
},
"spcAnnotations": {
"spcAnnotations": [
{
"amount": 0,
"city": "string",
"contractId": "string",
"creditorName": "string",
"federalUnit": "string",
"inclusionDate": "2019-08-24",
"occurrenceDate": "2019-08-24",
"origin": "string",
"principal": true
}
],
"summary": {
"balance": 0,
"count": 0
}
},
"spcMarketInquiries": {
"spcMarketInquiriesResponseList": [
{
"companyDocumentId": "string",
"companyName": "string",
"daysQuantity": 0,
"occurrenceDate": "2019-08-24"
}
],
"spcMarketInquirySummary": [
{
"inquiryQuantity": {
"actual": 0,
"creditInquiriesQuantity": {
"firstOccurrence": "2019-08-24",
"occurrences": 0
}
}
}
]
}
},
"registration": {
"address": {
"city": "string",
"state": "string"
},
"companyDocument": "string",
"companyName": "string",
"foundationDate": "2019-08-24",
"statusRegistration": "string"
},
"score": {
"defaultRate": "string",
"message": "string",
"score": 0
}
}🟠404CNPJ não encontrado
🟠422Erro inesperado