Dados cadastrais
Birô de Crédito - Credencial própria
O serviço de Birô de Crédito realiza a consolidação de informações financeiras provenientes de diversas fontes, incluindo bureaus de crédito, instituições financeiras, cartórios e outras bases relevantes. O relatório retornado contém dados cadastrais, quadro social administrativo, consultas realizadas anteriormente, dados de negativos (pendência financeira, restrição financeira, dívida vencida, cheque sem fundo e protesto nacional) e Score Positivo.
Quando usar
Descrição
O serviço de Birô de Crédito reúne, cruza e analisa informações financeiras e cadastrais de pessoas jurídicas a partir de múltiplas fontes, como bureaus de crédito, instituições financeiras, cartórios, registros públicos e outras bases especializadas.
O relatório retornado apresenta um conjunto abrangente de informações, incluindo:
Dados cadastrais: Informações como razão social, CNPJ, data de fundação, situação cadastral (Receita Federal) e endereço da empresa consultada.
Quadro social e administrativo: Informações sobre sócios, administradores e participantes da empresa, incluindo participação societária e cargos.
Histórico de consultas: Registro de consultas realizadas anteriormente por outras empresas e instituições.
Dados de negativos: Registros de pendências financeiras, restrições, dívidas vencidas, cheques sem fundo e protestos, incluindo valores, datas e credores.
Score positivo: Indicador de avaliação da empresa consultada, quando disponível, baseado em análises estatísticas e comportamentais.
Essa abordagem integrada contribui para uma avaliação mais precisa do perfil financeiro da empresa consultada, consolidando múltiplas fontes de informação em um único relatório.
Requisição
Autenticação por chave de API (cabeçalho Authorization: Bearer), criada no painel com esta consulta no escopo.
POST /api/v1/{tenant}/empresas/biro-de-credito-credencial-propria
| Campo | Obrigatório | Descrição |
|---|---|---|
document |
sim | CNPJ da empresa, com ou sem máscara. |
{
"document": "00.000.000/0000-00"
}
Campos de retorno
Campos dentro de data. [] indica lista.
| Campo | Tipo |
|---|---|
reportName |
texto |
registration.companyDocument |
texto |
registration.companyName |
texto |
registration.foundationDate |
data |
registration.statusRegistration |
texto |
registration.address.addressLine |
texto |
registration.address.zipCode |
texto |
registration.address.district |
texto |
registration.address.city |
texto |
registration.address.state |
texto |
resumo.hasNegativePendency |
booleano |
resumo.totalNegativeBalance |
número |
resumo.totalNegativeCount |
número |
resumo.score |
número |
resumo.defaultRate |
número |
resumo.defaultRateRaw |
texto |
resumo.scoreRange |
texto |
resumo.inquiriesCount |
número |
resumo.inquiriesCurrentMonthCount |
número |
resumo.partnersCount |
número |
resumo.pefinCount |
número |
resumo.refinCount |
número |
resumo.collectionRecordsCount |
número |
resumo.checkCount |
número |
resumo.notaryCount |
número |
resumo.spcAnnotationsCount |
número |
resumo.debtsPublicAgenciesCount |
número |
resumo.statusRegistration |
texto |
score.score |
número |
score.scoreModel |
texto |
score.defaultRate |
texto |
score.message |
texto |
score.billing |
booleano |
optionalFeatures.negativeData.pefin.pefinResponse[].occurrenceDate |
data |
optionalFeatures.negativeData.pefin.pefinResponse[].inclusionDate |
data |
optionalFeatures.negativeData.pefin.pefinResponse[].legalNatureId |
texto |
optionalFeatures.negativeData.pefin.pefinResponse[].legalNature |
texto |
optionalFeatures.negativeData.pefin.pefinResponse[].contractId |
texto |
optionalFeatures.negativeData.pefin.pefinResponse[].creditorName |
texto |
optionalFeatures.negativeData.pefin.pefinResponse[].amount |
número |
optionalFeatures.negativeData.pefin.pefinResponse[].principal |
booleano |
optionalFeatures.negativeData.pefin.pefinResponse[].dispute.disputeIndicativeFlag |
booleano |
optionalFeatures.negativeData.pefin.pefinResponse[].cadus |
texto |
optionalFeatures.negativeData.pefin.summary.firstOccurrence |
data |
optionalFeatures.negativeData.pefin.summary.lastOccurrence |
data |
optionalFeatures.negativeData.pefin.summary.count |
número |
optionalFeatures.negativeData.pefin.summary.balance |
número |
optionalFeatures.negativeData.refin.refinResponse[].occurrenceDate |
data |
optionalFeatures.negativeData.refin.refinResponse[].inclusionDate |
data |
optionalFeatures.negativeData.refin.refinResponse[].legalNatureId |
texto |
optionalFeatures.negativeData.refin.refinResponse[].legalNature |
texto |
optionalFeatures.negativeData.refin.refinResponse[].contractId |
texto |
optionalFeatures.negativeData.refin.refinResponse[].creditorName |
texto |
optionalFeatures.negativeData.refin.refinResponse[].amount |
número |
optionalFeatures.negativeData.refin.refinResponse[].principal |
booleano |
optionalFeatures.negativeData.refin.refinResponse[].cadus |
texto |
optionalFeatures.negativeData.refin.summary.firstOccurrence |
data |
optionalFeatures.negativeData.refin.summary.lastOccurrence |
data |
optionalFeatures.negativeData.refin.summary.count |
número |
optionalFeatures.negativeData.refin.summary.balance |
número |
optionalFeatures.negativeData.collectionRecords.collectionRecordsResponse[].occurrenceDate |
data |
optionalFeatures.negativeData.collectionRecords.collectionRecordsResponse[].inclusionDate |
data |
optionalFeatures.negativeData.collectionRecords.collectionRecordsResponse[].legalNatureId |
texto |
optionalFeatures.negativeData.collectionRecords.collectionRecordsResponse[].legalNature |
texto |
optionalFeatures.negativeData.collectionRecords.collectionRecordsResponse[].contractId |
texto |
optionalFeatures.negativeData.collectionRecords.collectionRecordsResponse[].creditorName |
texto |
optionalFeatures.negativeData.collectionRecords.collectionRecordsResponse[].amount |
número |
optionalFeatures.negativeData.collectionRecords.collectionRecordsResponse[].city |
texto |
optionalFeatures.negativeData.collectionRecords.collectionRecordsResponse[].federalUnit |
texto |
optionalFeatures.negativeData.collectionRecords.collectionRecordsResponse[].principal |
booleano |
optionalFeatures.negativeData.collectionRecords.collectionRecordsResponse[].dispute.disputeIndicativeFlag |
booleano |
optionalFeatures.negativeData.collectionRecords.collectionRecordsResponse[].cadus |
texto |
optionalFeatures.negativeData.collectionRecords.summary.firstOccurrence |
data |
optionalFeatures.negativeData.collectionRecords.summary.lastOccurrence |
data |
optionalFeatures.negativeData.collectionRecords.summary.count |
número |
optionalFeatures.negativeData.collectionRecords.summary.balance |
número |
optionalFeatures.negativeData.check.summary.count |
número |
optionalFeatures.negativeData.check.summary.balance |
número |
optionalFeatures.negativeData.notary.summary.count |
número |
optionalFeatures.negativeData.notary.summary.balance |
número |
optionalFeatures.facts.judgementFilings.summary.count |
número |
optionalFeatures.facts.judgementFilings.summary.balance |
número |
optionalFeatures.facts.bankrupts.summary.count |
número |
optionalFeatures.facts.bankrupts.summary.balance |
número |
optionalFeatures.facts.inquiryCompanyResponse.results[].occurrenceDate |
data |
optionalFeatures.facts.inquiryCompanyResponse.results[].companyName |
texto |
optionalFeatures.facts.inquiryCompanyResponse.results[].companyDocumentId |
texto |
optionalFeatures.facts.inquiryCompanyResponse.results[].companyAlias |
texto |
optionalFeatures.facts.inquiryCompanyResponse.results[].daysQuantity |
número |
optionalFeatures.facts.inquiryCompanyResponse.quantity.actual |
número |
optionalFeatures.facts.inquiryCompanyResponse.quantity.historical[].inquiryDate |
texto |
optionalFeatures.facts.inquiryCompanyResponse.quantity.historical[].occurrences |
número |
optionalFeatures.facts.inquirySegmentResponse.results[].occurrenceDate |
texto |
optionalFeatures.facts.inquirySegmentResponse.results[].contentBySegment[].segmentGroupCode |
número |
optionalFeatures.facts.inquirySegmentResponse.results[].contentBySegment[].segmentGroupDescription |
texto |
optionalFeatures.facts.inquirySegmentResponse.results[].contentBySegment[].monthConsultationQuantity |
número |
optionalFeatures.facts.inquirySegmentResponse.results[].monthTotalSegmentsConsultation |
número |
optionalFeatures.scores.scoreResponse[].score |
número |
optionalFeatures.scores.scoreResponse[].scoreModel |
texto |
optionalFeatures.scores.scoreResponse[].message |
texto |
optionalFeatures.scores.scoreResponse[].scoreParam[].key |
texto |
optionalFeatures.scores.scoreResponse[].scoreParam[].value |
texto |
optionalFeatures.scores.scoreResponse[].defaultRate |
texto |
optionalFeatures.scores.scoreResponse[].billing |
booleano |
optionalFeatures.scoresFraud.scoresFraudResponse[].scoreModel |
texto |
optionalFeatures.scoresFraud.scoresFraudResponse[].score |
número |
optionalFeatures.scoresFraud.scoresFraudResponse[].recommendationRisk |
texto |
optionalFeatures.sectorPaymentBehavior.latePayments.referenceDate |
data |
optionalFeatures.sectorPaymentBehavior.latePayments.percentageInSight |
número |
optionalFeatures.sectorPaymentBehavior.latePayments.averageCashValue |
número |
optionalFeatures.sectorPaymentBehavior.latePayments.percentage8To15 |
número |
optionalFeatures.sectorPaymentBehavior.latePayments.averageValue8To15 |
número |
optionalFeatures.sectorPaymentBehavior.latePayments.percentage16To30 |
número |
optionalFeatures.sectorPaymentBehavior.latePayments.averageValue16To30 |
número |
optionalFeatures.sectorPaymentBehavior.latePayments.percentage31To60 |
número |
optionalFeatures.sectorPaymentBehavior.latePayments.averageValue31To60 |
número |
optionalFeatures.sectorPaymentBehavior.latePayments.percentageAbove60 |
número |
optionalFeatures.sectorPaymentBehavior.latePayments.averageValueAbove60 |
número |
optionalFeatures.sectorPaymentBehavior.latePayments.totalPercentage |
número |
optionalFeatures.sectorPaymentBehavior.latePayments.totalAverageValue |
número |
optionalFeatures.sectorPaymentBehavior.latePayments.averageDelayPeriodInDays |
número |
optionalFeatures.sectorPaymentBehavior.futureMaturities.referenceDate |
data |
optionalFeatures.sectorPaymentBehavior.futureMaturities.percentageUpTo10 |
número |
optionalFeatures.sectorPaymentBehavior.futureMaturities.averageValueUpTo10 |
número |
optionalFeatures.sectorPaymentBehavior.futureMaturities.percentage11To30 |
número |
optionalFeatures.sectorPaymentBehavior.futureMaturities.averageValue11To30 |
número |
optionalFeatures.sectorPaymentBehavior.futureMaturities.percentage31To45 |
número |
optionalFeatures.sectorPaymentBehavior.futureMaturities.averageValue31To45 |
número |
optionalFeatures.sectorPaymentBehavior.futureMaturities.percentage46To60 |
número |
optionalFeatures.sectorPaymentBehavior.futureMaturities.averageValue46To60 |
número |
optionalFeatures.sectorPaymentBehavior.futureMaturities.percentageAbove60 |
número |
optionalFeatures.sectorPaymentBehavior.futureMaturities.averageValueAbove60 |
número |
optionalFeatures.sectorPaymentBehavior.futureMaturities.totalPercentage |
número |
optionalFeatures.sectorPaymentBehavior.futureMaturities.totalAverageValue |
número |
optionalFeatures.qsaCompleteReport.shareCapital.capitalValue |
número |
optionalFeatures.qsaCompleteReport.shareCapital.realizedCapitalValue |
número |
optionalFeatures.qsaCompleteReport.shareCapital.origin |
texto |
optionalFeatures.qsaCompleteReport.shareCapital.control |
texto |
optionalFeatures.qsaCompleteReport.shareCapital.nature |
texto |
optionalFeatures.qsaCompleteReport.shareCapital.updateDate |
data |
optionalFeatures.qsaCompleteReport.partners[].kindPerson |
texto |
optionalFeatures.qsaCompleteReport.partners[].document |
texto |
optionalFeatures.qsaCompleteReport.partners[].documentDigit |
texto |
optionalFeatures.qsaCompleteReport.partners[].documentSequence |
texto |
optionalFeatures.qsaCompleteReport.partners[].name |
texto |
optionalFeatures.qsaCompleteReport.partners[].status |
texto |
optionalFeatures.qsaCompleteReport.partners[].statusCode |
texto |
optionalFeatures.qsaCompleteReport.partners[].entryDate |
data |
optionalFeatures.qsaCompleteReport.partners[].percentageVotingCapital |
número |
optionalFeatures.qsaCompleteReport.partners[].percentageCapital |
número |
Lista parcial: os 150 primeiros campos.
Exemplo de resposta
Estrutura real da resposta, com valores fictícios.
{
"execution_id": "00000000-0000-0000-0000-000000000000",
"status": "success",
"message": "Consulta realizada com sucesso",
"query_name": "Birô de Crédito - Credencial própria",
"query_slug": "biro-de-credito-credencial-propria",
"data": {
"reportName": "texto",
"registration": {
"companyDocument": "texto",
"companyName": "texto",
"foundationDate": "2026-01-01",
"statusRegistration": "texto",
"address": {
"addressLine": "texto",
"zipCode": "texto",
"district": "texto",
"city": "texto",
"state": "texto"
}
},
"resumo": {
"hasNegativePendency": false,
"totalNegativeBalance": 0,
"totalNegativeCount": 0,
"score": 0,
"defaultRate": 0,
"defaultRateRaw": "texto",
"scoreRange": null,
"inquiriesCount": 0,
"inquiriesCurrentMonthCount": 0,
"partnersCount": 0,
"pefinCount": 0,
"refinCount": 0,
"collectionRecordsCount": 0,
"checkCount": 0,
"notaryCount": 0,
"spcAnnotationsCount": 0,
"debtsPublicAgenciesCount": 0,
"statusRegistration": "texto"
},
"score": {
"score": 0,
"scoreModel": "texto",
"defaultRate": "texto",
"message": "texto",
"billing": false
},
"negativeSummary": {
},
"optionalFeatures": {
"negativeData": {
"pefin": {
"pefinResponse": [
{
"occurrenceDate": "2026-01-01",
"inclusionDate": "2026-01-01",
"legalNatureId": "texto",
"legalNature": "texto",
"contractId": "texto",
"creditorName": "texto",
"amount": 0,
"principal": false,
"dispute": {
"disputeIndicativeFlag": false
},
"cadus": "texto"
}
],
"summary": {
"firstOccurrence": "2026-01-01",
"lastOccurrence": "2026-01-01",
"count": 0,
"balance": 0
}
},
"refin": {
"refinResponse": [
{
"occurrenceDate": "2026-01-01",
"inclusionDate": "2026-01-01",
"legalNatureId": "texto",
"legalNature": "texto",
"contractId": "texto",
"creditorName": "texto",
"amount": 0,
"principal": false,
"cadus": "texto"
}
],
"summary": {
"firstOccurrence": "2026-01-01",
"lastOccurrence": "2026-01-01",
"count": 0,
"balance": 0
}
},
"collectionRecords": {
"collectionRecordsResponse": [
{
"occurrenceDate": "2026-01-01",
"inclusionDate": "2026-01-01",
"legalNatureId": "texto",
"legalNature": "texto",
"contractId": "texto",
"creditorName": "texto",
"amount": 0,
"city": "texto",
"federalUnit": "texto",
"principal": false,
"dispute": {
"disputeIndicativeFlag": false
},
"cadus": "texto"
}
],
"summary": {
"firstOccurrence": "2026-01-01",
"lastOccurrence": "2026-01-01",
"count": 0,
"balance": 0
}
},
"check": {
"summary": {
"count": 0,
"balance": 0
}
},
"notary": {
"summary": {
"count": 0,
"balance": 0
}
}
},
"facts": {
"judgementFilings": {
"summary": {
"count": 0,
"balance": 0
}
},
"bankrupts": {
"summary": {
"count": 0,
"balance": 0
}
},
"inquiryCompanyResponse": {
"results": [
{
"occurrenceDate": "2026-01-01",
"companyName": "texto",
"companyDocumentId": "texto",
"companyAlias": "texto",
"daysQuantity": 0
}
],
"quantity": {
"actual": 0,
"historical": [
{
"inquiryDate": "texto",
"occurrences": 0
}
]
}
},
"inquirySegmentResponse": {
"results": [
{
"occurrenceDate": "texto",
"contentBySegment": [
{
"segmentGroupCode": 0,
"segmentGroupDescription": "texto",
"monthConsultationQuantity": 0
}
],
"monthTotalSegmentsConsultation": 0
}
]
}
},
"scores": {
"scoreResponse": [
{
"score": 0,
"scoreModel": "texto",
"message": "texto",
"scoreParam": [
{
"key": "texto",
"value": "texto"
}
],
"defaultRate": "texto",
"billing": false
}
]
},
"scoresFraud": {
"scoresFraudResponse": [
{
"scoreModel": "texto",
"score": 0,
"recommendationRisk": "texto"
}
]
},
"sectorPaymentBehavior": {
"latePayments": {
"referenceDate": "2026-01-01",
"percentageInSight": 0,
"averageCashValue": 0,
"percentage8To15": 0,
"averageValue8To15": 0,
"percentage16To30": 0,
"averageValue16To30": 0,
"percentage31To60": 0,
"averageValue31To60": 0,
"percentageAbove60": 0,
"averageValueAbove60": 0,
"totalPercentage": 0,
"totalAverageValue": 0,
"averageDelayPeriodInDays": 0
},
"futureMaturities": {
"referenceDate": "2026-01-01",
"percentageUpTo10": 0,
"averageValueUpTo10": 0,
"percentage11To30": 0,
"averageValue11To30": 0,
"percentage31To45": 0,
"averageValue31To45": 0,
"percentage46To60": 0,
"averageValue46To60": 0,
"percentageAbove60": 0,
"averageValueAbove60": 0,
"totalPercentage": 0,
"totalAverageValue": 0
}
},
"qsaCompleteReport": {
"shareCapital": {
"capitalValue": 0,
"realizedCapitalValue": 0,
"origin": "texto",
"control": "texto",
"nature": "texto",
"updateDate": "2026-01-01"
},
"partners": [
{
"kindPerson": "texto",
"document": "texto",
"documentDigit": "texto",
"documentSequence": "texto",
"name": "texto",
"status": "texto",
"statusCode": "texto",
"entryDate": "2026-01-01",
"percentageVotingCapital": 0,
"percentageCapital": 0,
"restrictionIndicator": false,
"relationship": "texto",
"address": {
"addressLine": "texto",
"zipCode": "texto",
"district": "texto",
"city": "texto",
"state": "texto"
},
"phone": {
"areaCode": "texto",
"phoneNumber": "texto"
},
"debts": [
{
"debtType": "texto",
"summary": {
"count": 0,
"balance": 0
}
}
]
}
],
"administrators": [
{
"kindPerson": "texto",
"document": "texto",
"documentDigit": "texto",
"documentSequence": "texto",
"name": "texto",
"status": "texto",
"statusCode": "texto",
"office": "texto",
"startDateTerm": "2026-01-01",
"entryDate": "2026-01-01",
"restrictionIndicator": false,
"relationship": "texto",
"address": {
"addressLine": "texto",
"zipCode": "texto",
"district": "texto",
"city": "texto",
"state": "texto"
},
"phone": {
"areaCode": "texto",
"phoneNumber": "texto"
},
"debts": [
{
"debtType": "texto",
"summary": {
"count": 0,
"balance": 0
}
}
]
}
]
},
"spcPartnersAnnotationsReport": {
"result": [
{
"documentId": "texto",
"documentConsistency": false,
"name": "texto",
"annotationsQuantity": 0,
"partnerSPCAnnotationsData": [
{
"message": "texto"
}
]
}
],
"partnerSPCInquiriesResult": [
{
"documentId": "texto",
"documentConsistency": false,
"name": "texto",
"inquiriesPartnerQuantity": 0,
"partnerSPCInquiriesData": [
{
"consultationDate": "2026-01-01",
"name": "texto",
"inquiriesPartnerQuantity": 0
}
],
"partnerSPCInquiriesPerMonthData": [
{
"inquiryYear": 0,
"inquiryMonth": 0,
"descriptionMonth": "texto",
"inquiriesPartnerQuantity": 0
}
]
}
]
},
"companyParticipationsReport": {
"participateds": [
{
"participatedDocumentId": "texto",
"digitDocument": "texto",
"documentSequence": "texto",
"participatedName": "texto",
"statusCompany": "texto",
"squareCompany": "texto",
"updateDate": "2026-01-01",
"restrictionSign": false,
"address": {
"city": "texto",
"state": "texto"
},
"participants": [
{
"documentId": "texto",
"participantName": "texto",
"digitDocument": "texto",
"participationType": "texto",
"participationPercentageCapital": 0,
"restrictionSign": false
}
],
"resume": {
"participationPercentageCapitalTotal": 0
}
}
]
},
"spcAnnotations": {
"spcAnnotationsResponseList": [
{
"occurrenceDate": "2026-01-01",
"inclusionDate": "2026-01-01",
"contractId": "texto",
"creditorName": "texto",
"amount": 0,
"city": "texto",
"federalUnit": "texto",
"principal": false,
"origin": "texto"
}
],
"summary": {
"firstOccurrence": "2026-01-01",
"lastOccurrence": "2026-01-01",
"count": 0,
"balance": 0
}
},
"spcMarketInquiries": {
"spcMarketInquiriesResponseList": [
{
"occurrenceDate": "2026-01-01",
"companyName": "texto",
"companyAlias": "texto",
"companyDocumentId": "texto",
"daysQuantity": 0
}
]
},
"spcMarketInquirySummary": {
"inquiryQuantity": {
"actual": 0,
"creditInquiriesQuantity": [
{
"inquiryDate": "texto",
"occurrences": 0
}
]
}
},
"fiscalSituation": {
"document": "texto",
"sintegra": [
{
"situation": {
"situationDate": "2026-01-01",
"registrationNumber": "texto",
"situationCode": "texto"
},
"identification": {
"websiteConsultationNumber": "texto",
"websiteConsultationDate": "2026-01-01",
"corporateName": "texto"
},
"economicActivity": {
"description": "texto"
},
"observation": "texto"
}
],
"federalRevenue": {
"identification": {
"consultationDate": "2026-01-01",
"description": "texto",
"corporateName": "texto",
"situationDate": "2026-01-01",
"simpleChoose": "texto",
"situationCode": "texto",
"cnae": {
"code": "texto",
"segment": "texto",
"description": "texto"
}
}
}
},
"intermediaryCommercialPaymentHistory": {
"paymentsHistoryResponse": [
{
"billing": false
}
]
},
"financialPaymentHistoryFeature": {
"result": {
"paymentCommitment": {
"active": {
"creditorsQuantity": 0,
"totalCommitments": {
"range": "texto",
"value": "texto"
},
"commitmentsQuantity": {
"range": "texto",
"value": "texto"
},
"installment": {
"paid": 0,
"due": 0,
"overdue": 0
},
"paymentMode": [
{
"name": "texto",
"percentage": 0
}
]
}
},
"paymentBehavior": {
"payment": {
"active": {
"revolvingCredit": 0,
"punctualPayment": 0,
"upTo30Days": 0,
"from30To60Days": 0,
"above60Days": 0,
"ranges": {
"revolvingCredit": "texto",
"punctualPayment": "texto",
"latePayment": "texto"
},
"total": {
"range": "texto",
"value": "texto"
},
"auxiliaries": {
"revolvingCredit": {
"range": "texto",
"value": "texto",
"percentage": "texto"
},
"punctualPayment": {
"range": "texto",
"value": "texto",
"percentage": "texto"
},
"upTo30Days": {
"range": "texto",
"value": "texto",
"percentage": "texto"
},
"above30Days": {
"range": "texto",
"value": "texto",
"percentage": "texto"
}
}
}
},
"expirationBehavior": {
"upTo30Days": 0,
"from30To60Days": 0,
"from60To90Days": 0,
"above90Days": 0,
"total": {
"range": "texto",
"value": "texto"
}
},
"contractBehavior": {
"paid": 0,
"due": 0,
"overdue": 0,
"total": {
"range": "texto",
"value": "texto"
}
}
}
}
},
"partnersScores": {
"companyData": {
"documentId": "texto",
"port": "texto"
},
"partnersScores": [
{
"name": "texto",
"document": "texto",
"score": 0,
"paymentSuccessPercentage": 0,
"scoreClassification": "texto"
}
]
},
"debtsPublicAgencies": {
"debtsPublicAgenciesCommitments": {
}
},
"location": {
"addresses": {
"addresses": [
{
"updateDate": "2026-01-01",
"addressType": "texto",
"addressTitle": "texto",
"addressName": "texto",
"addressNumber": "texto",
"addressComplement": "texto",
"neighborhood": "texto",
"city": "texto",
"federalUnit": "texto",
"zipCode": "texto",
"relatedTo": "texto"
}
]
},
"phones": {
"phones": [
{
"updateDate": "2026-01-01",
"areaCode": "texto",
"number": "texto",
"relatedTo": "texto"
}
]
}
},
"cardSales": {
"corporates": [
{
"document": "texto",
"address": "texto",
"network": "texto",
"segment": "texto",
"city": "texto",
"updateDate": "texto",
"firstTransactionDate": "texto",
"lastTransactionPeriod": "texto",
"brandName": "texto",
"companyName": "texto",
"postalCode": "texto",
"mainChannel": "texto",
"state": "texto",
"transactions": {
"_06_12": {
"thu": false,
"tue": false,
"wed": false,
"sat": false,
"fri": false,
"mon": false,
"sun": false
},
"_12_18": {
"thu": false,
"tue": false,
"wed": false,
"sat": false,
"fri": false,
"mon": false,
"sun": false
}
},
"phone": "texto",
"status": 0
}
]
},
"companyLongevity": {
"perspective": "texto",
"cessationProbability": 0,
"marketPractice": "texto",
"interpretationMessage": "texto",
"longevityScoreModel": "texto",
"referenceScoreModel": "texto",
"points": 0,
"score": 0
}
}
},
"consulted_at": "2026-01-01T12:00:00Z",
"query_cost": "1.000"
}
Cobrança e respostas
- O valor é cobrado por consulta bem-sucedida.
- 200 — consulta processada (veja status no corpo da resposta)
- 401 — token ausente, inválido, inativo ou expirado
- 403 — serviço fora do escopo da chave, IP não autorizado ou limite de consumo excedido
- 422 — campo obrigatório ausente/inválido ou payload acima do limite do serviço
- 429 — limite de requisições por minuto da chave excedido
- 504 — tempo máximo de execução do serviço excedido