ITR OTP Get ITR Pull

Introduction:

This API allows patrons to request income tax returns filing(ITRs) for their users. This can be done by either authorizing with the OTP or the Password depending on the support provided by the PAN. The response will contain the required ITRs in the specified format.

POST /itr/get-itr-pull

This endpoint is used to retrieve the ITR details

Sample Curl:

curl --location 'https://api-preproduction.signzy.app/api/v3/itr/get-itr-pull' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: <Auth Token>' \
--data-raw '{
    "requestId": output of the requestId
}'

Input Parameters:

Parameter	Type	Description	Mandatory/Optional
requestId	string	A unique identifier (UUID) is generated by the requestId API. The requestId serves as a reference for the initiated request and can be used for fetching the corresponding ITR details.	Mandatory
range	number	The number of years for which the data must be given for. Minimum is 1 and maximum is 3. Default is 3	Optional

Sample Response:

{
  "requestId": "7deb646e-9892-419a-96dc-7cd6260507bc",
  "panNumber": "DUMMY1234A",
  "result": {
    "2022-2023": [
      {
        "panNumber": "DUMMY1234A",
        "filingYear": "2022-2023",
        "filingDate": "01/07/2023",
        "filedBy": "SLF",
        "filingSection": "130(1)",
        "itrType": "1",
        "itrFilingStatus": [
            {
                "statusDescription": "dummy status 1 ",
                "activityDate": "02/07/2023"
            },
            {
                "statusDescription": "dummy status 2",
                "activityDate": "01/07/2023"
            }
        ],
        "acknowledgementNumber": "462158851291023",
        "filingType": "Original",
        "ITR": {
          "ITR1": {
            "CreationInfo": {
              "SWVersionNo": "R1",
              "SWCreatedBy": "SW12345678",
              "JSONCreatedBy": "SW12345678",
              "JSONCreationDate": "2023-08-15",
              "Digest": "DummyDigest123456789",
              "IntermediaryCity": "DummyCity"
            },
            "Form_ITR1": {
              "FormName": "ITR-1",
              "Description": "For Individuals having Income from Salary, Pension, family pension and Interest",
              "AssessmentYear": "2023",
              "SchemaVer": "Ver1.0",
              "FormVer": "Ver1.0"
            },
            "PersonalInfo": {
              "AssesseeName": {
                "FirstName": "John",
                "MiddleName": "Doe",
                "SurNameOrOrgName": "Smith"
              },
              "Address": {
                "ResidenceNo": "1234, Main Street",
                "ResidenceName": "Residence Name",
                "RoadOrStreet": "Main Road",
                "LocalityOrArea": "City Center",
                "CityOrTownOrDistrict": "Metropolis",
                "StateCode": "23",
                "CountryCode": "91",
                "PinCode": 123456,
                "CountryCodeMobile": 91,
                "MobileNo": 9876543210,
                "EmailAddress": "[email protected]"
              },
              "PAN": "ABCDE1234F",
              "DOB": "1985-05-20",
              "EmployerCategory": "OTH",
              "AadhaarCardNo": "123456789012"
            },
            "FilingStatus": {
              "ReturnFileSec": 11,
              "NewTaxRegime": "N",
              "SeventhProvisio139": "N",
              "IncrExpAggAmt2LkTrvFrgnCntryFlg": "N",
              "IncrExpAggAmt1LkElctrctyPrYrFlg": "N",
              "clauseiv7provisio139i": "N"
            },
            "ITR1_IncomeDeductions": {
              "AllwncExemptUs10": {
                "TotalAllwncExemptUs10": 0
              },
              "OthersInc": {
                "OthersIncDtlsOthSrc": [
                  {
                    "OthSrcNatureDesc": "TAX",
                    "OthSrcOthAmount": 0
                  },
                  {
                    "OthSrcNatureDesc": "IFD",
                    "OthSrcOthAmount": 272
                  },
                  {
                    "DividendInc": {
                      "DateRange": {
                        "Upto15Of6": 20,
                        "Upto15Of9": 0,
                        "Up16Of9To15Of12": 0,
                        "Up16Of12To15Of3": 0,
                        "Up16Of3To31Of3": 0
                      }
                    },
                    "OthSrcNatureDesc": "DIV",
                    "OthSrcOthAmount": 20
                  },
                  {
                    "OthSrcNatureDesc": "SAV",
                    "OthSrcOthAmount": 347
                  }
                ]
              },
              "UsrDeductUndChapVIA": {
                "Section80C": 7832,
                "Section80CCC": 0,
                "Section80CCDEmployeeOrSE": 0,
                "Section80CCD1B": 0,
                "Section80CCDEmployer": 0,
                "Section80D": 0,
                "Section80DD": 0,
                "Section80DDB": 0,
                "Section80E": 0,
                "Section80EE": 0,
                "Section80GG": 0,
                "Section80GGA": 0,
                "Section80GGC": 0,
                "Section80U": 0,
                "Section80TTA": 347,
                "Section80TTB": 0,
                "TotalChapVIADeductions": 8179,
                "Section80G": 0
              },
              "DeductUndChapVIA": {
                "Section80C": 7832,
                "Section80CCC": 0,
                "Section80CCDEmployeeOrSE": 0,
                "Section80CCD1B": 0,
                "Section80CCDEmployer": 0,
                "Section80D": 0,
                "Section80DD": 0,
                "Section80DDB": 0,
                "Section80E": 0,
                "Section80EE": 0,
                "Section80EEA": 0,
                "Section80EEB": 0,
                "Section80G": 0,
                "Section80GG": 0,
                "Section80GGA": 0,
                "Section80GGC": 0,
                "Section80U": 0,
                "Section80TTA": 347,
                "Section80TTB": 0,
                "AnyOthSec80CCH": 0,
                "TotalChapVIADeductions": 8179
              },
              "ExemptIncAgriOthUs10": {
                "ExemptIncAgriOthUs10Total": 0
              },
              "GrossSalary": 341500,
              "Salary": 341500,
              "IncomeNotified89A": 0,
              "NetSalary": 341500,
              "DeductionUs16": 50000,
              "DeductionUs16ia": 50000,
              "EntertainmentAlw16ii": 0,
              "IncomeFromSal": 291500,
              "GrossRentReceived": 0,
              "AnnualValue": 0,
              "StandardDeduction": 0,
              "TotalIncomeOfHP": 0,
              "IncomeOthSrc": 639,
              "DeductionUs57iia": 0,
              "Increliefus89AOS": 0,
              "GrossTotIncome": 292139,
              "TotalIncome": 283960
            },
            "ITR1_TaxComputation": {
              "IntrstPay": {
                "IntrstPayUs234A": 0,
                "IntrstPayUs234B": 0,
                "IntrstPayUs234C": 0,
                "LateFilingFee234F": 0
              },
              "TotalTaxPayable": 1698,
              "Rebate87A": 1698,
              "TaxPayableOnRebate": 0,
              "EducationCess": 0,
              "GrossTaxLiability": 0,
              "Section89": 0,
              "NetTaxLiability": 0,
              "TotalIntrstPay": 0,
              "TotTaxPlusIntrstPay": 0
            },
            "TaxPaid": {
              "TaxesPaid": {
                "AdvanceTax": 0,
                "TDS": 17,
                "TCS": 0,
                "SelfAssessmentTax": 0,
                "TotalTaxesPaid": 17
              },
              "BalTaxPayable": 0
            },
            "Refund": {
              "BankAccountDtls": {
                "AddtnlBankDetails": [
                  {
                    "IFSCCode": "DUMMY1234",
                    "BankName": "DUMMY BANK",
                    "BankAccountNo": "DUMMY_ACCOUNT",
                    "UseForRefund": "true"
                  },
                  {
                    "IFSCCode": "DUMMY5678",
                    "BankName": "ANOTHER DUMMY BANK",
                    "BankAccountNo": "ANOTHER_DUMMY_ACCOUNT",
                    "UseForRefund": "false"
                  }
                ]
              },
              "RefundDue": 20
            },
            "Schedule80G": {
              "Don100Percent": {
                "TotDon100PercentCash": 0,
                "TotDon100PercentOtherMode": 0,
                "TotDon100Percent": 0,
                "TotEligibleDon100Percent": 0
              },
              "Don50PercentNoApprReqd": {
                "TotDon50PercentNoApprReqdCash": 0,
                "TotDon50PercentNoApprReqdOtherMode": 0,
                "TotDon50PercentNoApprReqd": 0,
                "TotEligibleDon50Percent": 0
              },
              "Don100PercentApprReqd": {
                "TotDon100PercentApprReqdCash": 0,
                "TotDon100PercentApprReqdOtherMode": 0,
                "TotDon100PercentApprReqd": 0,
                "TotEligibleDon100PercentApprReqd": 0
              },
              "Don50PercentApprReqd": {
                "TotDon50PercentApprReqdCash": 0,
                "TotDon50PercentApprReqdOtherMode": 0,
                "TotDon50PercentApprReqd": 0,
                "TotEligibleDon50PercentApprReqd": 0
              },
              "TotalDonationsUs80GCash": 0,
              "TotalDonationsUs80GOtherMode": 0,
              "TotalDonationsUs80G": 0,
              "TotalEligibleDonationsUs80G": 0
            },
            "Schedule80GGA": {
              "TotalDonationAmtCash80GGA": 0,
              "TotalDonationAmtOtherMode80GGA": 0,
              "TotalDonationsUs80GGA": 0,
              "TotalEligibleDonationAmt80GGA": 0
            },
            "Schedule80D": {
              "Sec80DSelfFamSrCtznHealth": {
                "SeniorCitizenFlag": "S",
                "SelfAndFamily": 0,
                "SelfAndFamilySeniorCitizen": 0,
                "ParentsSeniorCitizenFlag": "P",
                "Parents": 0,
                "ParentsSeniorCitizen": 0,
                "EligibleAmountOfDedn": 0
              }
            },
            "TDSonSalaries": {
              "TotalTDSonSalaries": 0
            },
            "TDSonOthThanSals": {
              "TDSonOthThanSal": [
                {
                  "EmployerOrDeductorOrCollectDetl": {
                    "TAN": "ABCD12345E",
                    "EmployerOrDeductorOrCollecterName": "XYZ Corporation"
                  },
                  "AmtForTaxDeduct": 200,
                  "DeductedYr": "2023",
                  "TotTDSOnAmtPaid": 25,
                  "ClaimOutOfTotTDSOnAmtPaid": 20
                }
              ],
              "TotalTDSonOthThanSals": 25
            },
            "ScheduleTDS3Dtls": {
              "TotalTDS3Details": 5
            },
            "ScheduleTCS": {
              "TotalSchTCS": 15
            },
            "TaxPayments": {
              "TotalTaxPayments": 1000
            },
            "Verification": {
              "Declaration": {
                "AssesseeVerName": "John Doe",
                "FatherName": "Doe Sr.",
                "AssesseeVerPAN": "ABCDE1234F"
              },
              "Capacity": "Individual",
              "Place": "123.456.789.012"
            }
          }
        }
      }
    ]
  },
  "message": "1 year ITR Data available in the last 3 year(s)",
  "statusCode": 200
}

