GETGet Aadhaar KYC Consent Details

Fetch the DigiKhata Aadhaar eKYC consent text and audio for a chosen language.

GET/customer/payment/ppi-digikhata/sender/{customer_id}/aadhaar/consent/details

Returns the full Aadhaar eKYC consent content, short consent statement, and an audio URL for the language selected (via consent_language = the pkid from Get Aadhaar KYC Consent Languages). Display/play this consent before collecting Aadhaar OTP.

Request

Path parameters

Field	Type	Required	Description
`customer_id`	string	required	Sender's 10-digit mobile number.e.g. 8617567988

customer_idstringRequired

Sender's 10-digit mobile number.

example: 8617567988

Query parameters

Field	Type	Required	Description
`initiator_id`	string	required	Registered mobile number of the API user (see Platform Credentials).e.g. 9962981729
`org_id`	string	required	Organisation identifier. Defaults to 1.e.g. 1
`client_ref_id`	string	required	Unique reference identifier for the request.e.g. ref_20250121_001
`consent_language`	string	required	The pkid from Get Aadhaar KYC Consent Languages.e.g. 1

initiator_idstringRequired

Registered mobile number of the API user (see Platform Credentials).

example: 9962981729

org_idstringRequired

Organisation identifier. Defaults to 1.

example: 1

client_ref_idstringRequired

Unique reference identifier for the request.

example: ref_20250121_001

consent_languagestringRequired

The pkid from Get Aadhaar KYC Consent Languages.

example: 1

These headers authenticate and sign every request. See How Auth Works for details.

Field	Type	Required	Description
`developer_key`	string	required	Static API key issued to your account after KYC.
`secret-key`	string	required	Dynamic per-request signature: base64(HMAC-SHA256(timestamp, base64(access_key))).
`secret-key-timestamp`	string	required	Current time in milliseconds since UNIX epoch, used to compute secret-key. Must match server time.
`content-type`	string	required	application/jsone.g. application/json

developer_keystringRequired

Static API key issued to your account after KYC.

secret-keystringRequired

Dynamic per-request signature: base64(HMAC-SHA256(timestamp, base64(access_key))).

secret-key-timestampstringRequired

Current time in milliseconds since UNIX epoch, used to compute secret-key. Must match server time.

content-typestringRequired

application/json

example: application/json

Responses

statusnumber
Primary success indicator (0 = success).
messagestring
Human-readable response / error message.
response_status_idnumber
Granular status id; see the shared error-codes table.
response_type_idnumber
A unique id for every possible response shape (success or error) — useful for client logic branching and analytics.
dataobject
API-specific response payload.
- consent_detailobject
  Consent content, short statement, and audio URL.
  - consentContentstring
    Full Aadhaar eKYC consent text.
  - consentstring
    Short consent statement to display.
  - audioUrlstring
    Audio rendition of the consent in the chosen language.
  - consentIdnumber
    Consent identifier.
  - consentLanguagestring
    Language of the returned consent.

Next steps

import { EpsClient } from "@ekoindia/eps-sdk";

const client = new EpsClient({

developerKey: process.env.EPS_DEVELOPER_KEY,

accessKey: process.env.EPS_ACCESS_KEY,

initiatorId: "9962981729",

environment: "sandbox",

});

const result = await client.call("ppi-digikhata-consent-details", {

"customer_id": "8617567988",

"org_id": "1",

"client_ref_id": "ref_20250121_001",

"consent_language": "1"

});

console.log(result);

{

"response_status_id": 0,

"data": {

"consent_detail": {

"consentContent": "Use my Aadhaar / Virtual ID details (as applicable) for the purpose of eKYC for/with PayPoint India to authenticate my identity through the Aadhaar Authentication system (Aadhaar based eKYC services of UIDAI) in accordance with the provisions of the Aadhaar (Targeted Delivery of Financial and other Subsidies, Benefits and Services) Act, 2016 and the allied rules and regulations notified thereunder and for no other purpose.\r\n Authenticate my Aadhaar/Virtual ID through OTP or Biometric for authenticating my identity through the Aadhaar Authentication system for obtaining my eKYC through Aadhaar based eKYC services of UIDAI and use my Photo and Demographic details (Name, Gender, Date of Birth and Address) for the purpose of eKYC for/with PayPoint India.\r\n I understand that Security and confidentiality of personal identity data provided, for the purpose of Aadhaar based authentication is ensured by PayPoint and the data will be stored by PayPoint till such time as mentioned in guidelines from UIDAI from time to time.",

"audioUrl": "https://paypointindia.co.in/audio/Consent_English.mp3",

"consentId": 1,

"consent": "Consent for Authentication: I, the holder of Aadhaar number, hereby give my consent to Paypoint India Network Private Limited to perform authentication and obtain my eKYC with UIDAI for the purpose of creating my wallet.",

"consentLanguage": "English"

}

"response_type_id": 2446,

"message": "Consent Language Successfully Retrieved",

"status": 0

}

Request

Path parameters

Query parameters

Responses

Next steps

Related