Open APIs are simple, easy to understand collection of REST like APIs designed for "Connect" partners to enhance their understanding about their customers. Open APIs provide a secure, consent-based mechanism to gain insights into users' demographics, incomes situations and tax deductions, enabling data driven and personalised investment & financial planning products.
Overview
Open APIs allow "Connect" partners access a variety of tax-related data including
-
Get User Details: Retrieve verified identity of the user, such as name, email, and mobile number.
-
Get Taxpayer: Access high-level details about the user demographics, including PAN, name, DOB, age as per PAN, category, residential status etc...
-
Get ITR: This endpoint gives you metadata about the user's Income Tax Returns, such as filing status, type of ITR filed, due dates, and acknowledgment number.
-
Get ITR JSON: Fetch the detailed ITR JSON as per Income Tax Department (ITD) schemas that encompasses the user's entire tax return.
-
Get Tax Computation: Fetch computation of income and tax including income by heads (such as salary, house property, capital gains, business & profession), demat accounts, bank accounts, personal assets and liabilities and more.
Authorization
Open APIs require an Authorization
header with the JWT access_token
as the value.
Getting Started
You can get started by checking out our postman collection below. Just tap to get started!
Recommendations
To effectively use the Open APIs, "Connect" partners should:
-
Understand the Endpoints: Familiarise yourself with each API endpoint, its purpose, and how it fits into the services you offer.
-
Know the Request and Response Structures: Each API has specific request parameters and response data formats. Understanding these will ensure seamless integration and data handling.
-
Handle Data with Care: As with any user data, it's crucial to handle and store the information securely and in compliance with data privacy and data protection guidelines.
-
Maintain User Consent: Ensure that you have ongoing consent from users to access and use their data, providing them with clear options to revoke access if desired.