Authenticate a TRACES deductor

Authenticate a deductor with a TAN and TRACES password to obtain a deductor access token and refresh token.

POST /tds/traces/deductors/authenticate

cURL

Session created

curl --request POST \
  --url https://test-api.sandbox.co.in/tds/traces/deductors/authenticate \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "@entity": "in.co.sandbox.tds.compliance.traces.authentication.request",
  "tan": "AHMA12345A",
  "password": "your-traces-password"
}
'

200

Session created

{
  "code": 200,
  "timestamp": 1792176139900,
  "transaction_id": "198e8f90-691e-4c04-afaf-377611afa55f",
  "data": {
    "@entity": "in.co.sandbox.tds.compliance.traces.authentication.response",
    "access_token": "eyJhbGciOiJSU0FTU0FfUFNTX1NIQV81MTIiLCJ0eXAiOiJKV1QiLCJraWQiOiJleGFtcGxlLXNpZ25pbmcta2V5In0.eyJpc3MiOiJhcGkuc2FuZGJveC5jby5pbiIsImF1ZCI6IkFQSSIsImludGVudCI6IkFDQ0VTU19UT0tFTiIsImlhdCI6MTc5MjE3NjEzOSwiZXhwIjoxNzkyMTc3MDQ3fQ.invalid-example-signature",
    "refresh_token": "eyJhbGciOiJSU0FTU0FfUFNTX1NIQV81MTIiLCJ0eXAiOiJKV1QiLCJraWQiOiJleGFtcGxlLXNpZ25pbmcta2V5In0.eyJpc3MiOiJhcGkuc2FuZGJveC5jby5pbiIsImF1ZCI6IkFQSSIsImludGVudCI6IlJFRlJFU0hfVE9LRU4iLCJpYXQiOjE3OTIxNzYxMzksImV4cCI6MTc5MjE4MzM0N30.invalid-example-signature",
    "access_token_expiry": 1792177047000,
    "refresh_token_expiry": 1792183347000
  }
}

This endpoint uses your Sandbox access token in the Authorization header. See the Quickstart guide for Sandbox authentication.

Save the returned data.access_token and data.refresh_token. Use data.access_token in the Authorization header for requests that require a deductor access token.

When the deductor access token expires, use Refresh a TRACES deductor session.

Headers

Authorization · string · required

Sandbox access token. For token-generation steps, see the Quickstart guide.

x-api-key · string · required

Sandbox API key.

Content-Type · string · required

Request body format.

Body

application/json

@entity · enum<string> · required

Available options: in.co.sandbox.tds.compliance.traces.authentication.request

tan · string · required

Deductor TAN registered with TRACES.

Pattern: ^[A-Z]{4}[0-9]{5}[A-Z]$

password · string · required · write-only

Password for the deductor TRACES account.

Minimum string length: 1

Response

200

application/json

Returns access and refresh tokens for the TRACES session.

code · enum<integer> · required

Available options: 200

timestamp · integer<int64> · required

Unix timestamp in milliseconds.

transaction_id · string · required

data · object · required

Show child attributes