🚧
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

{  
  "type": "object",  
  "properties": {  
    "requestId": {  
      "type": "string",  
      "description": "Identificador único do pedido."  
    },  
    "nif": {  
      "type": "string",  
      "description": "Número de Identificação Fiscal (NIF)."  
    },  
    "name": {  
      "type": "string",  
      "description": "Nome do proprietário ou responsável pelo veículo."  
    },  
    "licensePlate": {  
      "type": "string",  
      "description": "Matrícula do veículo."  
    },  
    "licensePlateIssueDate": {  
      "type": "string",  
      "description": "Data de emissão da matrícula."  
    },  
    "firstRegistrationDate": {  
      "type": "string",  
      "description": "Data da primeira matrícula do veículo."  
    },  
    "brand": {  
      "type": "string",  
      "description": "Marca do veículo."  
    },  
    "model": {  
      "type": "string",  
      "description": "Modelo do veículo."  
    },  
    "color": {  
      "type": "string",  
      "description": "Cor do veículo."  
    },  
    "category": {  
      "type": "string",  
      "description": "Categoria do veículo, como definido pela autoridade competente."  
    },  
    "seatingCapacity": {  
      "type": "string",  
      "description": "Capacidade de lotação do veículo (número de assentos)."  
    },  
    "vehicleType": {  
      "type": "string",  
      "description": "Tipo de veículo."  
    },  
    "fuelType": {  
      "type": "string",  
      "description": "Tipo de combustível utilizado pelo veículo."  
    },  
    "squareNumber": {  
      "type": "string",  
      "description": "Número do quadro do veículo."  
    },  
    "cylinderCapacity": {  
      "type": "string",  
      "description": "Cilindrada do motor."  
    },  
    "power": {  
      "type": "string",  
      "description": "Potência do motor."  
    },  
    "voltage": {  
      "type": "string",  
      "description": "Voltagem do sistema elétrico do veículo."  
    },  
    "grossWeight": {  
      "type": "string",  
      "description": "Peso bruto do veículo."  
    },  
    "towableGrossWeight": {  
      "type": "string",  
      "description": "Peso bruto rebocável permitido pelo veículo."  
    },  
    "co2Emission": {  
      "type": "string",  
      "description": "Emissão de CO2 do veículo."  
    },  
    "co2calculationMethod": {  
      "type": "string",  
      "description": "Método utilizado para calcular as emissões de CO2."  
    },  
    "wankleEngine": {  
      "type": "string",  
      "description": "Indicação se o motor do veículo é do tipo Wankel."  
    }  
  }  
}

English

{
  "type": "object",
  "properties": {
    "requestId": {
      "type": "string",
      "description": "Unique identifier for the request."
    },
    "nif": {
      "type": "string",
      "description": "Tax Identification Number (NIF)."
    },
    "name": {
      "type": "string",
      "description": "Name of the vehicle owner or responsible party."
    },
    "licensePlate": {
      "type": "string",
      "description": "Vehicle license plate."
    },
    "licensePlateIssueDate": {
      "type": "string",
      "description": "Date of issuance of the license plate."
    },
    "firstRegistrationDate": {
      "type": "string",
      "description": "Date of the vehicle's first registration."
    },
    "brand": {
      "type": "string",
      "description": "Brand of the vehicle."
    },
    "model": {
      "type": "string",
      "description": "Model of the vehicle."
    },
    "color": {
      "type": "string",
      "description": "Color of the vehicle."
    },
    "category": {
      "type": "string",
      "description": "Category of the vehicle as defined by the relevant authority."
    },
    "seatingCapacity": {
      "type": "string",
      "description": "Seating capacity of the vehicle (number of seats)."
    },
    "vehicleType": {
      "type": "string",
      "description": "Type of vehicle."
    },
    "fuelType": {
      "type": "string",
      "description": "Type of fuel used by the vehicle."
    },
    "squareNumber": {
      "type": "string",
      "description": "Frame number of the vehicle."
    },
    "cylinderCapacity": {
      "type": "string",
      "description": "Engine displacement."
    },
    "power": {
      "type": "string",
      "description": "Power of the engine."
    },
    "voltage": {
      "type": "string",
      "description": "Voltage of the vehicle's electrical system."
    },
    "grossWeight": {
      "type": "string",
      "description": "Gross weight of the vehicle."
    },
    "towableGrossWeight": {
      "type": "string",
      "description": "Maximum towable gross weight of the vehicle."
    },
    "co2Emission": {
      "type": "string",
      "description": "CO2 emission of the vehicle."
    },
    "co2calculationMethod": {
      "type": "string",
      "description": "Method used to calculate CO2 emissions."
    },
    "wankleEngine": {
      "type": "string",
      "description": "Indicates whether the vehicle's engine is of the Wankel type."
    }
  }
}

Error Handling

Enhanced Error Responses

Starting with bizAPIs 3.0, all error responses include structured metadata with bizAPIs-specific status codes to streamline debugging and support.

Response Format

Before (Legacy):

{
  "message": "Document not found"
}

Now (bizAPIs 3.0):

{
  "requestId": "9e12f4b8-7d4f-4a9f-b832-5c614e86d5aa",
  "errorCode": 4099,
  "errorName": "DOCUMENT_NOT_FOUND",
  "fullStatusCode": "4099.0008.0002",
  "timestamp": "2025-08-13T16:37:53.037939200Z",
  "message": "Document not found"
}

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 →