GET /abdm/v1/profile

Fetches the ABHA profile of the User. <Note>Please cache these results locally. We do not recommend calling this API on every page load. Evict the cache when there is profile update.</Note>

Request

Base URL
https://api.eka.care
Auth
HTTP bearer
TypeScript
https://skmtc.dev/eka/apis/eka-developer-apis/docs/abdm/v1/profile/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

oidstring

OID is used to Identify the user.

Headers

X-Pt-Idstring

Eka User ID (OID)

X-Partner-Pt-Idstring

Partner User ID

X-Hip-Idstring

Partner HIP ID

Response

abha_addressstring

Primary/preferred abha address.

abha_addressesstring[]

List of abha addresses associated with aadhaar

abha_numberunknown

addressunknown

day_of_birthunknown

district_codestring

district_namestring

first_nameunknown

full_namestring

gender'M' | 'F' | 'O'

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

kyc_verifiedunknown

last_nameunknown

middle_nameunknown

mobileunknown

month_of_birthunknown

pincodeunknown

profile_photostring

Base64-encoded profile photo.

state_codestring

state_namestring

sub_district_codestring

sub_district_namestring

town_codestring

town_namestring

village_codestring

village_namestring

ward_codestring

ward_namestring

year_of_birthunknown

Changes

No recorded changes to this operation across all 1 revision of this API.