Get PidOptions
Any valid API key
Counts toward your 60 req/min
The exact PidOptions XML to capture with on the RD service
Query & Path Params
| Name | Type | Description |
|---|---|---|
| purpose optional | string | TXN (default), DAILY_AUTH or EKYC |
| auth_mode optional | string | FP (default), IRIS, or FACE (DAILY_AUTH only) |
Responses
| Status | Description |
|---|---|
| 200 OK | The exact PidOptions XML to capture with on the RD service — see the example on the right. |
| 4xx / 5xx | { "success": false, "error": { "code": "…", "message": "…" } } —
every code is listed under
Error Codes. |
Good to know
POST this XML to the RD service’s /rd/capture (or pass it to its Android intent) and send the PidData it returns as pid_data. eKYC needs purpose=EKYC: its wadh is different, and a transaction-style capture is rejected at eKYC. For a CW or AP above ₹5,000 use pid_options_with_otp and replace {OTP} with the OTP the customer received.