Declarações IRS

Serviços para consulta de declarações de IRS.

IRSByCode (Imposto sobre o Rendimento das Pessoas Singulares)

serviceName: irs-by-code

Endpoint to retrieve the IRS document.

Response Example

{
  "data": {
    "requestId": "<value>"
  },
  "file": "<base64EncodedFile>"
}

IRSByUserPassword (Imposto sobre o Rendimento das Pessoas Singulares)

serviceName: irs-by-user-password

Endpoint to retrieve the IRS document.

Response Example

{
  "data": {
    "requestId": "<value>"
  },
  "file": "<base64EncodedFile>"
}

IRSByUserPassword Details (Imposto sobre o Rendimento das Pessoas Singulares)

serviceName: irs-by-user-password-details

Endpoint to retrieve information from the IRS Mod3 document.

Request Example

{
  "serviceName": "irs-by-user-password-details",
  "region": {
    "countryPortal": "pt",
    "jurisdictionCode": "pt"
  },
  "payload": {
    "serviceRequestBody": {
      "user": "test",
      "password": "failedtoauthenticate",
      "year": "2022"
    }
  }
}

Response Example

{
  "message": "Impossible to obtain the request data for the year <year>"
}