Skip to main content
GET
cURL

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.

Example:

"shyam@abdm"

abha_addresses
string[]

List of abha addresses associated with aadhaar

abha_number
null | string

ABHA number assigned to the user.

Example:

"12-3456-7856-8912"

address
null | string

Address of the user.

day_of_birth
null | integer

Day of birth of the user.

district_code
string
district_name
string
first_name
null | string

User's first name.

full_name
string
gender
enum<string>

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

Available options:
M,
F,
O
Example:

"M"

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.

profile_photo
string

Base64-encoded profile photo.

state_code
string
state_name
string
sub_district_code
string
sub_district_name
string
town_code
string
town_name
string
village_code
string
village_name
string
ward_code
string
ward_name
string
year_of_birth
null | integer

Year of birth of the user.