# Birô de Crédito

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 completos, informações sobre negativos (pendências financeiras, restrições financeiras, dívidas vencidas, cheques sem fundo, protestos nacionais), consultas realizadas anteriormente, documentos roubados, participação societária e score positivo, além de funcionalidades adicionais e opcionais.

- **Identificador:** `pessoas/biro-de-credito`
- **Categoria:** Crédito, renda e birô
- **Audiência:** PF
- **Endpoint:** `POST /api/v1/{tenant}/pessoas/biro-de-credito`
- **Preço de tabela:** R$ 8,330 por consulta bem-sucedida
- **Página:** https://www.proteo.com.br/api/consultas/pessoas/biro-de-credito

## Quando usar

Descrição

O serviço de Birô de Crédito reúne, cruza e analisa informações financeiras e cadastrais de pessoas físicas 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 nome, CPF, data de nascimento, nome da mãe e situação cadastral (Receita Federal) da pessoa consultada.

Dados de negativos: Registros de pendências financeiras, restrições, dívidas vencidas, cheques sem fundo e protestos, incluindo valores, datas e credores.

Informações complementares: Dados como histórico de consultas realizadas, registros de documentos com alerta, participação societária e score positivo, quando disponíveis.

Funcionalidades adicionais: Recursos opcionais que podem incluir análises complementares e informações suplementares para avaliação do perfil consultado.

Essa abordagem integrada contribui para uma avaliação mais precisa do perfil financeiro da pessoa consultada, consolidando múltiplas fontes de informação em um único relatório atualizado.

## Parâmetros (corpo JSON)

| Campo | Obrigatório | Descrição |
|---|---|---|
| `document` | sim | CPF da pessoa, com ou sem máscara. |

## Campos de retorno (`data`)

