🚧
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 →

JSON Schema API Response

{
  "type" : "object",
  "properties" : {
    "requestId" : {
      "type" : "string"
    },
    "success" : {
      "type" : "boolean",
      "description" : "Indica se a requisição foi bem-sucedida"
    },
    "totalCount" : {
      "type" : "integer",
      "description" : "Número total de marcas encontradas"
    },
    "trademarkItems" : {
      "type" : "array",
      "description" : "Lista de marcas registradas",
      "items" : {
        "type" : "object",
        "properties" : {
          "trademarkType" : {
            "type" : "string",
            "description" : "Tipo de marca (marca nacional, nome do estabelecimento, logotipo, marca de registo internacional)"
          },
          "applicationNumber" : {
            "type" : "string",
            "description" : "Número do processo"
          },
          "trademarkName" : {
            "type" : "string",
            "description" : "Nome da marca"
          },
          "owner" : {
            "type" : "string",
            "description" : "Nome do titular da marca"
          },
          "visualType" : {
            "type" : "string",
            "description" : "Tipo de sinal (verbal, misto, figurativo)"
          }
        }
      }
    },
    "info" : {
      "type" : "string",
      "description" : "Mensagem informativa sobre a resposta. Contém uma mensagem quando o pedido foi bem-sucedido mas não devolveu dados. Nulo quando os dados estão presentes."
    }
  }
}

{
  "type" : "object",
  "properties" : {
    "requestId" : {
      "type" : "string"
    },
    "success" : {
      "type" : "boolean",
      "description" : "Indicates whether the request was successful"
    },
    "totalCount" : {
      "type" : "integer",
      "description" : "Total number of trademarks found"
    },
    "trademarkItems" : {
      "type" : "array",
      "description" : "List of registered trademarks",
      "items" : {
        "type" : "object",
        "properties" : {
          "trademarkType" : {
            "type" : "string",
            "description" : "Type of trademark (national trademark, establishment name, logo, international registration trademark)"
          },
          "applicationNumber" : {
            "type" : "string",
            "description" : "Application number"
          },
          "trademarkName" : {
            "type" : "string",
            "description" : "Trademark name"
          },
          "owner" : {
            "type" : "string",
            "description" : "Name of the trademark owner"
          },
          "visualType" : {
            "type" : "string",
            "description" : "Type of sign (word, combined, figurative)"
          }
        }
      }
    },
    "info" : {
      "type" : "string",
      "description" : "Informational message about the response. Contains a message when the request was successful but returned no data. Null when data is present."
    }
  }
}

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 →