🚧
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

Watch the video

JSON Schema API Response

Portuguese (PT)

{
  "type" : "object",
  "properties" : {
    "RequestId" : {
      "type" : "string",
      "description" : "Identificador único do pedido."
    },
    "NIF" : {
      "type" : "string",
      "description" : "Número de Identificação Fiscal (NIF) da entidade ou do indivíduo."
    },
    "Name" : {
      "type" : "string",
      "description" : "Nome completo da entidade ou do indivíduo."
    },
    "Last update" : {
      "type" : "string",
      "description" : "Data e hora da última atualização do registo (formato: YYYY-MM-DD)."
    },
    "TierValueGreaterThan" : {
      "type" : "integer",
      "description" : "Valor mínimo para filtrar os registos. Apenas registos com um valor superior a este número serão incluídos."
    },
    "TierValueLessThan" : {
      "type" : "integer",
      "description" : "Valor máximo para filtrar os registos. Apenas registos com um valor inferior a este número serão incluídos."
    }
  }
}

English (ENG)

{
  "type": "object",
  "properties": {
    "RequestId": {
      "type": "string",
      "description": "A unique identifier for the request."
    },
    "NIF": {
      "type": "string",
      "description": "The Tax Identification Number (NIF) of the entity or individual."
    },
    "Name": {
      "type": "string",
      "description": "The full name of the entity or individual."
    },
    "Last update": {
      "type": "string",
      "description": "The date and time when the record was last updated (format: DD/MM/YYYY)."
    },
    "TierValueGreaterThan": {
      "type": "integer",
      "description": "The minimum tier value for filtering records. Only records with a tier value greater than this number will be included."
    },
    "TierValueLessThan": {
      "type": "integer",
      "description": "The maximum tier value for filtering records. Only records with a tier value less than this number will be included."
    }
  }
}

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 →