🚧
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 ✅ Available
🚀 Production ⏳ Coming Soon
Learn more about error handling →

Environment	Status
📚 Documentation	⏳ Coming Soon
🧪 QUAL	✅ Available
🚀 Production	⏳ Coming Soon

Download Project

Watch the video

JSON Schema for API Response

Portuguese (PT)

{
  "type": "object",
  "properties": {
    "nif": {
      "type": "string",
      "description": "Número Identificação Fiscal"
    },
    "name": {
      "type": "string",
      "description": "Nome"
    },
    "cod_financas": {
      "type": "string",
      "description": "Dados do Serviço Finanças - Código"
    },
    "desc_financas": {
      "type": "string",
      "description": "Dados do Serviço Finanças - Descrição"
    },
    "act_css_iva": {
      "type": "string",
      "description": "Dados de Atividade - Data de Cessação do Imposto sobre Valor Acrescentado (IVA)"
    },
    "act_css_irs": {
      "type": "string",
      "description": "Dados de Atividade - Data de Cessação do Imposto sobre o Rendimento das Pessoas Singulares (IRS)"
    },
    "inclusion_iva": {
      "type": "string",
      "description": "Dados de Atividade - Enquadramento Imposto sobre Valor Acrescentado (IVA)"
    },
    "situation": {
      "type": "string",
      "description": "Dados de Atividade - Situação"
    },
    "activity_message": {
      "type": "string",
      "description": "Mensagem para quando não existe atividade"
    }
  }
}

English (ENG)

{
  "type": "object",
  "properties": {
    "nif": {
      "type": "string",
      "description": "Tax Identification Number (NIF)"
    },
    "name": {
      "type": "string",
      "description": "Full Name of the Entity or Individual"
    },
    "cod_financas": {
      "type": "string",
      "description": "Tax Office Code"
    },
    "desc_financas": {
      "type": "string",
      "description": "Tax Office Description"
    },
    "act_css_iva": {
      "type": "string",
      "description": "Date of VAT (Value Added Tax) Termination"
    },
    "act_css_irs": {
      "type": "string",
      "description": "Date of Income Tax Termination"
    },
    "inclusion_iva": {
      "type": "string",
      "description": "VAT (Value Added Tax) Framework Details"
    },
    "situation": {
      "type": "string",
      "description": "Current Activity Status"
    },
    "activity_message": {
      "type": "string",
      "description": "Message for Non-Activity Status"
    }
  }
}

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 →