post https://apigwws.bizapis.com/v2/documents/responsabilidade-credito-details
This endpoint returns a document about the Responsabilidade Crédito.
What's New in bizAPIs 3.0Enhanced Error Responses with bizAPIs Status Codes
bizAPIs 3.0 introduces structured error responses with dedicated bizAPIs status codes, making debugging faster and support interactions more efficient. All error responses now include detailed metadata like
requestId,errorCode, anderrorNameto help you quickly identify and resolve issues.
Availability by Environment
Environment Status 📚 Documentation ⏳ Coming Soon 🧪 QUAL ✅ Available 🚀 Production ⏳ Coming Soon
Inputs
Credentials
📄 Extract Document
- This approach allows you to retrieve and process a document using credentials instead of directly uploading a file.\
- The service (
bizAPIs) will first retrieve the document from the source system and then extract the desired information from it.
- The service (
📝 Request Format (JSON Body)
- Content-Type:
application/json- Fields:
month(required) → The month of the document to be retrievedyear(required) → The year of the document to be retrieveduser(required) → The user identifier for authenticationpassword(required) → The password for authentication
- Fields:
File
📂 File Upload Support
-
This endpoint supports file uploads using the
multipart/form-datacontent type.
This allows you to send files (such as PDFs) directly with your requests. -
You can also send files via raw JSON in the request body by encoding the file in Base64.
📝 Request Format (Form Data)
- Content-Type:
multipart/form-data - Parameters:
file(required) → The file you want to upload
📝 Request Format (JSON Body)
- Content-Type:
application/json - Fields:
file(required) → The Base64-encoded file content
⚠️ Notes
- File type allowed: Only
.pdf - Maximum file size: 20 MB
- Multiple file uploads: Not supported
Download Project
JSON Schema API Response
{
"type": "object",
"properties": {
"requestId": {
"type": "string",
"description": "Unique request identifier"
},
"withoutCreditResponsibility": {
"type": "boolean",
"description": "Indicates whether the customer has credit responsibilities"
},
"summary": {
"type": "object",
"description": "Summary of Credit Responsibilities",
"properties": {
"nif": {
"type": "string",
"description": "Tax Identification Number (NIF)"
},
"name": {
"type": "string",
"description": "Account holder's name"
},
"creditResponsibilityJoint": {
"type": "object",
"description": "Summary related to joint credits",
"properties": {
"homeLoan": {
"type": "object",
"description": "Summary related to home loans",
"properties": {
"inDebtAmount": {
"type": "number",
"description": "Total outstanding loan amount"
},
"nonCompliantAmount": {
"type": "number",
"description": "Amount in default"
},
"potentialAmount": {
"type": "number",
"description": "Potential amount"
},
"numberOfProducts": {
"type": "integer",
"description": "Number of products"
},
"productsWithGuarantee": {
"type": "integer",
"description": "Number of products with a guarantee"
}
}
},
"relatedLoan": {
"type": "object",
"description": "Summary related to related loans",
"properties": {
"inDebtAmount": {
"type": "number",
"description": "Total outstanding loan amount"
},
"nonCompliantAmount": {
"type": "number",
"description": "Amount in default"
},
"potentialAmount": {
"type": "number",
"description": "Potential amount"
},
"numberOfProducts": {
"type": "integer",
"description": "Number of products"
},
"productsWithGuarantee": {
"type": "integer",
"description": "Number of products with a guarantee"
}
}
},
"personalLoan": {
"type": "object",
"description": "Summary related to personal loans",
"properties": {
"inDebtAmount": {
"type": "number",
"description": "Total outstanding loan amount"
},
"nonCompliantAmount": {
"type": "number",
"description": "Amount in default"
},
"potentialAmount": {
"type": "number",
"description": "Potential amount"
},
"numberOfProducts": {
"type": "integer",
"description": "Number of products"
},
"productsWithGuarantee": {
"type": "integer",
"description": "Number of products with a guarantee"
}
}
},
"financialLeasing": {
"type": "object",
"description": "Summary related to financial leasing",
"properties": {
"inDebtAmount": {
"type": "number",
"description": "Total outstanding loan amount"
},
"nonCompliantAmount": {
"type": "number",
"description": "Amount in default"
},
"potentialAmount": {
"type": "number",
"description": "Potential amount"
},
"numberOfProducts": {
"type": "integer",
"description": "Number of products"
},
"productsWithGuarantee": {
"type": "integer",
"description": "Number of products with a guarantee"
}
}
},
"carLoanExcludingFinancialLeasing": {
"type": "object",
"description": "Summary related to car loans excluding financial leasing",
"properties": {
"inDebtAmount": {
"type": "number",
"description": "Total outstanding loan amount"
},
"nonCompliantAmount": {
"type": "number",
"description": "Amount in default"
},
"potentialAmount": {
"type": "number",
"description": "Potential amount"
},
"numberOfProducts": {
"type": "integer",
"description": "Number of products"
},
"productsWithGuarantee": {
"type": "integer",
"description": "Number of products with a guarantee"
}
}
},
"otherLoans": {
"type": "object",
"description": "Map of summaries related to other loans",
"additionalProperties": {
"type": "object",
"properties": {
"inDebtAmount": {
"type": "number",
"description": "Total outstanding loan amount"
},
"nonCompliantAmount": {
"type": "number",
"description": "Amount in default"
},
"potentialAmount": {
"type": "number",
"description": "Potential amount"
},
"numberOfProducts": {
"type": "integer",
"description": "Number of products"
},
"productsWithGuarantee": {
"type": "integer",
"description": "Number of products with a guarantee"
}
}
}
},
"loanOverrun": {
"type": "object",
"description": "Summary related to loan overruns",
"properties": {
"inDebtAmount": {
"type": "number",
"description": "Total outstanding loan amount"
},
"nonCompliantAmount": {
"type": "number",
"description": "Amount in default"
},
"potentialAmount": {
"type": "number",
"description": "Potential amount"
},
"numberOfProducts": {
"type": "integer",
"description": "Number of products"
},
"productsWithGuarantee": {
"type": "integer",
"description": "Number of products with a guarantee"
}
}
},
"overdraftFacility": {
"type": "object",
"description": "Summary related to overdraft facilities",
"properties": {
"inDebtAmount": {
"type": "number",
"description": "Total outstanding loan amount"
},
"nonCompliantAmount": {
"type": "number",
"description": "Amount in default"
},
"potentialAmount": {
"type": "number",
"description": "Potential amount"
},
"numberOfProducts": {
"type": "integer",
"description": "Number of products"
},
"productsWithGuarantee": {
"type": "integer",
"description": "Number of products with a guarantee"
}
}
},
"creditCard": {
"type": "object",
"description": "Summary related to credit cards",
"properties": {
"inDebtAmount": {
"type": "number",
"description": "Total outstanding loan amount"
},
"nonCompliantAmount": {
"type": "number",
"description": "Amount in default"
},
"potentialAmount": {
"type": "number",
"description": "Potential amount"
},
"numberOfProducts": {
"type": "integer",
"description": "Number of products"
},
"productsWithGuarantee": {
"type": "integer",
"description": "Number of products with a guarantee"
}
}
},
"creditCardWithFreeFloat": {
"type": "object",
"description": "Summary related to credit cards with a free float period",
"properties": {
"inDebtAmount": {
"type": "number",
"description": "Total outstanding loan amount"
},
"nonCompliantAmount": {
"type": "number",
"description": "Amount in default"
},
"potentialAmount": {
"type": "number",
"description": "Potential amount"
},
"numberOfProducts": {
"type": "integer",
"description": "Number of products"
},
"productsWithGuarantee": {
"type": "integer",
"description": "Number of products with a guarantee"
}
}
},
"creditCardWithoutFreeFloat": {
"type": "object",
"description": "Summary related to credit cards without a free float period",
"properties": {
"inDebtAmount": {
"type": "number",
"description": "Total outstanding loan amount"
},
"nonCompliantAmount": {
"type": "number",
"description": "Amount in default"
},
"potentialAmount": {
"type": "number",
"description": "Potential amount"
},
"numberOfProducts": {
"type": "integer",
"description": "Number of products"
},
"productsWithGuarantee": {
"type": "integer",
"description": "Number of products with a guarantee"
}
}
},
"deferredDebitCard": {
"type": "object",
"description": "Summary related to deferred debit cards",
"properties": {
"inDebtAmount": {
"type": "number",
"description": "Total outstanding loan amount"
},
"nonCompliantAmount": {
"type": "number",
"description": "Amount in default"
},
"potentialAmount": {
"type": "number",
"description": "Potential amount"
},
"numberOfProducts": {
"type": "integer",
"description": "Number of products"
},
"productsWithGuarantee": {
"type": "integer",
"description": "Number of products with a guarantee"
}
}
},
"revolvingCredit": {
"type": "object",
"description": "Summary related to revolving credits",
"properties": {
"inDebtAmount": {
"type": "number",
"description": "Total outstanding loan amount"
},
"nonCompliantAmount": {
"type": "number",
"description": "Amount in default"
},
"potentialAmount": {
"type": "number",
"description": "Potential amount"
},
"numberOfProducts": {
"type": "integer",
"description": "Number of products"
},
"productsWithGuarantee": {
"type": "integer",
"description": "Number of products with a guarantee"
}
}
},
"nonRevolvingCredit": {
"type": "object",
"description": "Summary related to non-revolving credits",
"properties": {
"inDebtAmount": {
"type": "number",
"description": "Total outstanding loan amount"
},
"nonCompliantAmount": {
"type": "number",
"description": "Amount in default"
},
"potentialAmount": {
"type": "number",
"description": "Potential amount"
},
"numberOfProducts": {
"type": "integer",
"description": "Number of products"
},
"productsWithGuarantee": {
"type": "integer",
"description": "Number of products with a guarantee"
}
}
},
"totalLoan": {
"type": "object",
"description": "List of the sum by field of all financial products",
"properties": {
"inDebtAmount": {
"type": "number",
"description": "Total outstanding loan amount"
},
"nonCompliantAmount": {
"type": "number",
"description": "Amount in default"
},
"potentialAmount": {
"type": "number",
"description": "Potential amount"
},
"numberOfProducts": {
"type": "integer",
"description": "Number of products"
},
"productsWithGuarantee": {
"type": "integer",
"description": "Number of products with a guarantee"
},
"isNonCompliantAmountFromCreditCard": {
"type": "boolean",
"description": "Indicates whether the amount in default comes from a credit card"
}
}
}
}
}
}
}
}
}
{
"type" : "object",
"properties" : {
"requestId" : {
"type" : "string",
"description" : "Identificador único do pedido"
},
"withoutCreditResponsibility" : {
"type" : "boolean",
"description" : "Permite identificar se o cliente tem responsabilidades"
},
"summary" : {
"type" : "object",
"description" : "Resumo das Responsabilidades de Crédito",
"properties" : {
"nif" : {
"type" : "string",
"description" : "Número de Identificação Fiscal (NIF)"
},
"name" : {
"type" : "string",
"description" : "Nome do titular"
},
"creditResponsibilityJoint" : {
"type" : "object",
"description" : "Resumo relacionado aos créditos conjuntos",
"properties" : {
"homeLoan" : {
"type" : "object",
"description" : "Resumo relacionado aos créditos à habitação",
"properties" : {
"inDebtAmount" : {
"type" : "number",
"description" : "Quantia total do crédito em dívida"
},
"nonCompliantAmount" : {
"type" : "number",
"description" : "Montante em Incumprimento"
},
"potentialAmount" : {
"type" : "number",
"description" : "Montante Potencial"
},
"numberOfProducts" : {
"type" : "integer",
"description" : "Número de produtos"
},
"productsWithGuarantee" : {
"type" : "integer",
"description" : "Número de produtos com garantia"
}
}
},
"relatedLoan" : {
"type" : "object",
"description" : "Resumo relacionado aos créditos conexos",
"properties" : {
"inDebtAmount" : {
"type" : "number",
"description" : "Quantia total do crédito em dívida"
},
"nonCompliantAmount" : {
"type" : "number",
"description" : "Montante em Incumprimento"
},
"potentialAmount" : {
"type" : "number",
"description" : "Montante Potencial"
},
"numberOfProducts" : {
"type" : "integer",
"description" : "Número de produtos"
},
"productsWithGuarantee" : {
"type" : "integer",
"description" : "Número de produtos com garantia"
}
}
},
"personalLoan" : {
"type" : "object",
"description" : "Resumo relacionado aos créditos pessoais",
"properties" : {
"inDebtAmount" : {
"type" : "number",
"description" : "Quantia total do crédito em dívida"
},
"nonCompliantAmount" : {
"type" : "number",
"description" : "Montante em Incumprimento"
},
"potentialAmount" : {
"type" : "number",
"description" : "Montante Potencial"
},
"numberOfProducts" : {
"type" : "integer",
"description" : "Número de produtos"
},
"productsWithGuarantee" : {
"type" : "integer",
"description" : "Número de produtos com garantia"
}
}
},
"financialLeasing" : {
"type" : "object",
"description" : "Resumo relacionado à locação financeira",
"properties" : {
"inDebtAmount" : {
"type" : "number",
"description" : "Quantia total do crédito em dívida"
},
"nonCompliantAmount" : {
"type" : "number",
"description" : "Montante em Incumprimento"
},
"potentialAmount" : {
"type" : "number",
"description" : "Montante Potencial"
},
"numberOfProducts" : {
"type" : "integer",
"description" : "Número de produtos"
},
"productsWithGuarantee" : {
"type" : "integer",
"description" : "Número de produtos com garantia"
}
}
},
"carLoanExcludingFinancialLeasing" : {
"type" : "object",
"description" : "Resumo relacionado aos créditos automóveis excluindo locação financeira",
"properties" : {
"inDebtAmount" : {
"type" : "number",
"description" : "Quantia total do crédito em dívida"
},
"nonCompliantAmount" : {
"type" : "number",
"description" : "Montante em Incumprimento"
},
"potentialAmount" : {
"type" : "number",
"description" : "Montante Potencial"
},
"numberOfProducts" : {
"type" : "integer",
"description" : "Número de produtos"
},
"productsWithGuarantee" : {
"type" : "integer",
"description" : "Número de produtos com garantia"
}
}
},
"otherLoans" : {
"type" : "object",
"description" : "Mapa do resumo relacionado a outros créditos",
"additionalProperties" : {
"type" : "object",
"properties" : {
"inDebtAmount" : {
"type" : "number",
"description" : "Quantia total do crédito em dívida"
},
"nonCompliantAmount" : {
"type" : "number",
"description" : "Montante em Incumprimento"
},
"potentialAmount" : {
"type" : "number",
"description" : "Montante Potencial"
},
"numberOfProducts" : {
"type" : "integer",
"description" : "Número de produtos"
},
"productsWithGuarantee" : {
"type" : "integer",
"description" : "Número de produtos com garantia"
}
}
}
},
"loanOverrun" : {
"type" : "object",
"description" : "Resumo relacionado à ultrapassagem de crédito",
"properties" : {
"inDebtAmount" : {
"type" : "number",
"description" : "Quantia total do crédito em dívida"
},
"nonCompliantAmount" : {
"type" : "number",
"description" : "Montante em Incumprimento"
},
"potentialAmount" : {
"type" : "number",
"description" : "Montante Potencial"
},
"numberOfProducts" : {
"type" : "integer",
"description" : "Número de produtos"
},
"productsWithGuarantee" : {
"type" : "integer",
"description" : "Número de produtos com garantia"
}
}
},
"overdraftFacility" : {
"type" : "object",
"description" : "Resumo relacionado à facilidade de descoberto",
"properties" : {
"inDebtAmount" : {
"type" : "number",
"description" : "Quantia total do crédito em dívida"
},
"nonCompliantAmount" : {
"type" : "number",
"description" : "Montante em Incumprimento"
},
"potentialAmount" : {
"type" : "number",
"description" : "Montante Potencial"
},
"numberOfProducts" : {
"type" : "integer",
"description" : "Número de produtos"
},
"productsWithGuarantee" : {
"type" : "integer",
"description" : "Número de produtos com garantia"
}
}
},
"creditCard" : {
"type" : "object",
"description" : "Resumo relacionado aos cartões de crédito",
"properties" : {
"inDebtAmount" : {
"type" : "number",
"description" : "Quantia total do crédito em dívida"
},
"nonCompliantAmount" : {
"type" : "number",
"description" : "Montante em Incumprimento"
},
"potentialAmount" : {
"type" : "number",
"description" : "Montante Potencial"
},
"numberOfProducts" : {
"type" : "integer",
"description" : "Número de produtos"
},
"productsWithGuarantee" : {
"type" : "integer",
"description" : "Número de produtos com garantia"
}
}
},
"creditCardWithFreeFloat" : {
"type" : "object",
"description" : "Resumo relacionado aos cartões de crédito com período de free float",
"properties" : {
"inDebtAmount" : {
"type" : "number",
"description" : "Quantia total do crédito em dívida"
},
"nonCompliantAmount" : {
"type" : "number",
"description" : "Montante em Incumprimento"
},
"potentialAmount" : {
"type" : "number",
"description" : "Montante Potencial"
},
"numberOfProducts" : {
"type" : "integer",
"description" : "Número de produtos"
},
"productsWithGuarantee" : {
"type" : "integer",
"description" : "Número de produtos com garantia"
}
}
},
"creditCardWithoutFreeFloat" : {
"type" : "object",
"description" : "Resumo relacionado aos cartões de crédito sem período de free float",
"properties" : {
"inDebtAmount" : {
"type" : "number",
"description" : "Quantia total do crédito em dívida"
},
"nonCompliantAmount" : {
"type" : "number",
"description" : "Montante em Incumprimento"
},
"potentialAmount" : {
"type" : "number",
"description" : "Montante Potencial"
},
"numberOfProducts" : {
"type" : "integer",
"description" : "Número de produtos"
},
"productsWithGuarantee" : {
"type" : "integer",
"description" : "Número de produtos com garantia"
}
}
},
"deferredDebitCard" : {
"type" : "object",
"description" : "Resumo relacionado aos cartões de débito diferido",
"properties" : {
"inDebtAmount" : {
"type" : "number",
"description" : "Quantia total do crédito em dívida"
},
"nonCompliantAmount" : {
"type" : "number",
"description" : "Montante em Incumprimento"
},
"potentialAmount" : {
"type" : "number",
"description" : "Montante Potencial"
},
"numberOfProducts" : {
"type" : "integer",
"description" : "Número de produtos"
},
"productsWithGuarantee" : {
"type" : "integer",
"description" : "Número de produtos com garantia"
}
}
},
"revolvingCredit" : {
"type" : "object",
"description" : "Resumo relacionado aos créditos renováveis",
"properties" : {
"inDebtAmount" : {
"type" : "number",
"description" : "Quantia total do crédito em dívida"
},
"nonCompliantAmount" : {
"type" : "number",
"description" : "Montante em Incumprimento"
},
"potentialAmount" : {
"type" : "number",
"description" : "Montante Potencial"
},
"numberOfProducts" : {
"type" : "integer",
"description" : "Número de produtos"
},
"productsWithGuarantee" : {
"type" : "integer",
"description" : "Número de produtos com garantia"
}
}
},
"nonRevolvingCredit" : {
"type" : "object",
"description" : "Resumo relacionado aos créditos não renováveis",
"properties" : {
"inDebtAmount" : {
"type" : "number",
"description" : "Quantia total do crédito em dívida"
},
"nonCompliantAmount" : {
"type" : "number",
"description" : "Montante em Incumprimento"
},
"potentialAmount" : {
"type" : "number",
"description" : "Montante Potencial"
},
"numberOfProducts" : {
"type" : "integer",
"description" : "Número de produtos"
},
"productsWithGuarantee" : {
"type" : "integer",
"description" : "Número de produtos com garantia"
}
}
},
"totalLoan" : {
"type" : "object",
"description" : "Lista do somatório por campo de todos os produtos financeiros",
"properties" : {
"inDebtAmount" : {
"type" : "number",
"description" : "Quantia total do crédito em dívida"
},
"nonCompliantAmount" : {
"type" : "number",
"description" : "Montante em Incumprimento"
},
"potentialAmount" : {
"type" : "number",
"description" : "Montante Potencial"
},
"numberOfProducts" : {
"type" : "integer",
"description" : "Número de produtos"
},
"productsWithGuarantee" : {
"type" : "integer",
"description" : "Número de produtos com garantia"
},
"isNonCompliantAmountFromCreditCard" : {
"type" : "boolean",
"description" : "Indica se o montante em incumprimento é proveniente de um cartão de crédito"
}
}
}
}
},
"creditResponsibilityIndividual" : {
"type" : "object",
"description" : "Resumo relacionado aos créditos individuais",
"properties" : {
"homeLoan" : {
"type" : "object",
"description" : "Resumo relacionado aos créditos à habitação",
"properties" : {
"inDebtAmount" : {
"type" : "number",
"description" : "Quantia total do crédito em dívida"
},
"nonCompliantAmount" : {
"type" : "number",
"description" : "Montante em Incumprimento"
},
"potentialAmount" : {
"type" : "number",
"description" : "Montante Potencial"
},
"numberOfProducts" : {
"type" : "integer",
"description" : "Número de produtos"
},
"productsWithGuarantee" : {
"type" : "integer",
"description" : "Número de produtos com garantia"
}
}
},
"relatedLoan" : {
"type" : "object",
"description" : "Resumo relacionado aos créditos conexos",
"properties" : {
"inDebtAmount" : {
"type" : "number",
"description" : "Quantia total do crédito em dívida"
},
"nonCompliantAmount" : {
"type" : "number",
"description" : "Montante em Incumprimento"
},
"potentialAmount" : {
"type" : "number",
"description" : "Montante Potencial"
},
"numberOfProducts" : {
"type" : "integer",
"description" : "Número de produtos"
},
"productsWithGuarantee" : {
"type" : "integer",
"description" : "Número de produtos com garantia"
}
}
},
"personalLoan" : {
"type" : "object",
"description" : "Resumo relacionado aos créditos pessoais",
"properties" : {
"inDebtAmount" : {
"type" : "number",
"description" : "Quantia total do crédito em dívida"
},
"nonCompliantAmount" : {
"type" : "number",
"description" : "Montante em Incumprimento"
},
"potentialAmount" : {
"type" : "number",
"description" : "Montante Potencial"
},
"numberOfProducts" : {
"type" : "integer",
"description" : "Número de produtos"
},
"productsWithGuarantee" : {
"type" : "integer",
"description" : "Número de produtos com garantia"
}
}
},
"financialLeasing" : {
"type" : "object",
"description" : "Resumo relacionado à locação financeira",
"properties" : {
"inDebtAmount" : {
"type" : "number",
"description" : "Quantia total do crédito em dívida"
},
"nonCompliantAmount" : {
"type" : "number",
"description" : "Montante em Incumprimento"
},
"potentialAmount" : {
"type" : "number",
"description" : "Montante Potencial"
},
"numberOfProducts" : {
"type" : "integer",
"description" : "Número de produtos"
},
"productsWithGuarantee" : {
"type" : "integer",
"description" : "Número de produtos com garantia"
}
}
},
"carLoanExcludingFinancialLeasing" : {
"type" : "object",
"description" : "Resumo relacionado aos créditos automóveis excluindo locação financeira",
"properties" : {
"inDebtAmount" : {
"type" : "number",
"description" : "Quantia total do crédito em dívida"
},
"nonCompliantAmount" : {
"type" : "number",
"description" : "Montante em Incumprimento"
},
"potentialAmount" : {
"type" : "number",
"description" : "Montante Potencial"
},
"numberOfProducts" : {
"type" : "integer",
"description" : "Número de produtos"
},
"productsWithGuarantee" : {
"type" : "integer",
"description" : "Número de produtos com garantia"
}
}
},
"otherLoans" : {
"type" : "object",
"description" : "Mapa do resumo relacionado a outros créditos",
"additionalProperties" : {
"type" : "object",
"properties" : {
"inDebtAmount" : {
"type" : "number",
"description" : "Quantia total do crédito em dívida"
},
"nonCompliantAmount" : {
"type" : "number",
"description" : "Montante em Incumprimento"
},
"potentialAmount" : {
"type" : "number",
"description" : "Montante Potencial"
},
"numberOfProducts" : {
"type" : "integer",
"description" : "Número de produtos"
},
"productsWithGuarantee" : {
"type" : "integer",
"description" : "Número de produtos com garantia"
}
}
}
},
"loanOverrun" : {
"type" : "object",
"description" : "Resumo relacionado à ultrapassagem de crédito",
"properties" : {
"inDebtAmount" : {
"type" : "number",
"description" : "Quantia total do crédito em dívida"
},
"nonCompliantAmount" : {
"type" : "number",
"description" : "Montante em Incumprimento"
},
"potentialAmount" : {
"type" : "number",
"description" : "Montante Potencial"
},
"numberOfProducts" : {
"type" : "integer",
"description" : "Número de produtos"
},
"productsWithGuarantee" : {
"type" : "integer",
"description" : "Número de produtos com garantia"
}
}
},
"overdraftFacility" : {
"type" : "object",
"description" : "Resumo relacionado à facilidade de descoberto",
"properties" : {
"inDebtAmount" : {
"type" : "number",
"description" : "Quantia total do crédito em dívida"
},
"nonCompliantAmount" : {
"type" : "number",
"description" : "Montante em Incumprimento"
},
"potentialAmount" : {
"type" : "number",
"description" : "Montante Potencial"
},
"numberOfProducts" : {
"type" : "integer",
"description" : "Número de produtos"
},
"productsWithGuarantee" : {
"type" : "integer",
"description" : "Número de produtos com garantia"
}
}
},
"creditCard" : {
"type" : "object",
"description" : "Resumo relacionado aos cartões de crédito",
"properties" : {
"inDebtAmount" : {
"type" : "number",
"description" : "Quantia total do crédito em dívida"
},
"nonCompliantAmount" : {
"type" : "number",
"description" : "Montante em Incumprimento"
},
"potentialAmount" : {
"type" : "number",
"description" : "Montante Potencial"
},
"numberOfProducts" : {
"type" : "integer",
"description" : "Número de produtos"
},
"productsWithGuarantee" : {
"type" : "integer",
"description" : "Número de produtos com garantia"
}
}
},
"creditCardWithFreeFloat" : {
"type" : "object",
"description" : "Resumo relacionado aos cartões de crédito com período de free float",
"properties" : {
"inDebtAmount" : {
"type" : "number",
"description" : "Quantia total do crédito em dívida"
},
"nonCompliantAmount" : {
"type" : "number",
"description" : "Montante em Incumprimento"
},
"potentialAmount" : {
"type" : "number",
"description" : "Montante Potencial"
},
"numberOfProducts" : {
"type" : "integer",
"description" : "Número de produtos"
},
"productsWithGuarantee" : {
"type" : "integer",
"description" : "Número de produtos com garantia"
}
}
},
"creditCardWithoutFreeFloat" : {
"type" : "object",
"description" : "Resumo relacionado aos cartões de crédito sem período de free float",
"properties" : {
"inDebtAmount" : {
"type" : "number",
"description" : "Quantia total do crédito em dívida"
},
"nonCompliantAmount" : {
"type" : "number",
"description" : "Montante em Incumprimento"
},
"potentialAmount" : {
"type" : "number",
"description" : "Montante Potencial"
},
"numberOfProducts" : {
"type" : "integer",
"description" : "Número de produtos"
},
"productsWithGuarantee" : {
"type" : "integer",
"description" : "Número de produtos com garantia"
}
}
},
"deferredDebitCard" : {
"type" : "object",
"description" : "Resumo relacionado aos cartões de débito diferido",
"properties" : {
"inDebtAmount" : {
"type" : "number",
"description" : "Quantia total do crédito em dívida"
},
"nonCompliantAmount" : {
"type" : "number",
"description" : "Montante em Incumprimento"
},
"potentialAmount" : {
"type" : "number",
"description" : "Montante Potencial"
},
"numberOfProducts" : {
"type" : "integer",
"description" : "Número de produtos"
},
"productsWithGuarantee" : {
"type" : "integer",
"description" : "Número de produtos com garantia"
}
}
},
"revolvingCredit" : {
"type" : "object",
"description" : "Resumo relacionado aos créditos renováveis",
"properties" : {
"inDebtAmount" : {
"type" : "number",
"description" : "Quantia total do crédito em dívida"
},
"nonCompliantAmount" : {
"type" : "number",
"description" : "Montante em Incumprimento"
},
"potentialAmount" : {
"type" : "number",
"description" : "Montante Potencial"
},
"numberOfProducts" : {
"type" : "integer",
"description" : "Número de produtos"
},
"productsWithGuarantee" : {
"type" : "integer",
"description" : "Número de produtos com garantia"
}
}
},
"nonRevolvingCredit" : {
"type" : "object",
"description" : "Resumo relacionado aos créditos não renováveis",
"properties" : {
"inDebtAmount" : {
"type" : "number",
"description" : "Quantia total do crédito em dívida"
},
"nonCompliantAmount" : {
"type" : "number",
"description" : "Montante em Incumprimento"
},
"potentialAmount" : {
"type" : "number",
"description" : "Montante Potencial"
},
"numberOfProducts" : {
"type" : "integer",
"description" : "Número de produtos"
},
"productsWithGuarantee" : {
"type" : "integer",
"description" : "Número de produtos com garantia"
}
}
},
"totalLoan" : {
"type" : "object",
"description" : "Lista do somatório por campo de todos os produtos financeiros",
"properties" : {
"inDebtAmount" : {
"type" : "number",
"description" : "Quantia total do crédito em dívida"
},
"nonCompliantAmount" : {
"type" : "number",
"description" : "Montante em Incumprimento"
},
"potentialAmount" : {
"type" : "number",
"description" : "Montante Potencial"
},
"numberOfProducts" : {
"type" : "integer",
"description" : "Número de produtos"
},
"productsWithGuarantee" : {
"type" : "integer",
"description" : "Número de produtos com garantia"
},
"isNonCompliantAmountFromCreditCard" : {
"type" : "boolean",
"description" : "Indica se o montante em incumprimento é proveniente de um cartão de crédito"
}
}
}
}
},
"financialInstitutionsAndProducts" : {
"type" : "object",
"description" : "Instituições financeiras e produtos financeiros",
"properties" : {
"numberOfInstitutionsReportingInformation" : {
"type" : "integer",
"description" : "Número de instituições que comunicaram informação"
},
"numberOfInstitutionsReportingNonCompliance" : {
"type" : "integer",
"description" : "Número de instituições que comunicaram incumprimentos"
},
"totalNumberOfFinancialProductsReported" : {
"type" : "integer",
"description" : "Número total de produtos financeiros comunicados"
}
}
}
}
},
"homeLoan" : {
"type" : "array",
"description" : "Lista de créditos à habitação",
"items" : {
"type" : "object",
"properties" : {
"startDate" : {
"type" : "string",
"description" : "Data de início do crédito"
},
"endDate" : {
"type" : "string",
"description" : "Data de fim do crédito"
},
"numberDebtors" : {
"type" : "integer",
"description" : "Número de devedores no contrato"
},
"totalDebt" : {
"type" : "number",
"description" : "Total da dívida"
},
"nonCompliantAmount" : {
"type" : "number",
"description" : "Valor da dívida em incumprimento"
},
"overdueAmount" : {
"type" : "number",
"description" : "Valor vencido"
},
"activeWriteOff" : {
"type" : "number",
"description" : "Valor abatido ao ativo"
},
"potentialAmount" : {
"type" : "number",
"description" : "Valor potencial"
},
"installment" : {
"type" : "number",
"description" : "Valor da prestação"
},
"guarantees" : {
"type" : "array",
"description" : "Lista de garantias associadas",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"description" : "Tipo de garantia"
},
"value" : {
"type" : "number",
"description" : "Valor da garantia"
},
"number" : {
"type" : "string",
"description" : "Número da garantia"
}
}
}
}
}
}
},
"carLoan" : {
"type" : "array",
"description" : "Lista de créditos automóveis",
"items" : {
"type" : "object",
"properties" : {
"startDate" : {
"type" : "string",
"description" : "Data de início do crédito"
},
"endDate" : {
"type" : "string",
"description" : "Data de fim do crédito"
},
"numberDebtors" : {
"type" : "integer",
"description" : "Número de devedores no contrato"
},
"totalDebt" : {
"type" : "number",
"description" : "Total da dívida"
},
"nonCompliantAmount" : {
"type" : "number",
"description" : "Valor da dívida em incumprimento"
},
"overdueAmount" : {
"type" : "number",
"description" : "Valor vencido"
},
"activeWriteOff" : {
"type" : "number",
"description" : "Valor abatido ao ativo"
},
"potentialAmount" : {
"type" : "number",
"description" : "Valor potencial"
},
"installment" : {
"type" : "number",
"description" : "Valor da prestação"
},
"guarantees" : {
"type" : "array",
"description" : "Lista de garantias associadas",
"items" : {
"type" : "object",
}
}
}
}
},
"financialLeasing" : {
"type" : "array",
"description" : "Lista de Locações Financeiras",
"items" : {
"type" : "object",
"properties" : {
"startDate" : {
"type" : "string",
"description" : "Data de início do crédito"
},
"endDate" : {
"type" : "string",
"description" : "Data de fim do crédito"
},
"numberDebtors" : {
"type" : "integer",
"description" : "Número de devedores no contrato"
},
"totalDebt" : {
"type" : "number",
"description" : "Total da dívida"
},
"nonCompliantAmount" : {
"type" : "number",
"description" : "Valor da dívida em incumprimento"
},
"overdueAmount" : {
"type" : "number",
"description" : "Valor vencido"
},
"activeWriteOff" : {
"type" : "number",
"description" : "Valor abatido ao ativo"
},
"potentialAmount" : {
"type" : "number",
"description" : "Valor potencial"
},
"installment" : {
"type" : "number",
"description" : "Valor da prestação"
},
"guarantees" : {
"type" : "array",
"description" : "Lista de garantias associadas",
"items" : {
"type" : "object",
}
}
}
}
},
"otherLoans" : {
"type" : "object",
"description" : "Lista de outros créditos",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"startDate" : {
"type" : "string",
"description" : "Data de início do crédito"
},
"endDate" : {
"type" : "string",
"description" : "Data de fim do crédito"
},
"numberDebtors" : {
"type" : "integer",
"description" : "Número de devedores no contrato"
},
"totalDebt" : {
"type" : "number",
"description" : "Total da dívida"
},
"nonCompliantAmount" : {
"type" : "number",
"description" : "Valor da dívida em incumprimento"
},
"overdueAmount" : {
"type" : "number",
"description" : "Valor vencido"
},
"activeWriteOff" : {
"type" : "number",
"description" : "Valor abatido ao ativo"
},
"potentialAmount" : {
"type" : "number",
"description" : "Valor potencial"
},
"installment" : {
"type" : "number",
"description" : "Valor da prestação"
},
"guarantees" : {
"type" : "array",
"description" : "Lista de garantias associadas",
"items" : {
"type" : "object",
}
}
}
}
}
},
"personalLoan" : {
"type" : "array",
"description" : "Lista de créditos pessoais",
"items" : {
"type" : "object",
"properties" : {
"startDate" : {
"type" : "string",
"description" : "Data de início do crédito"
},
"endDate" : {
"type" : "string",
"description" : "Data de fim do crédito"
},
"numberDebtors" : {
"type" : "integer",
"description" : "Número de devedores no contrato"
},
"totalDebt" : {
"type" : "number",
"description" : "Total da dívida"
},
"nonCompliantAmount" : {
"type" : "number",
"description" : "Valor da dívida em incumprimento"
},
"overdueAmount" : {
"type" : "number",
"description" : "Valor vencido"
},
"activeWriteOff" : {
"type" : "number",
"description" : "Valor abatido ao ativo"
},
"potentialAmount" : {
"type" : "number",
"description" : "Valor potencial"
},
"installment" : {
"type" : "number",
"description" : "Valor da prestação"
},
"guarantees" : {
"type" : "array",
"description" : "Lista de garantias associadas",
"items" : {
"type" : "object",
}
}
}
}
},
"relatedLoan" : {
"type" : "array",
"description" : "Lista de créditos conexos",
"items" : {
"type" : "object",
"properties" : {
"startDate" : {
"type" : "string",
"description" : "Data de início do crédito"
},
"endDate" : {
"type" : "string",
"description" : "Data de fim do crédito"
},
"numberDebtors" : {
"type" : "integer",
"description" : "Número de devedores no contrato"
},
"totalDebt" : {
"type" : "number",
"description" : "Total da dívida"
},
"nonCompliantAmount" : {
"type" : "number",
"description" : "Valor da dívida em incumprimento"
},
"overdueAmount" : {
"type" : "number",
"description" : "Valor vencido"
},
"activeWriteOff" : {
"type" : "number",
"description" : "Valor abatido ao ativo"
},
"potentialAmount" : {
"type" : "number",
"description" : "Valor potencial"
},
"installment" : {
"type" : "number",
"description" : "Valor da prestação"
},
"guarantees" : {
"type" : "array",
"description" : "Lista de garantias associadas",
"items" : {
"type" : "object",
}
}
}
}
}
}
}Credit Responsibility Map JSON Structure Documentation
Fields included in the JSON data representing a Credit Responsibility Map. This map reflects a person's credit commitments and liabilities, helping users understand their overall credit exposure.
Root Object
- data: Object containing the full credit responsibility information.
- file: String representing the base64 encoded PDF file of the credit responsibility map.
data Object
data ObjectGeneral Fields
- requestId: An identifier for the request that generated this report.
- withoutCreditResponsibility: Boolean indicating if the person has no credit responsibilities reported (
truemeans no credit data available).
summary Object
summary ObjectContains summarized credit information of the individual.
- nif: String — Tax Identification Number (NIF) of the individual.
- name: String — Full name of the individual.
creditResponsibilityJoint Object
creditResponsibilityJoint ObjectSummary of credit responsibilities jointly held with others.
- homeLoan: Object or
null— Summary of home loan details. - relatedLoan: Object or
null— Summary of related loans. - personalLoan: Object or
null— Summary of personal loans. - financialLeasing: Object or
null— Summary of financial leasing contracts. - carLoanExcludingFinancialLeasing: Object or
null— Summary of car loans, excluding financial leasing. - otherLoans: Object — Summary of other loan types (may be empty).
- loanOverrun: Object or
null— Summary of loan overruns (when payments exceed agreed terms). - overdraftFacility: Object or
null— Summary of overdraft facilities. - creditCard: Object or
null— Summary of credit card liabilities. - creditCardWithFreeFloat: Object or
null— Credit card balances with free float (grace period). - creditCardWithoutFreeFloat: Object or
null— Credit card balances without free float. - deferredDebitCard: Object or
null— Deferred debit card balances. - revolvingCredit: Object or
null— Revolving credit facilities summary. - nonRevolvingCredit: Object or
null— Non-revolving credit facilities summary.
Inside each loan type object (e.g., homeLoan):
homeLoan):- inDebtAmount: Number — Total amount currently owed.
- nonCompliantAmount: Number — Amount overdue or not paid according to terms.
- potentialAmount: Number — Potential additional liabilities (e.g., unused credit lines).
- numberOfProducts: Integer — Number of credit products in this category.
- productsWithGuarantee: Integer — Number of products backed by a guarantee.
Additional Field in totalLoan:
totalLoan:- isNonCompliantAmountFromCreditCard: Boolean — Indicates if the non-compliant amount is specifically from credit card debt.
creditResponsibilityIndividual Object
creditResponsibilityIndividual ObjectSummary of credit responsibilities held individually (not jointly).
- Same structure as
creditResponsibilityJointbut represents solo liabilities.
financialInstitutionsAndProducts Object (Nullable)
financialInstitutionsAndProducts Object (Nullable)- numberOfInstitutionsReportingInformation: Integer — Number of financial institutions reporting credit information.
- numberOfInstitutionsReportingNonCompliance: Integer — Number of institutions reporting overdue or non-compliant payments.
- totalNumberOfFinancialProductsReported: Integer — Total number of credit products reported.
Detailed Loan Arrays
Each loan category is an array containing individual loan details:
- homeLoan, carLoan, financialLeasing, personalLoan, relatedLoan, otherLoans: Arrays of loan objects.
- If the value does not exist, then the array will be empty instead of Null
Each loan object contains:
- startDate: String (ISO format, YYYY-MM-DD) — Loan start date.
- endDate: String (ISO format) — Loan end date or maturity date.
- numberDebtors: Integer — Number of debtors sharing this loan.
- totalDebt: Number — Total outstanding debt for this loan.
- nonCompliantAmount: Number — Amount overdue or non-compliant.
- overdueAmount: Number — Amount currently overdue.
- activeWriteOff: Number — Amount written off but still active in reporting.
- potentialAmount: Number — Potential additional liabilities or contingencies.
- installment: Number — Monthly installment amount.
guarantees Array (Nullable)
guarantees Array (Nullable)Array listing guarantees tied to the loan:
- type: String — Guarantee type code.
- value: Number — Value of the guarantee.
- number: String — Number of the guarantee.
Best Practices
- Always log the
requestId- Include it when contacting support for faster issue resolution - Use
errorCodeorerrorNamefor programmatic error handling in your application - Reference the timestamp for correlating errors with your application logs