Job Status

Overview

  • API takes job_id and gives back status, and signed_url which contains the ZIP of the PDF of all the Form 16 and Form 16A

Problem

  • Manually downloading large volumes of files like millions of Form 16 and Forms 16A becomes a tedious and time-consuming process

Solution

  • This API takes the tan of the deductor as the path parameter. It takes the quater and financial_year for which Form 16A needs to be generated in the query parameters. In the body parameters, it takes the bsr_code, challan_date, challan_serial_no, challan_amount, unique_pan_amount_combination_for_challan of the challan which was part of the previously filled TDS return
  • Automating the consent-based retrieval of Form 16A
  • This API will return the JOB ID which can be used to get the status of the Form 16 download

Endpoint

HTTP MethodResource
GET/tds-compliance/traces/deductors/{tan}/form-16a

API EndpointAPI Endpoint

Request

The API only requires the Job ID in the query parameter

Query Parameters

ParamTypeDescriptionExample
job_idstringJob ID obtained from the previous step.1546372e-6fc5-45bb-a2d9-b18d0c662427

Once the values are added, Your curl will look something like this

curl --request GET \
     --url 'https://api.sandbox.co.in/tds-compliance/traces/deductors/{tan}/form-16a?job_id=1546372e-6fc5-45bb-a2d9-b18d0c662427' \
     --header 'Accept: application/json' \
     --header 'Authorization: xxxxxxxxxxxxxxxxxxxxxxxxx' \
     --header 'x-api-key: xxxxxxxxxxxxxxxxx' \
     --header 'x-api-version: 1.0'

Response

ParamTypeDescriptionExample
job_idstringThe Job ID of the particular JOB. You can check the job status with the Get Job Statusf24cd229-42c8-43de-af79-8ce2d3c4c3db
statusstringJob Status. Possible Values:
JOBQUEUED
JOBDONE
JOBFAILED
JOBQUEUED
signed_urlstringLink where we will provide the ZIP file of all the Form 16/16A in PDF format. Will be provided when the status is JOBDONEhttps://.

..

What does the ZIP file Contain

The ZIP file will contain the PDF's of the requested Form 16/16A