Submit PANs for TRACES verification

curl --request POST \
  --url https://test-api.sandbox.co.in/tds/compliance/traces/deductors/pan/verify \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "@entity": "workbook",
  "name": "payee_workbook",
  "sheets": [
    {
      "@entity": "sheet",
      "name": "payee_sheet",
      "blocks": [
        {
          "@entity": "table",
          "name": "payee_table",
          "header": [
            "sr_no",
            "pan"
          ],
          "rows": [
            [
              1,
              "AAAPW9785C"
            ],
            [
              2,
              "AAAPW9795C"
            ],
            [
              3,
              "AAAPW9805C"
            ]
          ]
        }
      ]
    }
  ]
}
'

{
  "code": 200,
  "timestamp": 1792265451650,
  "data": {
    "token_number": "26102348059"
  },
  "transaction_id": "2faa2970-c4dc-4cad-9aa0-af8767aad856"
}

{
  "code": 400,
  "timestamp": 1792265461716,
  "message": "Invalid request body",
  "transaction_id": "466092af-2865-43c2-a257-942e42bb7b63"
}

{
  "code": 401,
  "message": "Unauthorized",
  "timestamp": 1792265461644,
  "transaction_id": "61438e84-db3c-41ea-8694-8091b7cfe000"
}

{
  "code": 403,
  "message": "Forbidden",
  "timestamp": 1792265461907,
  "transaction_id": "4201145a-9834-480b-adff-a5d8d8a07791"
}

{
  "code": 500,
  "timestamp": 123,
  "transaction_id": "<string>",
  "message": "<string>"
}

{
  "code": 503,
  "timestamp": 123,
  "transaction_id": "<string>",
  "message": "<string>"
}

POST

tds

compliance

traces

deductors

pan

verify

curl --request POST \
  --url https://test-api.sandbox.co.in/tds/compliance/traces/deductors/pan/verify \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "@entity": "workbook",
  "name": "payee_workbook",
  "sheets": [
    {
      "@entity": "sheet",
      "name": "payee_sheet",
      "blocks": [
        {
          "@entity": "table",
          "name": "payee_table",
          "header": [
            "sr_no",
            "pan"
          ],
          "rows": [
            [
              1,
              "AAAPW9785C"
            ],
            [
              2,
              "AAAPW9795C"
            ],
            [
              3,
              "AAAPW9805C"
            ]
          ]
        }
      ]
    }
  ]
}
'

{
  "code": 200,
  "timestamp": 1792265451650,
  "data": {
    "token_number": "26102348059"
  },
  "transaction_id": "2faa2970-c4dc-4cad-9aa0-af8767aad856"
}

{
  "code": 400,
  "timestamp": 1792265461716,
  "message": "Invalid request body",
  "transaction_id": "466092af-2865-43c2-a257-942e42bb7b63"
}

{
  "code": 401,
  "message": "Unauthorized",
  "timestamp": 1792265461644,
  "transaction_id": "61438e84-db3c-41ea-8694-8091b7cfe000"
}

{
  "code": 403,
  "message": "Forbidden",
  "timestamp": 1792265461907,
  "transaction_id": "4201145a-9834-480b-adff-a5d8d8a07791"
}

{
  "code": 500,
  "timestamp": 123,
  "transaction_id": "<string>",
  "message": "<string>"
}

{
  "code": 503,
  "timestamp": 123,
  "transaction_id": "<string>",
  "message": "<string>"
}

Authenticate a TRACES deductor and pass the returned data.access_token as the value of the Authorization header. The token identifies the TAN. Send the payee workbook directly in the request body. Save the returned data.token_number to retrieve verification status. For authentication, submission, and result download examples, see Verify PANs with a deductor token.

Headers

Authorization

string

required

Deductor access token returned by Authenticate a TRACES deductor. The token identifies the deductor TAN.

x-api-key

string

required

Sandbox API key.

Content-Type

string

required

Request body format.

Body

application/json

TRACES bulk PAN verification input workbook.

@entity

enum<string>

required

Available options:

workbook

name

enum<string>

required

Available options:

payee_workbook

sheets

object[]

required

Required array length: 1 element

Show child attributes

Response

The PAN verification request was submitted to TRACES.

code

enum<integer>

required

Available options:

200

timestamp

integer

required

Unix timestamp in milliseconds.

transaction_id

string

required

data

object

required

Show child attributes

Calculator

Analytics

Reports

Compliance

Annexures

Submit PANs for TRACES verification

Headers

Body

Response