ITR Get Reference Id

Introduction:

ITR is one of the most important structured data sources that can help in understanding the financial background of an individual/corporate. This data can then be cross-referenced with other sources like Bank Statements, GST, MCA data if available, or Declared information like Employment details and Salary to have a more comprehensive picture of the customer. The important usecase of this data is Lending of any sort but it can also be used for onboarding and account openings for corporates in some cases Our API seamlessly integrates the financial data retrieval process, starting with users initiating the generation of a unique reference ID by providing essential credentials. This reference ID serves as the key for users to request comprehensive Income Tax Return (ITR) analytics, including ITR details, tax information, balance sheets, profit and loss statements, and ratio analysis. The API efficiently responds with a downloadable Excel file, enabling users to conduct in-depth analyses and make well-informed financial decisions based on the wealth of detailed analytics data provided.

Endpoint:

POST /get-reference-id

This API generates a reference ID for a given user using their essentials such as username and password.

Sample Curl:

curl --location 'https://staging.signzy.tech//api/v2/patrons/5e6b4e2e778fc750b7ef7fcd/itranalytics' \
--header 'authority: staging.signzy.tech' \
--header 'accept: application/json, text/plain, /' \
--header 'accept-language: en-US,en;q=0.9' \
--header 'authorization: IUOchr0PEi02SRyn7Zm784dyNmMH6TMoWkdsMXA8uAie7wxXIAxKMPJnwBFNF61v' \
--header 'content-type: application/json' \
--header 'origin: https://sandbox-staging.signzy.tech' \
--header 'referer: https://sandbox-staging.signzy.tech/' \
--header 'sec-ch-ua: "Chromium";v="112", "Google Chrome";v="112", "Not:A-Brand";v="99"' \
--header 'sec-ch-ua-mobile: ?0' \
--header 'sec-ch-ua-platform: "Linux"' \
--header 'sec-fetch-dest: empty' \
--header 'sec-fetch-mode: cors' \
--header 'sec-fetch-site: same-site' \
--header 'user-agent: Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/112.0.0.0 Safari/537.36' \
--data-raw '{
    "task": "getReferenceId",
    "essentials": {
        "username": "ABCDE1234F",
        "password": "ABCD@12345"
    }
}'

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	Mandatory
applicationId	string	Unique id for each request.	Optional
callBackUrl	string	CallBack url where data needs to be posted.	Optional

Sample Response:

{
    "essentials": {
        "username": "ABCDE1234F",
        "password": "ABCD@12345"
    },
    "id": "65797e8efd6ace0148112a30",
    "patronId": "5e6b4e2e778fc750b7ef7fcd",
    "task": "getReferenceId",
    "result": {
        "result": {
            "referenceId": "5b54205e-1738-4a99-bfad-d85a205fd34z",
            "statusMessage": "Successfully Submitted."
        }
    }
}

Output Parameters:

Parameter	Type	Description
essentials[username]	string	The username of the end-customer on the ITR Portal. It usually is the PAN of the user.
essentials[password]	string	Password for the ITR portal of the PAN holder.
id	string	Unique identifier for the API request
patronId	string	Patron identifier for the user.
task	string	Task name, in this case, "getReferenceId."
result	Object	Result object containing
result[result][referenceId]	string	Generated reference ID.
result[result][statusMessage]	string	Status message indicating the success/failure of the operation.

Status Codes:

{
    "error": {
        "name": "error",
        "message": "Internal Server Error",
        "status": 500,
        "reason": "ERROR",
        "type": "Internal Server Error",
        "statusCode": 500
    }
}