Get abdmv1profile — eka-developer-apis

v1

latestOpenAPI 3.0.32026-07-26229361630.0 KB

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>

get/abdm/v1/profile

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

{"stackTrail":"components:schemas:ProfileResponse:properties:abha_number","oasType":"schema","type":"unknown","description":"ABHA number assigned to the user."}

{"stackTrail":"components:schemas:ProfileResponse:properties:address","oasType":"schema","type":"unknown","description":"Address of the user."}

{"stackTrail":"components:schemas:ProfileResponse:properties:day_of_birth","oasType":"schema","type":"unknown","description":"Day of birth of the user."}

district_codestring

district_namestring

{"stackTrail":"components:schemas:ProfileResponse:properties:first_name","oasType":"schema","type":"unknown","description":"User's first name."}

full_namestring

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

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

{"stackTrail":"components:schemas:ProfileResponse:properties:kyc_verified","oasType":"schema","type":"unknown","description":"Indicates whether the user’s KYC is verified."}

{"stackTrail":"components:schemas:ProfileResponse:properties:last_name","oasType":"schema","type":"unknown","description":"User's last name."}

{"stackTrail":"components:schemas:ProfileResponse:properties:middle_name","oasType":"schema","type":"unknown","description":"User's middle name."}

{"stackTrail":"components:schemas:ProfileResponse:properties:mobile","oasType":"schema","type":"unknown","description":"Mobile number of the user."}

{"stackTrail":"components:schemas:ProfileResponse:properties:month_of_birth","oasType":"schema","type":"unknown","description":"Month of birth of the user."}

{"stackTrail":"components:schemas:ProfileResponse:properties:pincode","oasType":"schema","type":"unknown","description":"Pincode of the user's address."}

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

{"stackTrail":"components:schemas:ProfileResponse:properties:year_of_birth","oasType":"schema","type":"unknown","description":"Year of birth of the user."}