IRSByUserPassword (Imposto sobre o Rendimento das Pessoas Singulares)

Endpoint to retrieve the IRS document.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

🚧

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

EnvironmentStatus
📚 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": {
    "data": {
      "type": "object",
      "properties": {
        "requestId": {
          "type": "string",
          "description": "Identificador único do pedido"
        }
      }
    },
    "file": {
      "type": "string",
      "description": "Ficheiro PDF em base 64"
    }
  }
}

English (ENG)

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "requestId": {
          "type": "string",
          "description": "Unique request identifier"
        }
      }
    },
    "file": {
      "type": "string",
      "description": "Encoded base 64 file."
    }
  }
}

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 →

Body Params
string
Defaults to test

Taxpayer number

string
Defaults to test

Access password

string
Defaults to 2022

The "year" field is limited to the last 2 tax years, with the current year being available only if the request is made after June 30th.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain