GET
/
abdm
/
v1
/
profile
cURL
curl --request GET \
  --url https://api.eka.care/abdm/v1/profile \
  --header 'Authorization: Bearer <token>'
{
  "abha_address": "shyam@abdm",
  "abha_number": "12-3456-7856-8912",
  "address": null,
  "day_of_birth": null,
  "first_name": null,
  "gender": "M",
  "kyc_verified": null,
  "last_name": null,
  "middle_name": null,
  "mobile": null,
  "month_of_birth": null,
  "pincode": null,
  "year_of_birth": null
}

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

ABHA address associated with the user.

Examples:

"shyam@abdm"

​
abha_number
string | null

ABHA number assigned to the user.

Examples:

"12-3456-7856-8912"

​
address
string | null

Address of the user.

​
day_of_birth
integer | null

Day of birth of the user.

​
first_name
string | null

User's first name.

​
gender
enum<string>

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

Available options:
M,
F,
O
Examples:

"M"

​
kyc_verified
boolean | null

Indicates whether the user’s KYC is verified.

​
last_name
string | null

User's last name.

​
middle_name
string | null

User's middle name.

​
mobile
string | null

Mobile number of the user.

​
month_of_birth
integer | null

Month of birth of the user.

​
pincode
string | null

Pincode of the user's address.

​
year_of_birth
integer | null

Year of birth of the user.