ITR Form Get Request ID

Introduction:

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) and passwords for the past three years. It is designed to efficiently retrieve the necessary information, catering to the needs of patrons who require both formats for their users. One distinctive feature of this API is the utilization of a callback mechanism. When patrons initiate a request using the GET /get-request-id endpoint, they can include a callback_url parameter. This parameter represents a URL where the API will send a POST request upon completion of the request processing.

Endpoints:

This API consists of two main endpoints:

get-request-id

get-itr-form

POST /get-request-id

This endpoint is used to initiate a request for an ITR form by providing essential details. Returns a requestId that patrons can use to fetch the ITR form.

Sample Curl:

curl --location 'https://api-preproduction.signzy.app/api/v3/itr/get-request-id' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: <Auth Token>' \
--data-raw '{
"username": "*******",
"password": "*********",
"range": 3,
"callbackUrl": "https://example.com/",
"pdfBase64": false
}'

Input Parameters:

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
password	string	Password for the ITR portal of the PAN holder	Conditional Mandatory
sessionId	string	This is the same id provided in the response of other ITR APIs and allows to fetch data without the need to explicitly login. Either password or sessionId can be passed.	Conditional Mandatory
range	number	The number of years for which data is being requested	Optional
callbackUrl	string	URL where the API will send a POST request upon completion of the request processing.	Optional
pdfBase64	Boolean	Flag to get base64 version of itr pdf	Optional

Sample Response:

{
    "requestId": sample requestId,
    "callbackUrl": "https://example.com/",
    "statusCode": 200,
    "messageCode": "Successfully Generated RequestId"
}

Output Parameters:

Parameter	Type	Description
requestId	string	A unique identifier (UUID) assigned to the request. This requestId is generated and returned by the API.
callbackUrl	string	The URL to which the API will send a callback or POST request upon completion of the request processing. It allows patrons to receive notifications or trigger further actions based on the status of their requests.
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"Successfully Generated RequestId" provides additional context about the success of the requestId generation.

Status codes

CODE	MESSAGE
200	Request successful
409	Upstream is down
422	Unauthorized - Wrong user ID or password, cannot login
400	Bad Request - Mandatory parameters missing