ITR OTP Get Request ID
This API facilitates patrons in obtaining Income Tax Return (ITR) forms in JSON and PDF formats by providing essential details such as PAN (Permanent Account Number) or username. In order to authorize, either OTP or password can be used to get the past three years' data. It is designed to efficiently retrieve the necessary information, catering to the needs of patrons who require both formats for their users.
The Get Requset ID API gives the information on whethet OTP is supported for the given userName. And caters to both OTP and Password Flow depending on the user's choice. However, if userName supports only password then OTP would not be a viable option to continue in the process.
This API consists of three main endpoints:
- requestId
- authorisation
- getitrform
This endpoint is used to initiate a request for an ITR form by providing a userName. Returns a requestId that patrons can use to fetch the ITR form.
Parameter | Type | Description | Mandatory/Optional |
userName | string | The username of the end-customer on the ITR Portal. It usually is the PAN of the user. | Mandatory |
Parameter | Type | Description |
requestId | string | A unique identifier (UUID) assigned to the request. This requestId is generated and returned by the API. |
userName | string | The userName entered. |
panStatus | string | Determines whether the pan is registered with the ITR Portal |
userFlow | string | The userFlow lets the user know the available flows for the given userName. It can be 'otp and password' or 'password' |
statusCode | integer | The HTTP status code indicating the success or failure of the API request. In this case, the statusCode of 200 denotes a successful response. |
messageCode | string | A code or identifier associated with the message. In this instance, the messageCode "Request successfully submitted and OTP has been generated" provides additional context about the success of the requestId generation. |
CODE | MESSAGE |
200 | Request successful |
409 | Unable to fetch data from upstream |
400 | Bad Request - Mandatory parameters missing or Invalid userName |