---
title: "Get Aadhaar KYC Consent Details API Reference"
description: "Fetch the DigiKhata Aadhaar e-KYC consent text and audio for a chosen language."
canonical: "https://eps.eko.in/docs/ppi-digikhata-consent-details"
---


> **Canonical URL:** https://eps.eko.in/docs/ppi-digikhata-consent-details
> This is a machine-readable Markdown version of the page for AI agents and LLMs. The primary (HTML) version lives at the canonical URL above.

# Get Aadhaar KYC Consent Details API Reference

`GET https://staging.eko.in/ekoapi/v3/customer/payment/ppi-digikhata/sender/{customer_id}/aadhaar/consent/details`

Fetch the DigiKhata Aadhaar e-KYC consent text and audio for a chosen language.

Returns the full Aadhaar e-KYC 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.

> View product & pricing details: [PPI Wallet](https://eps.eko.in/products/ppi-api.md)

## Path parameters

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

## Query parameters

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| initiator_id | string | yes | Registered mobile number of the API user (see Platform Credentials). e.g. 9962981729 |
| user_code | string | yes | User code of the retailer/agent the service is run for. e.g. 20810200 |
| org_id | string | yes | Organisation identifier. Defaults to 1. e.g. 1 |
| client_ref_id | string | yes | Unique reference identifier for the request. e.g. ref_20250121_001 |
| consent_language | string | yes | The pkid from Get Aadhaar KYC Consent Languages. e.g. 1 |

## Headers

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

## Response

⭐ marks fields highlighted as verifiable.

| Field | Type | Description |
| --- | --- | --- |
| status | number | Primary success indicator (0 = success). |
| message | string | Human-readable response / error message. |
| response_status_id | number | Granular status id; see the shared error-codes table. |
| response_type_id | number | A unique id for every possible response shape (success or error) — useful for client logic branching and analytics. |
| data | object | API-specific response payload. |
| data.consent_detail ⭐ | object | Consent content, short statement, and audio URL. |
| data.consent_detail.consentContent | string | Full Aadhaar e-KYC consent text. |
| data.consent_detail.consent ⭐ | string | Short consent statement to display. |
| data.consent_detail.audioUrl | string | Audio rendition of the consent in the chosen language. |
| data.consent_detail.consentId | number | Consent identifier. |
| data.consent_detail.consentLanguage | string | Language of the returned consent. |

## Example response

```json
{
  "response_status_id": 0,
  "data": {
    "consent_detail": {
      "consentContent": "Use my Aadhaar / Virtual ID details (as applicable) for the purpose of e-KYC for/with PayPoint India to authenticate my identity through the Aadhaar Authentication system (Aadhaar based e-KYC 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 e-KYC through Aadhaar based e-KYC services of UIDAI and use my Photo and Demographic details (Name, Gender, Date of Birth and Address) for the purpose of e-KYC 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 e-KYC with UIDAI for the purpose of creating my wallet.",
      "consentLanguage": "English"
    }
  },
  "response_type_id": 2446,
  "message": "Consent Language Successfully Retrieved",
  "status": 0
}
```