| Campo | Tipo |
|---|---|
| `reportName` | texto |
| `registration.documentNumber` | texto |
| `registration.consumerName` | texto |
| `registration.motherName` | texto |
| `registration.birthDate` | data |
| `registration.statusRegistration` | texto |
| `registration.statusDate` | data |
| `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.partnersBalance` | número |
| `resumo.presumedIncome` | número |
| `resumo.presumedIncomeSource` | texto |
| `resumo.pefinCount` | número |
| `resumo.refinCount` | número |
| `resumo.collectionRecordsCount` | número |
| `resumo.checkCount` | número |
| `resumo.notaryCount` | número |
| `resumo.stolenDocumentsCount` | número |
| `resumo.spcNegativeCount` | número |
| `resumo.judgementFilingsCount` | número |
| `resumo.bankruptsCount` | número |
| `resumo.hasFraudScores` | booleano |
| `resumo.hasAgroScores` | booleano |
| `resumo.hasCreditRecoveryScore` | booleano |
| `resumo.hasPaymentHistory` | booleano |
| `resumo.hasRendaMais` | booleano |
| `resumo.hasSpcInquiriesData` | booleano |
| `resumo.hasDeathAlert` | booleano |
| `resumo.hasRegistrationAddresses` | booleano |
| `resumo.hasRegistrationPhones` | booleano |
| `score.score` | número |
| `score.scoreModel` | texto |
| `score.range` | texto |
| `score.defaultRate` | texto |
| `score.codeMessage` | número |
| `score.message` | texto |
| `facts.inquiry.inquiryResponse[].occurrenceDate` | data |
| `facts.inquiry.inquiryResponse[].segmentDescription` | texto |
| `facts.inquiry.inquiryResponse[].daysQuantity` | número |
| `facts.inquiry.summary.count` | número |
| `facts.inquirySummary.inquiryQuantity.actual` | número |
| `facts.inquirySummary.inquiryQuantity.creditInquiriesQuantity[].inquiryDate` | texto |
| `facts.inquirySummary.inquiryQuantity.creditInquiriesQuantity[].occurrences` | número |
| `facts.stolenDocuments.summary.count` | número |
| `facts.stolenDocuments.summary.balance` | número |
| `partner.partnershipResponse[].businessDocument` | texto |
| `partner.partnershipResponse[].companyName` | texto |
| `partner.partnershipResponse[].participationPercentage` | número |
| `partner.partnershipResponse[].companyStatus` | texto |
| `partner.partnershipResponse[].companyStatusCode` | texto |
| `partner.partnershipResponse[].companyState` | texto |
| `partner.partnershipResponse[].companyStatusDate` | data |
| `partner.partnershipResponse[].updateDate` | data |
| `partner.partnershipResponse[].hasNegative` | booleano |
| `partner.summary.count` | número |
| `partner.summary.balance` | número |
| `optionalFeatures.registration.phones[].regionCode` | número |
| `optionalFeatures.registration.phones[].areaCode` | número |
| `optionalFeatures.registration.phones[].phoneNumber` | número |
| `optionalFeatures.registration.phones[].phoneType` | texto |
| `optionalFeatures.registration.phones[].phoneTypeCode` | número |
| `optionalFeatures.registration.phones[].updateDate` | data |
| `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.count` | número |
| `optionalFeatures.negativeData.pefin.summary.balance` | número |
| `optionalFeatures.negativeData.pefin.summary.firstOccurrence` | data |
| `optionalFeatures.negativeData.pefin.summary.lastOccurrence` | data |
| `optionalFeatures.negativeData.refin.summary.count` | número |
| `optionalFeatures.negativeData.refin.summary.balance` | número |
| `optionalFeatures.negativeData.notary.summary.count` | número |
| `optionalFeatures.negativeData.notary.summary.balance` | número |
| `optionalFeatures.negativeData.check.summary.count` | número |
| `optionalFeatures.negativeData.check.summary.checkCount` | número |
| `optionalFeatures.negativeData.check.summary.balance` | número |
| `optionalFeatures.negativeData.spcNegative.summary.count` | número |
| `optionalFeatures.negativeData.spcNegative.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.count` | número |
| `optionalFeatures.negativeData.collectionRecords.summary.balance` | número |
| `optionalFeatures.negativeData.collectionRecords.summary.firstOccurrence` | data |
| `optionalFeatures.negativeData.collectionRecords.summary.lastOccurrence` | data |
| `optionalFeatures.scores.scoreResponse[].score` | número |
| `optionalFeatures.scores.scoreResponse[].scoreModel` | texto |
| `optionalFeatures.scores.scoreResponse[].range` | texto |
| `optionalFeatures.scores.scoreResponse[].defaultRate` | texto |
| `optionalFeatures.scores.scoreResponse[].codeMessage` | número |
| `optionalFeatures.scores.scoreResponse[].message` | texto |
| `optionalFeatures.scoresFraud.scoresFraudResponse[].scoreModel` | texto |
| `optionalFeatures.scoresFraud.scoresFraudResponse[].score` | número |
| `optionalFeatures.scoresFraud.scoresFraudResponse[].recommendationRisk` | texto |
| `optionalFeatures.facts.spcInquires.spcInquiriesResponse[].occurrenceDate` | data |
| `optionalFeatures.facts.spcInquires.spcInquiriesResponse[].segmentDescription` | texto |
| `optionalFeatures.facts.spcInquires.summary.count` | 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.spcInquirySummary.spcInquiryQuantity.actual` | número |
| `optionalFeatures.facts.spcInquirySummary.spcInquiryQuantity.creditInquiriesQuantity[].inquiryDate` | texto |
| `optionalFeatures.facts.spcInquirySummary.spcInquiryQuantity.creditInquiriesQuantity[].occurrences` | número |
| `optionalFeatures.facts.spcInquirySummary.summary.count` | número |
| `optionalFeatures.paymentshistory.paymentsHistoryResponse[].initialDayRange` | número |
| `optionalFeatures.paymentshistory.paymentsHistoryResponse[].finalDayRange` | número |
| `optionalFeatures.paymentshistory.paymentsHistoryResponse[].score` | texto |
| `optionalFeatures.paymentshistory.paymentsHistoryResponse[].range` | texto |
| `optionalFeatures.attributes.attributesResponse[].attributeModel` | texto |
| `optionalFeatures.attributes.attributesResponse[].codeMessage` | número |
| `optionalFeatures.attributes.attributesResponse[].message` | texto |
| `optionalFeatures.attributes.attributesResponse[].data[].code` | texto |
| `optionalFeatures.attributes.attributesResponse[].data[].codeDescription` | texto |
| `optionalFeatures.attributes.attributesResponse[].data[].message` | texto |
| `optionalFeatures.attributes.attributesResponse[].data[].codeMessage` | número |
| `optionalFeatures.attributes.affordability.attributeModel` | texto |
| `optionalFeatures.attributes.affordability.codeMessage` | número |
| `optionalFeatures.attributes.affordability.message` | texto |
| `optionalFeatures.attributes.incomeCommitment.attributeModel` | texto |
| `optionalFeatures.attributes.incomeCommitment.codeMessage` | número |
| `optionalFeatures.attributes.incomeCommitment.message` | texto |
| `optionalFeatures.deathAlert.deathResponse[].document` | texto |
| `optionalFeatures.deathAlert.deathResponse[].codes[].messageCode` | texto |
| `optionalFeatures.deathAlert.deathResponse[].codes[].fullMessage` | texto |

## Exemplo de resposta (valores fictícios)

```json
{
  "execution_id": "00000000-0000-0000-0000-000000000000",
  "status": "success",
  "message": "Consulta realizada com sucesso",
  "query_name": "Birô de Crédito",
  "query_slug": "biro-de-credito",
  "data": {
    "reportName": "texto",
    "registration": {
      "documentNumber": "texto",
      "consumerName": "texto",
      "motherName": "texto",
      "birthDate": "2026-01-01",
      "statusRegistration": "texto",
      "statusDate": "2026-01-01"
    },
    "resumo": {
      "hasNegativePendency": false,
      "totalNegativeBalance": 0,
      "totalNegativeCount": 0,
      "score": 0,
      "defaultRate": 0,
      "defaultRateRaw": "texto",
      "scoreRange": "texto",
      "inquiriesCount": 0,
      "inquiriesCurrentMonthCount": 0,
      "partnersCount": 0,
      "partnersBalance": 0,
      "presumedIncome": 0,
      "presumedIncomeSource": "texto",
      "pefinCount": 0,
      "refinCount": 0,
      "collectionRecordsCount": 0,
      "checkCount": 0,
      "notaryCount": 0,
      "stolenDocumentsCount": 0,
      "spcNegativeCount": 0,
      "judgementFilingsCount": 0,
      "bankruptsCount": 0,
      "hasFraudScores": false,
      "hasAgroScores": false,
      "hasCreditRecoveryScore": false,
      "hasPaymentHistory": false,
      "hasRendaMais": false,
      "hasSpcInquiriesData": false,
      "hasDeathAlert": false,
      "hasRegistrationAddresses": false,
      "hasRegistrationPhones": false
    },
    "score": {
      "score": 0,
      "scoreModel": "texto",
      "range": "texto",
      "defaultRate": "texto",
      "codeMessage": 0,
      "message": "texto"
    },
    "negativeSummary": {
    },
    "facts": {
      "inquiry": {
        "inquiryResponse": [
          {
            "occurrenceDate": "2026-01-01",
            "segmentDescription": "texto",
            "daysQuantity": 0
          }
        ],
        "summary": {
          "count": 0
        }
      },
      "inquirySummary": {
        "inquiryQuantity": {
          "actual": 0,
          "creditInquiriesQuantity": [
            {
              "inquiryDate": "texto",
              "occurrences": 0
            }
          ]
        }
      },
      "stolenDocuments": {
        "stolenDocumentsResponse": {
        },
        "summary": {
          "count": 0,
          "balance": 0
        }
      }
    },
    "partner": {
      "partnershipResponse": [
        {
          "businessDocument": "texto",
          "companyName": "texto",
          "participationPercentage": 0,
          "companyStatus": "texto",
          "companyStatusCode": "texto",
          "companyState": "texto",
          "companyStatusDate": "2026-01-01",
          "updateDate": "2026-01-01",
          "hasNegative": false
        }
      ],
      "summary": {
        "count": 0,
        "balance": 0
      }
    },
    "optionalFeatures": {
      "registration": {
        "addresses": {
        },
        "phones": [
          {
            "regionCode": 0,
            "areaCode": 0,
            "phoneNumber": 0,
            "phoneType": "texto",
            "phoneTypeCode": 0,
            "updateDate": "2026-01-01"
          }
        ]
      },
      "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": {
            "count": 0,
            "balance": 0,
            "firstOccurrence": "2026-01-01",
            "lastOccurrence": "2026-01-01"
          }
        },
        "refin": {
          "refinResponse": {
          },
          "summary": {
            "count": 0,
            "balance": 0
          }
        },
        "notary": {
          "notaryResponse": {
          },
          "summary": {
            "count": 0,
            "balance": 0
          }
        },
        "check": {
          "checkResponse": {
          },
          "summary": {
            "count": 0,
            "checkCount": 0,
            "balance": 0
          }
        },
        "spcNegative": {
          "spcNegativeResponse": {
          },
          "summary": {
            "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": {
            "count": 0,
            "balance": 0,
            "firstOccurrence": "2026-01-01",
            "lastOccurrence": "2026-01-01"
          }
        }
      },
      "scores": {
        "scoreResponse": [
          {
            "score": 0,
            "scoreModel": "texto",
            "range": "texto",
            "defaultRate": "texto",
            "codeMessage": 0,
            "message": "texto"
          }
        ]
      },
      "scoresFraud": {
        "scoresFraudResponse": [
          {
            "scoreModel": "texto",
            "score": 0,
            "recommendationRisk": "texto"
          }
        ]
      },
      "facts": {
        "spcInquires": {
          "spcInquiriesResponse": [
            {
              "occurrenceDate": "2026-01-01",
              "segmentDescription": "texto"
            }
          ],
          "summary": {
            "count": 0
          }
        },
        "judgementFilings": {
          "judgementFilingsResponse": {
          },
          "summary": {
            "count": 0,
            "balance": 0
          }
        },
        "bankrupts": {
          "bankruptsResponse": {
          },
          "summary": {
            "count": 0,
            "balance": 0
          }
        },
        "spcInquirySummary": {
          "spcInquiryQuantity": {
            "actual": 0,
            "creditInquiriesQuantity": [
              {
                "inquiryDate": "texto",
                "occurrences": 0
              }
            ]
          },
          "summary": {
            "count": 0
          }
        }
      },
      "paymentshistory": {
        "paymentsHistoryResponse": [
          {
            "initialDayRange": 0,
            "finalDayRange": 0,
            "score": "texto",
            "range": "texto"
          }
        ]
      },
      "attributes": {
        "attributesResponse": [
          {
            "attributeModel": "texto",
            "codeMessage": 0,
            "message": "texto",
            "data": [
              {
                "code": "texto",
                "codeDescription": "texto",
                "message": "texto",
                "codeMessage": 0
              }
            ]
          }
        ],
        "affordability": {
          "attributeModel": "texto",
          "codeMessage": 0,
          "message": "texto"
        },
        "incomeCommitment": {
          "attributeModel": "texto",
          "codeMessage": 0,
          "message": "texto"
        }
      },
      "deathAlert": {
        "deathResponse": [
          {
            "document": "texto",
            "codes": [
              {
                "messageCode": "texto",
                "fullMessage": "texto"
              }
            ]
          }
        ]
      }
    }
  },
  "consulted_at": "2026-01-01T12:00:00Z",
  "query_cost": "8.330"
}
```