🚧
What's New in bizAPIs 3.0
Enhanced 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, and errorName to help you quickly identify and resolve issues.
Availability by Environment
Environment Status
📚 Documentation ⏳ Coming Soon
🧪 QUAL ⏳ Coming Soon
🚀 Production ⏳ Coming Soon
Learn more about error handling →

Download Project

DOWNLOAD PROJECT

To watch the video click here

JSON Schema API Response

Portuguese

{
  "type" : "object",
  "properties" : {
    "requestId" : {
      "type" : "string",
      "description" : "Identificador único do pedido."
    },
    "alerts" : {
      "type" : "array",
      "description" : "Lista de alertas emitidos pela Autoridade Tributária. Pode incluir prazos de pagamento, avisos de irregularidades ou necessidade de submissão de declarações.",
      "items" : {
        "type" : "object",
        "properties" : {
          "descriptionName" : {
            "type" : "string",
            "description" : "O nome ou categoria do alerta."
          },
          "description" : {
            "type" : "string",
            "description" : "Uma explicação detalhada sobre o alerta."
          },
          "limitDate" : {
            "type" : "string",
            "description" : "O prazo ou data em que a ação associada ao alerta deve ser concluída, no formato 'YYYY-MM-DD'."
          }
        }
      }
    }
  }
}

English

{
  "type": "object",
  "properties": {
    "requestId": {
      "type": "string",
      "description": "Unique identifier for the request."
    },
    "alerts": {
      "type": "array",
      "description": "List of alerts issued by the Tax Authority. This may include payment deadlines, notices of irregularities, or the need for declaration submissions.",
      "items": {
        "type": "object",
        "properties": {
          "descriptionName": {
            "type": "string",
            "description": "The name or category of the alert."
          },
          "description": {
            "type": "string",
            "description": "A detailed explanation about the alert."
          },
          "limitDate": {
            "type": "string",
            "description": "The deadline or date by which the action associated with the alert must be completed, in the format 'YYYY-MM-DD'."
          }
        }
      }
    }
  }
}

Best Practices

Always log the requestId - Include it when contacting support for faster issue resolution
Use errorCode or errorName for programmatic error handling in your application
Reference the timestamp for correlating errors with your application logs

📖 View complete error codes reference →