Starter Kit

This page will guide you through the entire onboarding process for accessing the TDS CPC APIs via the Developer Portal.
This includes:

  1. Creating your Developer Portal account
  2. Activating your account By Administrator
  3. Logging in for the first time
  4. Creating an Application
  5. Retrieving API Credentials (Client ID & Client Secret)
  6. Regenerate Client Secret
  7. Explore ActiveDocs (API documentation)
  8. Start testing TDS CPC APIs
  9. TDS CPC API Overview
  10. TSP Test Certify

1. Creating your Developer Portal account Collapse section

Create your Developer Portal account in just a few steps and get ready to start testing TDS CPC APIs.

Open your browser and go to: https://test-dev.tdscpc.gov.in/
You will see the developer portal home page with the Sign In and Register your organization/Sign Up options.
Home Page

Click Register your Organization button. You will be taken to the "Create TRACES SUVIDHA developer account" page.On the account creation form, enter the belew section details:

* indicates a mandatory field

1.Entity details
  • Legal Entity Name*
  • Trade Name / Product Name*
  • Entity Type* (Company / LLP / Partnership / Proprietorship / Government / PSU)
  • PAN*
  • GSTIN
  • Registered Address*
  • City*
  • State*
  • Country*
  • Website URL
2.Primary user & credentials
Use your official registered email to avoid activation issues.
  • Email *
  • Password *
  • Password Confirmation *
3.Entity classification
  • Category (ERP / Payroll Software / Accounting Software / Bank / Deductor Intermediary / Other)
  • Estimated monthly TAN volume
  • Estimated monthly PAN volume
4.Contact Details
  • Contact Type - Administrative/ Technical / Developer
  • Contact Name
  • Designation
  • Mobile
  • Email
5.Agreements & submission
User read the terms & condition before create the developer account. *
Home Page
After enter all the required fields, Click the Create account buton and submit the account creation details.
Once account creation is successfull,System send a confirmation email with account created details.
Your registration details have been sent to the administrator for approval.
Your registration will remain pending until administrator activates your developer portal account.
But you have successfully registered, but you cannot log in until an administrator reviews and activates your account. Account Success Page
2. Activating your account By Administrator Collapse section

After registration, your account requires administrative activation to complete the onboarding process.

After you complete your registration on the developer portal, your account may need to be approved and
activated by a TPS Administrator before you can log in or begin accessing API services.This additional step ensures
that only authorized users receive access to protected API products and developer resources.

A TPS Administrator receives a notification when a new user wants access. Admin login to the admin portal
and reviews your details and decides to:
  • Approve and activate your account or
  • Request additional information or
  • Reject access (only for unauthorized requests)

Once the administrator approves your account:
  • You will receive an Account Approval Email.
  • The system will allow you to log in normally
  • You can access your Dashboard, Applications, and API Documentation
3. Logging in for the first time Collapse section

Log in with your newly activated account to explore the Developer Portal and manage your applications.

When your Developer Portal account is newly created and activated by an administrator, your first login completes onboarding and unlocks your Dashboard, Applications, API documentation, and credentials.

Login Page
  1. Open the Developer Portal:https://test-dev.tdscpc.gov.in/
  2. Click “Sign In” in the top-right navigation.
  3. Enter your credentials (Email + Password) and click Sign In.
  4. Access your Dashboard to manage Applications, view credentials, and explore API docs.
dashboard Page

  • Applications: Create apps and obtain Client ID/Secret.
  • Documents: Browse and test endpoints.
  • Profile (Settings): Update details, manage password.
4. Creating an Application Collapse section

Create an application to manage your API and securely access TDSCPC APIs.

Creating an application links your developer account to an API Product and generates the credentials
(Client ID & Client Secret) your code needs to call the APIs.
User clicks on the "Application" link in the navigation menu. It redirects to application dashbord page,
where you can able see the list of applications created by the account user.
List Application
If you want to create a new application, Click on "Create New Application button. It redirects to Create applicatio page.
Enter your Application Name Example: “TPS Integration App – January 2026”
(Optional) Add a Description
Click Create Application
Your new application will now appear in: Dashboard → Applications
Create Application
5. Retrieving API Credentials (Client ID & Client Secret) Collapse section

Retrieve the credentials required to authorize your application and connect to TDSCPC services.

