v1

latestOpenAPI 3.0.32026-07-26229361630.0 KB

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/

Query parameters

mobstring required
Example:+911234567890
full_profileboolean

If true, returns the full patient profile details.

Headers

client-idstring required
Example:EC_1431

Response

Patient profile details

mobilestring
flnstring
dobstring date
genstring
oidstring
usernamestring
abhastring
ccdstring
psstring

Example response

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