- 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 as informações do Serasa de 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}/serasa
Recurso de serasa pela pessoa.
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//serasa'Respostas
🟢200Informações do Serasa obtidas com sucesso.
application/json
Body
Relatórios de informações de Pessoa da Serasa.
created
string <date-time>
opcional
facts
object (PersonFactDto)
opcional
inquiry
object (InquiryDto)
opcional
stolenDocuments
object (StolenDocumentsDto)
opcional
negativeData
object (PersonNegativeDataDto)
opcional
check
object (PersonCheckDto)
opcional
pefin
object (PersonPefinDto)
opcional
protest
object (PersonProtestDto)
opcional
refin
object (PersonRefinDto)
opcional
optionalFeatures
object (OptionalFeaturesDto)
opcional
attributes
object (AttributesDto)
opcional
bankrupts
object (BankruptsDto)
opcional
creditLimitAndDecision
object (CreditDto)
opcional
judgementFilings
object (JudgementFilingsDto)
opcional
overdueDebts
object (OverdueDebtsDto)
opcional
partner
object (PartnerDto)
opcional
paymentsHistory
object (PaymentsHistoryDto)
opcional
spcAnotations
object (SpcAnnotationsDto)
opcional
spcInquiries
object (SpcInquiriesDto)
opcional
registration
object (PersonRegistrationDto)
opcional
address
object (AddressDto)
opcional
birthDate
string <date>
opcional
consumerName
string
opcional
documentNumber
string
opcional
motherName
string
opcional
phone
object (PhoneDto)
opcional
statusDate
string <date>
opcional
statusRegistration
string
opcional
score
object (ScoreDto)
opcional
codeMessage
integer <int32>
opcional
defaultRate
string
opcional
message
string
opcional
range
string
opcional
score
integer <int32>
opcional
scoreModel
string
opcional
Serasa Score Positivo: HSPN
Serasa Score Fintech: HFIN
Exemplo
{
"created": "2019-08-24T14:15:22Z",
"facts": {
"inquiry": {
"inquiryResponse": [
{
"occurrenceDate": "2019-08-24",
"segmentDescription": "string"
}
],
"summary": {
"count": 0
}
},
"stolenDocuments": {
"stolenDocumentsResponse": [
{
"occurrenceDate": "2019-08-24",
"segmentDescription": "string"
}
],
"summary": {
"count": 0
}
}
},
"negativeData": {
"check": {
"response": [
{
"alinea": 0,
"bankAgencyId": 0,
"bankId": 0,
"bankName": "string",
"checkCount": 0,
"checkNumber": "string",
"city": "string",
"federalUnit": "string",
"legalSquare": "string",
"occurrenceDate": "2019-08-24"
}
],
"summary": {
"count": 0
}
},
"pefin": {
"response": [
{
"amount": 0,
"availableDate": "2019-08-24",
"caseNumber": "string",
"city": "string",
"civilCourt": "string",
"contractId": "string",
"creditorBusinessId": "string",
"creditorName": "string",
"distributor": "string",
"federalUnit": "string",
"flagSubJudice": true,
"inclusionDate": "2019-08-24",
"legalNature": "string",
"legalNatureId": "string",
"legalSquare": "string",
"occurrenceDate": "2019-08-24",
"principal": true,
"publicAgency": true
}
],
"summary": {
"count": 0
}
},
"protest": {
"response": [
{
"amount": 0,
"city": "string",
"federalUnit": "string",
"occurrenceDate": "2019-08-24",
"officeName": "string",
"officeNumber": "string"
}
],
"summary": {
"count": 0
}
},
"refin": {
"response": [
{
"amount": 0,
"availableDate": "2019-08-24",
"caseNumber": "string",
"city": "string",
"civilCourt": "string",
"contractId": "string",
"creditorBusinessId": "string",
"creditorName": "string",
"distributor": "string",
"federalUnit": "string",
"flagSubJudice": true,
"inclusionDate": "2019-08-24",
"legalNature": "string",
"legalNatureId": "string",
"legalSquare": "string",
"occurrenceDate": "2019-08-24",
"principal": true,
"publicAgency": true
}
],
"summary": {
"count": 0
}
}
},
"optionalFeatures": {
"attributes": {
"affordability": {
"attributeModel": "string",
"codeMessage": 0,
"message": "string",
"scoring": 0
},
"creditCardOnTimePaymentIndex": {
"attributeModel": "string",
"codeMessage": 0,
"message": "string",
"scoring": 0
},
"creditCardUsageTrend": {
"attributeModel": "string",
"codeMessage": 0,
"message": "string",
"scoring": 0
},
"estimatedIncome": {
"attributeModel": "string",
"codeMessage": 0,
"message": "string",
"scoring": 0
},
"incomeCommitment": {
"attributeModel": "string",
"codeMessage": 0,
"message": "string",
"scoring": 0
},
"onTimePaymentsIndex": {
"attributeModel": "string",
"codeMessage": 0,
"message": "string",
"scoring": 0
}
},
"bankrupts": {
"response": [
{
"caseNumber": "string",
"city": "string",
"companyDocumentId": "string",
"companyName": "string",
"inclusionDate": "2019-08-24",
"legalNature": "string",
"occurrenceDate": "2019-08-24",
"positionCompany": "string",
"state": "string"
}
],
"summary": {
"balance": 0,
"count": 0,
"firstOccurrence": "2019-08-24",
"lastOccurrence": "2019-08-24"
}
},
"creditLimitAndDecision": {
"query": {
"code": 0,
"data": {
"analyzedCriteria": {
"documentActive": true,
"lowIncomeCommitment": true,
"noProtests": true,
"noRestriction": true
},
"billing": true,
"consumerName": "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"
}
},
"judgementFilings": {
"response": [
{
"amount": 0,
"availableDate": "2019-08-24",
"caseNumber": "string",
"city": "string",
"civilCourt": "string",
"distributor": "string",
"flagSubJudice": true,
"inclusionDate": "2019-08-24",
"legalNature": "string",
"legalNatureId": "string",
"legalSquare": "string",
"occurrenceDate": "2019-08-24",
"principal": true,
"state": "string"
}
],
"summary": {
"balance": 0,
"count": 0,
"firstOccurrence": "2019-08-24",
"lastOccurrence": "2019-08-24"
}
},
"overdueDebts": {
"collectionRecordsResponse": [
{
"amount": 0,
"city": "string",
"contractId": "string",
"creditorBusinessId": "string",
"creditorName": "string",
"federalUnit": "string",
"flagSubJudice": true,
"legalNature": "string",
"legalNatureId": "string",
"occurrenceDate": "2019-08-24",
"principal": true,
"publicAgency": true
}
],
"summary": {
"balance": 0,
"count": 0,
"firstOccurrence": "2019-08-24",
"lastOccurrence": "2019-08-24"
}
},
"partner": {
"partnerShipResponse": [
{
"businessDocument": "string",
"companyName": "string",
"companyState": "string",
"companyStatus": "string",
"companyStatusCode": "string",
"companyStatusDate": "2019-08-24",
"participationInitialDate": "2019-08-24",
"participationPercentage": 0,
"updateDate": "2019-08-24"
}
],
"summary": {
"count": 0
}
},
"paymentsHistory": {
"response": [
{
"finalDayRange": 0,
"initialDayRange": 0,
"range": "string",
"score": "string"
}
]
},
"spcAnotations": {
"spcNegative": {
"spcNegativeResponse": {
"amount": 0,
"city": "string",
"contractId": "string",
"creditorCity": "string",
"creditorFederalUnit": "string",
"creditorName": "string",
"federalUnit": "string",
"occurrenceDate": "2019-08-24",
"summary": {
"balance": 0,
"count": 0,
"firstOccurrence": "2019-08-24",
"lastOccurrence": "2019-08-24"
}
}
}
},
"spcInquiries": {
"creditInquiriesQuantity": {
"inquiryDate": "2019-08-24",
"occurrences": 0
},
"spcInquires": {
"spcInquiriesResponse": [
{
"occurrenceDate": "2019-08-24",
"segmentDescription": "string"
}
]
},
"spcInquirySummary": {
"spcInquiryQuantity": {
"actual": 0
}
},
"summary": {
"count": 0
}
}
},
"registration": {
"address": {
"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"
},
"birthDate": "2019-08-24",
"consumerName": "string",
"documentNumber": "string",
"motherName": "string",
"phone": {
"areaCode": 0,
"phoneNumber": 0,
"regionCode": 0
},
"statusDate": "2019-08-24",
"statusRegistration": "string"
},
"score": {
"codeMessage": 0,
"defaultRate": "string",
"message": "string",
"range": "string",
"score": 0,
"scoreModel": "string"
}
}