Get User Details
The GetUserDetails API is used to retrieve mobile number and email address associated with a specific user. This information can be useful for sending OTP (One-Time Password) or for other user communication purposes.
🛣️Path Parameters
| Parameter | Type | Required | Description | Example |
|---|
| user_id | string | Yes | Unique Client code (UCC) assigned to the user | user123 |
| Header | Type | Required | Description | Example |
|---|
| api_key | string | Yes | The API key provided for authentication and authorization. | api_key |
| x-api-key | string | Yes | The x-api-key used for identifying the requesting client application. | x-api-key |
🟢Success Response - 200 Ok
If the user details are fetched successfully, the response will contain
| Field | Type | Description | Example |
|---|
| status | boolean | Status of the API call. True for success, False for failure. | true |
| result | object | An object containing the user details. | {"mobile": "1234567890", "email": "user@xyz.com"} |
📑Result Object Structure
| Field | Type | Description | Example |
|---|
| mobile | string | The registered mobile number of the user | 12345678 |
| email | string | The registered email id of the user | user@xyz.com |