Skip to main content

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

ParameterTypeRequiredDescriptionExample
user_idstringYesUnique Client code (UCC) assigned to the useruser123

🔑Header Parameters

HeaderTypeRequiredDescriptionExample
api_keystringYesThe API key provided for authentication and authorization.api_key
x-api-keystringYesThe 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

FieldTypeDescriptionExample
statusbooleanStatus of the API call. True for success, False for failure.true
resultobjectAn object containing the user details.{"mobile": "1234567890", "email": "user@xyz.com"}

📑Result Object Structure

FieldTypeDescriptionExample
mobilestringThe registered mobile number of the user12345678
emailstringThe registered email id of the useruser@xyz.com
get/authentication/v1/getUserDetails/{user_id}