Retrieve patient profiles by mobile number

Retrieves patient profiles using the mobile number in a workspace. The mobile number must be in the format +<country_code><number>.

By default, it returns a minimal profile with oid, username, fln, gen, dob, abha, ccd, ps. To get the full profile, set full_profile=true.

GET /profiles/v1/patient/by-mobile

Retrieve patient profiles by mobile number

cURL

curl --request GET \
  --url https://api.eka.care/profiles/v1/patient/by-mobile/ \
  --header 'Authorization: Bearer <token>' \
  --header 'client-id: <client-id>'

200

{
  "mobile": "1212121212",
  "fln": "Test user",
  "dob": "2000-01-02",
  "gen": "M",
  "oid": "175074536120088",
  "username": "US0001",
  "abha": "xyz@abdm",
  "ccd": "+91",
  "ps": "P"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

client-id · string · required

Example:

"EC_1431"

Query Parameters

mob · string · required

Example:

"[phone]"

full_profile · boolean · default: false

If true, returns the full patient profile details.

Response

200 - application/json

Patient profile details

mobile · string

Example:

"1212121212"

fln · string

Example:

"Test user"

dob · string<date>

Example:

"2000-01-02"

gen · string

Example:

"M"

oid · string

Example:

"175074536120088"

username · string

Example:

"US0001"

abha · string

Example:

"xyz@abdm"

ccd · string

Example:

"+91"

ps · string

Example:

"P"