Open the newly created Application.You will see:
Client ID
  • A public identifier for your application.
  • Used to identify the application interacting with the API.
Client Secret
  • A private key used for secure authentication.
  • Works like a password: never share it publicly.
Redirect URL
  • During the OAuth flow, after the user successfully authenticates and grants consent, the authorization server will redirect the user’s browser to your application’s registered Redirect URL. This redirect contains authorization information. Your application must handle this callback route, extract the authorization data, and exchange it with the authorization server’s token endpoint to obtain access tokens.
These credentials are required when invoking TPS APIs via: OAuth2 Client‑Credentials Flow
  • Log in to the Developer Portal.
  • Go to Applications.
  • Select the application for which you want to retrieve the secret.
  • Navigate to Client Secrets or Credentials section.
  • Copy the client id and secret and store it securely.
View Application
6. Regenerate Client Secret Collapse section

Retrieve the credentials required to authorize your application and connect to TDSCPC services.

Regenerating a Client Secret means creating a new secret key for your registered API application.
A Client Secret is a sensitive authentication key used by applications to securely connect to an API.
If your existing secret has expired, been compromised, or needs rotation for security compliance, you can regenerate it.
  • Log in to the Developer Portal.
  • Go to Applications.
  • Select the application for which you want to regenerate the secret.
  • Navigate to Client Secrets or Credentials section.
  • Click Regenerate.
  • Copy the new secret and store it securely.
regenerate
7. Explore API documentation Collapse section

View the API specification for service URL,Header, Request and Reponse details.

Interactive swagger UI API Documentation provides an interactive way to explore, understand, and test the API
directly from your browser. It shows all available endpoints, required parameters,sample responses,
and allows real‑time API testing using your credentials.

API Documentation is an interactive API reference tool that helps users:
  • View available API endpoints
  • Understand required and optional parameters
  • Test API calls directly within the documentation
  • See request/response samples
  • Validate integrations before coding

It is particularly helpful for developers, testers, and integration engineers who want to evaluate API behavior quickly.
  • Log in to the Developer Portal
  • Go to Documentation link in the navigation menu.
  • Choose the API you want to explore (e.g., 24Q, 26Q, 27Q).
  • The interface displays
    1.API overview
    2.All endpoints grouped by category
    3.Parameters and schemas
    4.Authorize
    4.“Try It Out” / “Test Endpoint” button

regenerate
8. Start testing TDSCPC APIs Collapse section

Retrieve the credentials required to authorize your application and connect to TDSCPC services.

The “Try Out” feature found in API documentation which allows users to run real API
requests directly from the API documentation. This makes it easy to validate endpoints before
implementing them in your application.
Step 1: Open API Documentation
  • Navigate to the API’s Swagger UI.
  • You will typically see a button labeled Authorize or a lock icon
Authorization

Step 2: Click the “Authorize” Button
This opens a modal showing available OAuth2 security schemes, such as:
  • OAuth2 Authorization URL
  • Token URL
  • Scopes
  • Grant types
Oauth2

Step 3: Enter Your OAuth2 Credentials
Depending on your OAuth2 flow, you will be prompted for:
  • Client ID
  • Client Secret
  • Scopes (select as needed)

Once click on the "Authorize" button, It redirects to the deductor login page. We should use the enablement API for creating test data in AIN Master, PAN Master and TAN Master. The enablement API should be used only in the sand box environment for create deductor test data. Go to the API document page and then select TDS-Data-Master from the drop down. Here you can see the Enablement APIs (TAN/PAN/AIN APIs). Enter the created deductor user id and
password and submit it.
Deductor login page

Step 4: Click “Authorize”
The portal will request an OAuth2 token from the Authorization Server.
Oauth2

If successful, you will see a confirmation message: “Authorization successful.”
Your access token is now active for the Try Out session.

Step 5: Select an Endpoint & Click “Try Out”
Once authenticated:
All protected endpoints become active
The “Try Out” button is enabled
tryout

Step 6: Fill in Parameters
Enter:
  • Path parameters
  • Query parameters
  • Request body (JSON)
  • Additional headers (if any)
Step 7: Execute the Request
Click Execute. You will see:
  • Request URL
  • The token automatically added as
  • Authorization: Bearer your_access_token
  • Response body
  • Response headers
  • Curl sample
Execute
9. TDS CPC API Overview
10. TSP Test Certify