Output Parameters:

Parameter	Type	Description
requestId	string	requestId given in the input to fetch ITR Form
panNumber	string	The PAN (Permanent Account Number) is associated with an individual or entity.
result	object	Entire result
result.[assessment-year]	object	ITR for a given assessment year. eg. result[2022-23]
result.[assessment-year].panNumber	string	The PAN (Permanent Account Number) is associated with an individual or entity.
result.[assessment-year].filingYear	string	The fiscal year for which the filing is being done is specified in the format "YYYY-YYYY."
result.[assessment-year].filingDate	string	Date of filing the ITR
result.[assessment-year].filedBy	string	Who has filed the ITR
result.[assessment-year].filingSection	string	The Filing Section of the ITR
result.[assessment-year].itrType	string	The type of ITR filed
result.[assessment-year].itrFilingStatus	Array	Array of objects containing two keys : statusDescription and activityDate This is a list of Statuses of ITR filing
result.[assessment-year].itrFilingStatus[status].statusDescription	string	The status description
result.[assessment-year].itrFilingStatus[status].activityDate	string	The date of the activity of the corresponding status
result[assessment-year].acknowledgementNumber	string	The acknowledgment number is associated with the filed return.
result[assessment-year].filingType	string	The type of filing indicates whether it is an original filing.
result[assessment-year].ITR	Object	A nested structure containing details of the ITR form.
result.[assessment-year].ITR.ITRn	Object	Contains the ITR object. It can be any one of ITR1, ITR2, ITR3, ITR4, ITR5, ITR6, ITR7. The "n" is the number from 1 to 7 which can be present like ITR1, ITR2 etc.

Status Codes:

CODE	MESSAGE
200	Request successful
409	Upstream is down
400	Bad Request - Mandatory parameters missing or incorrent request ID