Skip to main content
GET
/
abdm
/
v1
/
profile
cURL
curl --request GET \
  --url https://api.eka.care/abdm/v1/profile \
  --header 'Authorization: Bearer <token>'
{
  "abha_address": "<string>",
  "abha_addresses": [
    "<string>"
  ],
  "abha_number": "<unknown>",
  "address": "<unknown>",
  "day_of_birth": "<unknown>",
  "first_name": "<unknown>",
  "gender": "M",
  "kyc_verified": "<unknown>",
  "last_name": "<unknown>",
  "middle_name": "<unknown>",
  "mobile": "<unknown>",
  "month_of_birth": "<unknown>",
  "pincode": "<unknown>",
  "year_of_birth": "<unknown>"
}

Authorizations

​
Authorization
string
header
required

The API requires a Bearer token (JWT) for authentication.

Headers

​
X-Pt-Id
string

Eka User ID (OID)

​
X-Partner-Pt-Id
string

Partner User ID

​
X-Hip-Id
string

Partner HIP ID

Query Parameters

​
oid
string

OID is used to Identify the user.

Response

OK

​
abha_address
string

Primary/preferred abha address.

​
abha_addresses
string[]

List of abha addresses associated with aadhaar

​
abha_number
null | string

ABHA number assigned to the user.

​
address
null | string

Address of the user.

​
day_of_birth
null | integer

Day of birth of the user.

​
first_name
null | string

User's first name.

​
gender
enum<string>

Gender of the user (M - Male, F - Female, O - Other).

Available options:
M,
F,
O
​
kyc_verified
null | boolean

Indicates whether the user’s KYC is verified.

​
last_name
null | string

User's last name.

​
middle_name
null | string

User's middle name.

​
mobile
null | string

Mobile number of the user.

​
month_of_birth
null | integer

Month of birth of the user.

​
pincode
null | string

Pincode of the user's address.

​
year_of_birth
null | integer

Year of birth of the user.