Search TDS certificate jobs

curl --request POST \
  --url https://test-api.sandbox.co.in/tds/compliance/traces/deductors/forms/{certificate_type}/search \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "@entity": "in.co.sandbox.tds.compliance.certificate.job.search",
  "tan": "AHMS45586C",
  "tax_year": "TY 2026-27",
  "quarter": "Q1",
  "form": "131",
  "page_size": 5
}
'

{
  "code": 200,
  "timestamp": 1788772736810,
  "data": {
    "@entity": "in.co.sandbox.tds.compliance.certificate.paginated_list",
    "last_evaluated_key": "eyJqb2JfaWQiOiI3NDVjZGU1Ny03YTZhLTQyZGItYjk0MC1lODNlZWE2YjgxN2IiLCJ3b3Jrc3BhY2VfaWQiOiJkYzQ5NTdlZC1kZTBlLTQyYzctODBkZC04MjIxY2VlOGNkYTAiLCJjcmVhdGVkX2F0IjoxNzg4NzYzNzI5OTEwfQ==",
    "items": [
      {
        "created_at": 1788771384109,
        "updated_at": 1788771389188,
        "@entity": "in.co.sandbox.tds.compliance.certificate.job",
        "job_id": "518bf6d5-be9d-4723-8fee-2382919fb605",
        "tan": "AHMS45586C",
        "tax_year": "TY 2026-27",
        "quarter": "Q1",
        "form": "131",
        "message": "Invalid credentials",
        "status": "failed"
      },
      {
        "created_at": 1788765755936,
        "updated_at": 1788765759820,
        "@entity": "in.co.sandbox.tds.compliance.certificate.job",
        "job_id": "70c7df85-8860-4d61-b168-4881cb48792f",
        "tan": "AHMS45586C",
        "tax_year": "TY 2026-27",
        "quarter": "Q1",
        "form": "131",
        "message": "Credentials not found",
        "status": "failed"
      },
      {
        "created_at": 1788764647784,
        "updated_at": 1788764647806,
        "@entity": "in.co.sandbox.tds.compliance.certificate.job",
        "job_id": "55efc3fb-900c-4066-945e-a1b32d9f4d45",
        "tan": "AHMS45586C",
        "tax_year": "TY 2026-27",
        "quarter": "Q1",
        "form": "131",
        "status": "succeeded"
      },
      {
        "created_at": 1788764478529,
        "updated_at": 1788764480520,
        "@entity": "in.co.sandbox.tds.compliance.certificate.job",
        "job_id": "26a67dd9-70a8-4ec6-be9a-869191cbd9bf",
        "tan": "AHMS45586C",
        "tax_year": "TY 2026-27",
        "quarter": "Q1",
        "form": "131",
        "status": "succeeded"
      },
      {
        "created_at": 1788763729910,
        "updated_at": 1788763734899,
        "@entity": "in.co.sandbox.tds.compliance.certificate.job",
        "job_id": "745cde57-7a6a-42db-b940-e83eea6b817b",
        "tan": "AHMS45586C",
        "tax_year": "TY 2026-27",
        "quarter": "Q1",
        "form": "131",
        "status": "succeeded"
      }
    ]
  },
  "transaction_id": "95380870-0b99-492f-8fb1-4580af105ad3"
}

POST

tds

compliance

traces

deductors

forms

{certificate_type}

curl --request POST \
  --url https://test-api.sandbox.co.in/tds/compliance/traces/deductors/forms/{certificate_type}/search \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "@entity": "in.co.sandbox.tds.compliance.certificate.job.search",
  "tan": "AHMS45586C",
  "tax_year": "TY 2026-27",
  "quarter": "Q1",
  "form": "131",
  "page_size": 5
}
'

