DEALER LOGIN API

This API needs to be used for signing-in to the application using login credentials. A successful sign-in will return a dealer_token, which must be included in the Authorization header for all subsequent API invocations.

This API is mandatory to access all dealer-authenticated endpoints.

🔑 Header Parameters

Header	Type	Description	Example
Content-Type	string	Specifies the media type of the request payload	application/json
x-api-key	string	API key used to authorize the request	{{x-api-key}}

📑 Request Body Parameters

Field	Type	Required	Description	Example / Enum
user_id	string	Yes	Dealer User ID	"DEALER123"
password	string	Yes	Password to validate user	"password123"
api_key	string	Yes	API key provided by SynapseWave	"xyz-api-key"
source	string	Yes	Login source of user	"DEALERAPI"
version	string	No	Application version	"1.0.0"
build_version	string	No	Internal application version	"100"

🟢 Success Response - 200 OK

Content-Type: application/json

Field	Type	Description	Example
status	string	Status of API call	"success"
code	string	Response code to user request	"s-101"
message	string	Success message	"Dealer session created successfully"
data	object	User login response payload	Refer to Data Object Fields

---

📦 Data Object Fields

Field	Type	Description	Example
dealer_token	string	Authentication token to be used with every subsequent request	"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
user_name	string	User's name	"John Dealer"
login_time	string	User's last login time	"2025-01-01 10:00:00"
exchanges	string[]	Exchanges allowed to user	["NSE","BSE"]
bcastExchanges	string[]	Exchanges allowed for market feed data	["NSE"]
product_types	string[]	Product types allowed to user	["CNC","MIS"]
product_types_exchange	object	Product types allowed exchange wise	{"NSE":["CNC","MIS"]}
mpin_enabled	boolean	Flag if user has registered MPIN	true / false
fingerprint_enabled	boolean	Flag if user has registered fingerprint	true / false
user_id	string	User Id (UCC)	"DL12345"
others	object	Additional details	Refer below

📘 Others Object Fields

Field	Type	Description	Example
messageSocket	string	Endpoint of socket.io server for interactive messages	"https://socket.example.com"
broadCastSocket	string	Endpoint of WebSocket server for market feed data	"wss://feed.example.com"
secondBroadCastSocket	string[]	Other market feed server endpoints	["wss://feed2.example.com"]
POA	string	POA status of user	"0"
participantCode	string	Participant code for equities	"PC123"
dervParticipantCode	string	Participant code for derivatives	"DPC456"