Search TDS and TCS certificate jobs

curl --request POST \
  --url https://test-api.sandbox.co.in/tds/compliance/enriched/traces/deductor/certificates/{certificate_type}/search \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>' \
  --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",
  "page_size": 5,
  "last_evaluated_key": "eyJqb2JfaWQiOiI3NDVjZGU1Ny03YTZhLTQyZGItYjk0MC1lODNlZWE2YjgxN2IiLCJ3b3Jrc3BhY2VfaWQiOiJkYzQ5NTdlZC1kZTBlLTQyYzctODBkZC04MjIxY2VlOGNkYTAiLCJjcmVhdGVkX2F0IjoxNzg4NzYzNzI5OTEwfQ=="
}
'

{
  "code": 200,
  "timestamp": 1788772789304,
  "data": {
    "@entity": "in.co.sandbox.tds.compliance.certificate.paginated_list",
    "last_evaluated_key": "eyJ3b3Jrc3BhY2VfaWQiOiJkYzQ5NTdlZC1kZTBlLTQyYzctODBkZC04MjIxY2VlOGNkYTAiLCJjcmVhdGVkX2F0IjoxNzg4NzA0OTg0MjM0LCJqb2JfaWQiOiJhZDcxNGFkMy03Y2QyLTQ2YWEtYTNiMy1jZTY2Njg2MDMxN2YifQ==",
    "items": [
      {
        "created_at": 1788762771957,
        "updated_at": 1788762775867,
        "@entity": "in.co.sandbox.tds.compliance.certificate.job",
        "job_id": "b88f494e-e60c-407c-aca4-09676d1c1f9b",
        "tan": "AHMS45586C",
        "tax_year": "TY 2026-27",
        "quarter": "Q1",
        "message": "Failed to submit the certificate job",
        "status": "failed"
      },
      {
        "created_at": 1788761715040,
        "updated_at": 1788761718733,
        "@entity": "in.co.sandbox.tds.compliance.certificate.job",
        "job_id": "b2050206-7c13-4669-a82a-ce58b5622585",
        "tan": "AHMS45586C",
        "tax_year": "TY 2026-27",
        "quarter": "Q1",
        "status": "succeeded"
      },
      {
        "created_at": 1788713969000,
        "updated_at": 1788713973336,
        "@entity": "in.co.sandbox.tds.compliance.certificate.job",
        "job_id": "94f0447c-62d4-4521-8af7-390de5c837d1",
        "tan": "AHMS45586C",
        "tax_year": "TY 2026-27",
        "quarter": "Q1",
        "status": "succeeded"
      },
      {
        "created_at": 1788713289073,
        "updated_at": 1788713294413,
        "@entity": "in.co.sandbox.tds.compliance.certificate.job",
        "job_id": "5d3a9031-46c7-4fa9-b2f5-cac1fccf4d95",
        "tan": "AHMS45586C",
        "tax_year": "TY 2026-27",
        "quarter": "Q1",
        "message": "Failed to submit the certificate job",
        "status": "failed"
      },
      {
        "created_at": 1788704984234,
        "updated_at": 1788704988663,
        "@entity": "in.co.sandbox.tds.compliance.certificate.job",
        "job_id": "ad714ad3-7cd2-46aa-a3b3-ce666860317f",
        "tan": "AHMS45586C",
        "tax_year": "TY 2026-27",
        "quarter": "Q1",
        "message": "Failed to submit the certificate job",
        "status": "failed"
      }
    ]
  },
  "transaction_id": "d1ff4c62-8aa7-4ae6-8b4d-1c46727e58e2"
}

POST

tds

compliance

enriched

traces

deductor

certificates

{certificate_type}

curl --request POST \
  --url https://test-api.sandbox.co.in/tds/compliance/enriched/traces/deductor/certificates/{certificate_type}/search \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>' \
  --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",
  "page_size": 5,
  "last_evaluated_key": "eyJqb2JfaWQiOiI3NDVjZGU1Ny03YTZhLTQyZGItYjk0MC1lODNlZWE2YjgxN2IiLCJ3b3Jrc3BhY2VfaWQiOiJkYzQ5NTdlZC1kZTBlLTQyYzctODBkZC04MjIxY2VlOGNkYTAiLCJjcmVhdGVkX2F0IjoxNzg4NzYzNzI5OTEwfQ=="
}
'

