Forgot User ID

This API helps user retrieve their user ID by providing their PAN or registered mobile number. Its useful in scenarios where the user forgets their User ID.

🔍Query Parameters

Parameter	Type	Description	Example/ENUM
pan	string	Permanent Account Number (PAN)	ABCDE1234F
mobile_no	string	Registered Mobile Number	9876543210

🔑Header Parameters

Header	Type	Description	Example
Content-type	string	MIME type of the request body	application/json
x-api-key	string	Unique API Key for authentication	x-api-key
api_key	string	(Optional) Alternative auth method	api_key

🟢Response : 200 OK

Returns a JSON response containing the user ID if the PAN or Mobile number is valid.

📑Response Body Schema: application/json

Field	Type	Description	Example
status	string	Status of the API call (e.g., success)	"success"
code	string	Response code for the request	"s-101"
message	string	Informational message about the outcome	"User id fetched successfully"
data	array	Array of user detail objects	Refer to Data Object Fields

📦 Data Object Fields

Important Note on mobile_no and email

These fields are returned as Base64-encoded strings and are not returned as plain text.

You must Base64-decode the values before using them.

Example:

OTk5OTk5OTk5OQ==  →  9999999999

Field	Type	Description	Example
user_id	string	The user's login ID (UCC)	"APITEST"
groupId	string	Group ID the user belongs to	"HO"
dob	string	Date of birth (DD-MM-YYYY)	"01-06-1990"
pan	string	PAN number of the user	"ABCDE1234F"
mobile_no	string	Registered mobile number Base64-encoded	"OTk5OTk5OTk5OQ=="
email	string	Registered email address Base64-encoded	"YXBpdGVzdEB0ZXN0LmNvbQ=="