{
  "code": 200,
  "timestamp": 1788772736810,
  "data": {
    "@entity": "in.co.sandbox.tds.compliance.certificate.paginated_list",
    "last_evaluated_key": "eyJqb2JfaWQiOiI3NDVjZGU1Ny03YTZhLTQyZGItYjk0MC1lODNlZWE2YjgxN2IiLCJ3b3Jrc3BhY2VfaWQiOiJkYzQ5NTdlZC1kZTBlLTQyYzctODBkZC04MjIxY2VlOGNkYTAiLCJjcmVhdGVkX2F0IjoxNzg4NzYzNzI5OTEwfQ==",
    "items": [
      {
        "created_at": 1788771384109,
        "updated_at": 1788771389188,
        "@entity": "in.co.sandbox.tds.compliance.certificate.job",
        "job_id": "518bf6d5-be9d-4723-8fee-2382919fb605",
        "tan": "AHMS45586C",
        "tax_year": "TY 2026-27",
        "quarter": "Q1",
        "form": "131",
        "message": "Invalid credentials",
        "status": "failed"
      },
      {
        "created_at": 1788765755936,
        "updated_at": 1788765759820,
        "@entity": "in.co.sandbox.tds.compliance.certificate.job",
        "job_id": "70c7df85-8860-4d61-b168-4881cb48792f",
        "tan": "AHMS45586C",
        "tax_year": "TY 2026-27",
        "quarter": "Q1",
        "form": "131",
        "message": "Credentials not found",
        "status": "failed"
      },
      {
        "created_at": 1788764647784,
        "updated_at": 1788764647806,
        "@entity": "in.co.sandbox.tds.compliance.certificate.job",
        "job_id": "55efc3fb-900c-4066-945e-a1b32d9f4d45",
        "tan": "AHMS45586C",
        "tax_year": "TY 2026-27",
        "quarter": "Q1",
        "form": "131",
        "status": "succeeded"
      },
      {
        "created_at": 1788764478529,
        "updated_at": 1788764480520,
        "@entity": "in.co.sandbox.tds.compliance.certificate.job",
        "job_id": "26a67dd9-70a8-4ec6-be9a-869191cbd9bf",
        "tan": "AHMS45586C",
        "tax_year": "TY 2026-27",
        "quarter": "Q1",
        "form": "131",
        "status": "succeeded"
      },
      {
        "created_at": 1788763729910,
        "updated_at": 1788763734899,
        "@entity": "in.co.sandbox.tds.compliance.certificate.job",
        "job_id": "745cde57-7a6a-42db-b940-e83eea6b817b",
        "tan": "AHMS45586C",
        "tax_year": "TY 2026-27",
        "quarter": "Q1",
        "form": "131",
        "status": "succeeded"
      }
    ]
  },
  "transaction_id": "95380870-0b99-492f-8fb1-4580af105ad3"
}

Headers

x-api-version

string

API version for the request.

x-api-key

string

required

API key used to identify and authenticate the client.

Authorization

string

required

JWT access token. For token-generation steps, refer to the Quickstart Guide.

Path Parameters

certificate_type

enum<string>

required

Certificate type. Use 130 for salary TDS, 131 for other TDS, or 133 for TCS.

Available options:

130,

131,

133

Body

application/json

Filters used to search certificate generation jobs.

@entity

string

required

Search request entity type.

Example:

"in.co.sandbox.tds.compliance.certificate.job.search"

tan

string

required

Tax Deduction and Collection Account Number (TAN).

Example:

"AHMS45586C"

tax_year

string

required

Tax year used to filter certificate jobs. Use the TY YYYY-YY format.

Example:

"TY 2026-27"

quarter

enum<string>

required

Quarter used to filter certificate jobs.

Available options:

Q1,

Q2,

Q3,

Q4

form

enum<string>

required

Certificate form used to filter jobs. Use 130 for salary TDS, 131 for other TDS, or 133 for TCS.

Available options:

130,

131,

133

page_size

integer

required

Maximum number of jobs to return.

Required range: x >= 1

status

enum<string>

Job status used to filter results.

Available options:

created,

queued,

in_progress,

succeeded,

failed

last_evaluated_key

string

Pagination key returned by the previous search response.

Response

Certificate generation jobs returned.

code

integer

required

timestamp

integer

required

transaction_id

string

required

data

object

required

Show child attributes

Calculator

Analytics

Reports

Compliance

Annexures

Search TDS certificate jobs

Headers

Path Parameters

Body

Response