{
  "code": 200,
  "timestamp": 1788772789304,
  "data": {
    "@entity": "in.co.sandbox.tds.compliance.certificate.paginated_list",
    "last_evaluated_key": "eyJ3b3Jrc3BhY2VfaWQiOiJkYzQ5NTdlZC1kZTBlLTQyYzctODBkZC04MjIxY2VlOGNkYTAiLCJjcmVhdGVkX2F0IjoxNzg4NzA0OTg0MjM0LCJqb2JfaWQiOiJhZDcxNGFkMy03Y2QyLTQ2YWEtYTNiMy1jZTY2Njg2MDMxN2YifQ==",
    "items": [
      {
        "created_at": 1788762771957,
        "updated_at": 1788762775867,
        "@entity": "in.co.sandbox.tds.compliance.certificate.job",
        "job_id": "b88f494e-e60c-407c-aca4-09676d1c1f9b",
        "tan": "AHMS45586C",
        "tax_year": "TY 2026-27",
        "quarter": "Q1",
        "message": "Failed to submit the certificate job",
        "status": "failed"
      },
      {
        "created_at": 1788761715040,
        "updated_at": 1788761718733,
        "@entity": "in.co.sandbox.tds.compliance.certificate.job",
        "job_id": "b2050206-7c13-4669-a82a-ce58b5622585",
        "tan": "AHMS45586C",
        "tax_year": "TY 2026-27",
        "quarter": "Q1",
        "status": "succeeded"
      },
      {
        "created_at": 1788713969000,
        "updated_at": 1788713973336,
        "@entity": "in.co.sandbox.tds.compliance.certificate.job",
        "job_id": "94f0447c-62d4-4521-8af7-390de5c837d1",
        "tan": "AHMS45586C",
        "tax_year": "TY 2026-27",
        "quarter": "Q1",
        "status": "succeeded"
      },
      {
        "created_at": 1788713289073,
        "updated_at": 1788713294413,
        "@entity": "in.co.sandbox.tds.compliance.certificate.job",
        "job_id": "5d3a9031-46c7-4fa9-b2f5-cac1fccf4d95",
        "tan": "AHMS45586C",
        "tax_year": "TY 2026-27",
        "quarter": "Q1",
        "message": "Failed to submit the certificate job",
        "status": "failed"
      },
      {
        "created_at": 1788704984234,
        "updated_at": 1788704988663,
        "@entity": "in.co.sandbox.tds.compliance.certificate.job",
        "job_id": "ad714ad3-7cd2-46aa-a3b3-ce666860317f",
        "tan": "AHMS45586C",
        "tax_year": "TY 2026-27",
        "quarter": "Q1",
        "message": "Failed to submit the certificate job",
        "status": "failed"
      }
    ]
  },
  "transaction_id": "d1ff4c62-8aa7-4ae6-8b4d-1c46727e58e2"
}

Select the certificate type in the path. Filter its jobs by TAN, tax year, quarter, status, or creation dates. To retrieve the next page, pass the returned last_evaluated_key with the same filters.

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.

Content-Type

string

required

Request body format.

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.

Allowed value: "in.co.sandbox.tds.compliance.certificate.job.search"

Example:

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

tan

string

Tax Deduction and Collection Account Number (TAN).

Example:

"AHMS45586C"

tax_year

string

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

Pattern: ^TY [0-9]{4}-[0-9]{2}$

Example:

"TY 2026-27"

quarter

enum<string>

Quarter used to filter certificate jobs.

Available options:

Q1,

Q2,

Q3,

Q4

status

enum<string>

Job status used to filter results.

Available options:

created,

queued,

in_progress,

succeeded,

failed

page_size

integer

default:20

Maximum number of jobs to return.

Required range: 1 <= x <= 50

last_evaluated_key

string

Pagination key returned by the previous search response.

from_date

integer

Earliest job creation time, as a Unix timestamp in milliseconds.

to_date

integer

Latest job creation time, as a Unix timestamp in milliseconds.

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 and TCS certificate jobs

Headers

Path Parameters

Body

Response