GETGet Aadhaar KYC Consent Languages

List the languages available for the DigiKhata Aadhaar eKYC consent.

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

Returns the supported consent languages (with their pkid) for DigiKhata Aadhaar eKYC. Pass the chosen pkid as consent_language to Get Aadhaar KYC Consent Details.

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

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

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_language_listarray
  Supported consent languages.
  - pkidstring
    Language identifier — pass as consent_language to Get Consent Details.
  - consentLanguagestring
    Display name of the language.

Next steps

NextGETGet Aadhaar KYC Consent DetailsFetch the DigiKhata Aadhaar eKYC consent text and audio for a chosen language.

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-languages", {

"customer_id": "8617567988",

"org_id": "1",

"client_ref_id": "ref_20250121_001"

});

console.log(result);

{

"response_status_id": 0,

"data": {

"consent_language_list": [

{

"pkid": "1",

"consentLanguage": "English"

{

"pkid": "2",

"consentLanguage": "Bengali"

{

"pkid": "3",

"consentLanguage": "Gujarati"

{

"pkid": "4",

"consentLanguage": "Hindi"

{

"pkid": "5",

"consentLanguage": "Kannada"

{

"pkid": "6",

"consentLanguage": "Malayalam"

{

"pkid": "7",

"consentLanguage": "Marathi"

{

"pkid": "8",

"consentLanguage": "Odia"

{

"pkid": "9",

"consentLanguage": "Tamil"

{

"pkid": "10",

"consentLanguage": "Telugu"

{

"pkid": "11",

"consentLanguage": "Urdu"

{

"pkid": "12",

"consentLanguage": "Assamese"

{

"pkid": "13",

"consentLanguage": "Punjabi"

}

]

"response_type_id": 2444,

"message": "Consent Language Successfully Retrieved",

"status": 0

}

Request

Path parameters

Query parameters

Responses

Next steps

Related