🚧
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."  
    },  
    "atpiList" : {  
      "type" : "array",  
      "description" : "Informações consolidadas sobre a posição integrada do contribuinte na Autoridade Tributária.",  
      "items" : {  
        "type" : "object",  
        "properties" : {  
          "title" : {  
            "type" : "string",  
            "description" : "O título que representa o item fiscal específico."  
          },  
          "status" : {  
            "type" : "string",  
            "description" : "O estado atual do item. 'Verde' significa 'cumprimento', 'Amarelo' significa 'em progresso' e 'Vermelho' significa 'incumprimento'."  
          }  
        }  
      }
    }
  }
}

English

{
  "type": "object",
  "properties": {
    "RequestId": {
      "type": "string",
      "description": "Unique identifier for the request."
    },
    "atpiList": {
      "type": "array",
      "description": "Consolidated information about the taxpayer's integrated position with the Tax Authority.",
      "items": {
        "type": "object",
        "properties": {
          "title": {
            "type": "string",
            "description": "The title that represents the specific tax item."
          },
          "status": {
            "type": "string",
            "description": "The current state of the item. 'Green' means 'compliance', 'Yellow' means 'in progress', and 'Red' means 'non-compliance'."
          }
        }
      }
    }
  }
}

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 →