Generate TPIN (CDSL Only)
This API is used to generate a TPIN (Transaction PIN) for users.
⚠️Note: This feature is available for CDSL only.
🛣️Path Parameter
| Parameter | Type | Required | Description | Example |
|---|
| tenant_id | string | Yes | Tenant Identifier | abc123 |
| Header | Type | Required | Description | Example/ENUM |
|---|
| Authorization | string | Yes | Bearer token | Bearer access-token |
| x-api-key | string | Yes | API key provided for access | x-api-key |
📝Request Body Schema
| Field | Type | Required | Description | Example/ENUM |
|---|
| dpId | string | Yes | Depository Participant Id | 092000 |
| boid | string | Yes | Beneficial Owner ID | 12012555500000 |
| dp_type | string | Yes | Type of Depository Participant | CDSL |
| pan | string | Yes | PAN (Permanent Account Number) | ABCD12345 |
🟢Success Response - 200 Ok
| Field | Type | Description | Example |
|---|
| status | string | Indicates the status of the API request | "success" |
| code | string | A Response code indicating the result of the API call | "s-101" |
| message | string | A descriptive message of the result | "TPIN Generated Successfully" |
| data | object | Response data object containing TPIN request info | See details below |
📘Data Object Info Fields
| Field | Type | Description | Example |
|---|
| ReqId | string | Request ID | REQ3456 |
| ResId | string | Response ID | RES6789 |
| ResTime | string | Response Time | 18112022183146 |
| Status | string | Status of the TPIN Generation | "00" |
| ErrorCode | string | Error code if any error occurs | " " (empty if no error) |