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

⚠️
Important Notice
The option to receive the pdf document associated with the extracted information is only available for licenses that include access to this file.
If you wish to enable this feature in your plan, please contact our sales team for further details and subscription options.

JSON Schema for API Response

{
  "type" : "object",
  "properties" : {
    "message" : {
      "type" : "string",
      "description" : "A human-readable message providing additional information about the response, such as error details or informative status updates"
    },
    "data" : {
      "type" : "object",
      "properties" : {
        "requestId" : {
          "type" : "string",
          "description" : "Unique identifier for the request"
        },
        "paymentDoc" : {
          "type" : "object",
          "description" : "IVA payment document",
          "properties" : {
            "name" : {
              "type" : "string",
              "description" : "Name of the passive subject"
            },
            "address" : {
              "type" : "string",
              "description" : "Address of the passive subject"
            },
            "city" : {
              "type" : "string",
              "description" : "City of the passive subject"
            },
            "postalCode" : {
              "type" : "string",
              "description" : "Postal Code of the passive subject"
            },
            "nif" : {
              "type" : "string",
              "description" : "Fiscal Identification"
            },
            "period" : {
              "type" : "string",
              "description" : "Period of the document"
            },
            "declarationId" : {
              "type" : "string",
              "description" : "Unique identifier for the declaration"
            },
            "declarationDateTime" : {
              "type" : "string",
              "description" : "Date and Time of Declaration"
            },
            "paymentReference" : {
              "type" : "string",
              "description" : "Payment reference associated with the payment document"
            },
            "opticalLine" : {
              "type" : "string",
              "description" : "Optical Line"
            },
            "amount" : {
              "type" : "number",
              "description" : "Amount to Pay"
            }
          }
        }
      }
    },
    "file" : {
      "type" : "string",
      "description" : "A single file encoded as a Base64 string. Used when a file is included in the response."
    }
  }
}

{
  "type" : "object",
  "properties" : {
    "message" : {
      "type" : "string",
      "description" : "Mensagem legível para humanos que fornece informações adicionais sobre a resposta, como detalhes de erro ou atualizações informativas de estado"
    },
    "data" : {
      "type" : "object",
      "properties" : {
        "requestId" : {
          "type" : "string",
          "description" : "Identificador único do pedido"
        },
        "paymentDoc" : {
          "type" : "object",
          "description" : "Documento de pagamento de IVA",
          "properties" : {
            "name" : {
              "type" : "string",
              "description" : "Nome do sujeito passivo"
            },
            "address" : {
              "type" : "string",
              "description" : "Morada do sujeito passivo"
            },
            "city" : {
              "type" : "string",
              "description" : "Cidade do sujeito passivo"
            },
            "postalCode" : {
              "type" : "string",
              "description" : "Código postal do sujeito passivo"
            },
            "nif" : {
              "type" : "string",
              "description" : "Identificação fiscal"
            },
            "period" : {
              "type" : "string",
              "description" : "Período do documento"
            },
            "declarationId" : {
              "type" : "string",
              "description" : "Identificador único da declaração"
            },
            "declarationDateTime" : {
              "type" : "string",
              "description" : "Data e hora da declaração"
            },
            "paymentReference" : {
              "type" : "string",
              "description" : "Referência de pagamento associada ao documento de pagamento"
            },
            "opticalLine" : {
              "type" : "string",
              "description" : "Linha ótica"
            },
            "amount" : {
              "type" : "number",
              "description" : "Montante a pagar"
            }
          }
        }
      }
    },
    "file" : {
      "type" : "string",
      "description" : "Ficheiro único codificado como uma string Base64. Utilizado quando um ficheiro está incluído na resposta."
    }
  }

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 →