BoaVista

{
  "$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": {
    "document": {
      "type": "string",
      "minLength": 1,
      "description": "CPF ou CNPJ informado pela fonte; pode estar mascarado."
    },
    "name": {
      "type": "string",
      "description": "Nome ou razão social informado pela fonte."
    },
    "score": {
      "description": "Pontuação de crédito informada pela fonte; não representa aprovação.",
      "type": "number",
      "minimum": 0
    },
    "default_rate": {
      "description": "Taxa de inadimplência informada pela fonte.",
      "type": [
        "string",
        "number"
      ]
    },
    "message": {
      "type": "string",
      "description": "Mensagem descritiva da pontuação de crédito."
    },
    "negative_records": {
      "description": "Resumos dos registros negativos informados.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "description": "Categoria dos registros negativos."
          },
          "count": {
            "description": "Quantidade de ocorrências informada.",
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          },
          "amount": {
            "type": "string",
            "pattern": "^-?\\d+(?:\\.\\d+)?$",
            "description": "Montante em reais, como texto decimal, preservando a precisão informada."
          },
          "status": {
            "type": "string",
            "description": "Situação informada pela fonte."
          }
        },
        "required": [
          "type"
        ],
        "additionalProperties": false
      }
    },
    "object": {
      "type": "string",
      "const": "boavista_report",
      "description": "Tipo do objeto: relatório BoaVista."
    }
  },
  "required": [
    "document",
    "object"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "document": "00000000000191",
      "name": "Exemplo anonimizado",
      "score": 704,
      "default_rate": "6,0%",
      "message": "DE CADA 100 EMPRESAS CLASSIFICADAS NESTA CLASSE DE SCORE, E PROVAVEL QUE 6 APRESENTEM DEBITOS NO MERCADO NOS PROXIMOS 12 MESES.",
      "negative_records": [
        {
          "type": "pendencias_financeiras",
          "count": 0
        },
        {
          "type": "protestos",
          "count": 1,
          "amount": "150.00"
        },
        {
          "type": "cheques_sem_fundo_bacen",
          "count": 0
        }
      ],
      "object": "boavista_report"
    }
  ]
}