Get User Details
This API returns the masked mobile number and email address associated with a user. It is typically used before sending an OTP, so the UI can show the user which contact details the OTP will be sent to (e.g., "OTP sent to XXXXXX9999").
🛣️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 | User's registered mobile number partially masked | "XXXXXX9999" |
| email | string | User's registered email address partially masked | "ap****@test.com" |