SCR

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "document": {
      "type": "string",
      "pattern": "^(?:\\d{11}|\\d{3}\\.\\d{3}\\.\\d{3}-\\d{2}|[0-9A-Za-z]{12}\\d{2}|[0-9A-Za-z]{2}\\.[0-9A-Za-z]{3}\\.[0-9A-Za-z]{3}\\/[0-9A-Za-z]{4}-\\d{2})$",
      "description": "CPF ou CNPJ completo, com ou sem pontuação.",
      "title": "CPF ou CNPJ"
    }
  },
  "required": [
    "document"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "document": "00000000000191"
    }
  ]
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "object": {
      "type": "string",
      "const": "scr_report",
      "description": "Crédito em bancos informado no SCR."
    },
    "document": {
      "type": "string",
      "minLength": 1,
      "description": "CPF ou CNPJ informado pela fonte; pode estar mascarado."
    },
    "institutions": {
      "description": "Quantidade de instituições.",
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "operations": {
      "description": "Quantidade de operações.",
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "relationships": {
      "type": "string",
      "description": "Informação de relacionamentos bancários fornecida na consulta."
    },
    "volume": {
      "type": "string",
      "description": "Volume informado na consulta; preserve a unidade fornecida."
    },
    "status": {
      "type": "string",
      "description": "Situação da consulta informada pela fonte."
    },
    "profile": {
      "type": "string",
      "description": "Perfil de crédito bancário informado pela fonte."
    },
    "score": {
      "type": "string",
      "description": "Pontuação informada na consulta; não representa aprovação de crédito."
    },
    "risk_class": {
      "type": "string",
      "description": "Classe de risco informada pela fonte."
    },
    "portfolio": {
      "type": "object",
      "properties": {
        "to_mature": {
          "type": "string",
          "pattern": "^-?\\d+(?:\\.\\d+)?$",
          "description": "Carteira a vencer em reais, como texto decimal."
        },
        "overdue": {
          "type": "string",
          "pattern": "^-?\\d+(?:\\.\\d+)?$",
          "description": "Carteira vencida em reais, como texto decimal."
        }
      },
      "additionalProperties": false,
      "description": "Saldos da carteira de crédito."
    },
    "indices": {
      "description": "Indicadores por modalidade; valores conforme informados.",
      "type": "object",
      "properties": {
        "total": {
          "type": "string",
          "description": "Índice total informado."
        },
        "credit_card": {
          "type": "string",
          "description": "Índice de cartão de crédito informado."
        },
        "personal_credit": {
          "type": "string",
          "description": "Índice de crédito pessoal informado."
        },
        "overdraft": {
          "type": "string",
          "description": "Índice de cheque especial informado."
        }
      },
      "additionalProperties": false
    },
    "category_percentages": {
      "description": "Distribuição da carteira por categoria, conforme informada.",
      "type": "object",
      "properties": {
        "highest_risk_line": {
          "type": "string",
          "description": "Linha de maior risco informada."
        },
        "credit_card": {
          "type": "string",
          "description": "Percentual de cartão de crédito informado."
        },
        "financing": {
          "type": "string",
          "description": "Percentual de financiamentos informado."
        },
        "loans": {
          "type": "string",
          "description": "Percentual de empréstimos informado."
        },
        "export_financing": {
          "type": "string",
          "description": "Percentual de financiamentos à exportação informado."
        },
        "real_estate_financing": {
          "type": "string",
          "description": "Percentual de financiamentos imobiliários informado."
        },
        "vehicle_financing": {
          "type": "string",
          "description": "Percentual de financiamentos de veículos informado."
        },
        "deposit_advances": {
          "type": "string",
          "description": "Percentual de adiantamentos a depositantes informado."
        },
        "leases": {
          "type": "string",
          "description": "Percentual de arrendamento informado."
        },
        "coobligations": {
          "type": "string",
          "description": "Percentual de coobrigações informado."
        },
        "other_credit": {
          "type": "string",
          "description": "Percentual de outros créditos informado."
        },
        "other": {
          "type": "string",
          "description": "Percentual das demais categorias informado."
        }
      },
      "additionalProperties": false
    },
    "overdue_percentages": {
      "description": "Distribuição dos vencidos por categoria, conforme informada.",
      "type": "object",
      "properties": {
        "credit_card": {
          "type": "string",
          "description": "Percentual vencido em cartão de crédito informado."
        },
        "loans": {
          "type": "string",
          "description": "Percentual vencido em empréstimos informado."
        },
        "financing": {
          "type": "string",
          "description": "Percentual vencido em financiamentos informado."
        },
        "real_estate_financing": {
          "type": "string",
          "description": "Percentual vencido em financiamentos imobiliários informado."
        },
        "vehicle_financing": {
          "type": "string",
          "description": "Percentual vencido em financiamentos de veículos informado."
        },
        "deposit_advances": {
          "type": "string",
          "description": "Percentual vencido em adiantamentos a depositantes informado."
        }
      },
      "additionalProperties": false
    },
    "maturity_percentages": {
      "description": "Distribuição por prazo, conforme informada.",
      "type": "object",
      "properties": {
        "short_term": {
          "type": "string",
          "description": "Percentual de curto prazo informado."
        },
        "medium_term": {
          "type": "string",
          "description": "Percentual de médio prazo informado."
        },
        "long_term": {
          "type": "string",
          "description": "Percentual de longo prazo informado."
        }
      },
      "additionalProperties": false
    },
    "commitment_evolution": {
      "description": "Evolução do compromisso por modalidade, conforme informada.",
      "type": "object",
      "properties": {
        "total": {
          "type": "string",
          "description": "Evolução do compromisso total informada."
        },
        "highest_risk": {
          "type": "string",
          "description": "Evolução do compromisso de maior risco informada."
        },
        "financing": {
          "type": "string",
          "description": "Evolução do compromisso de financiamentos informada."
        },
        "credit_card": {
          "type": "string",
          "description": "Evolução do compromisso de cartão de crédito informada."
        }
      },
      "additionalProperties": false
    }
  },
  "required": [
    "object",
    "document",
    "portfolio"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "object": "scr_report",
      "document": "00000000000191",
      "institutions": 9,
      "operations": 192,
      "status": "sucesso",
      "portfolio": {
        "to_mature": "121075284.3",
        "overdue": "0"
      }
    }
  ]
}