Broker Authenticate Webhook
When a broker on Tixstock connects to an exchange, it is required to authenticate the user to be able to link the brokers Tixstock account to the brokers resellers account.
Tixstock will send the brokers login details to an resellers webhook endpoint in plain text via a secure HTTPS connection.
Please note, it is the resellers responsible to correctly authenticate the broker credentials by comparing the supplied credentials against the users details on your system.
If the details are correct the reseller must return their ID for the broker. This will be used to link the users between Tixstock and your system.
Post Data
Parameter | Description |
---|---|
username* | The brokers username or email address required to login to the brokers account on the resellers website. Type: String |
password* | The brokers password sent as cleartext. Type: String |
tixstock_account_is_open* | This will display whether the Tixstock account for the broker is open. If set to false, the reseller will not be able to make any API calls for the broker until the account has been opened by the broker account open webhook. Type: Boolean |
Example Request
{
"data": {
"username": "test@email.co.uk",
"password": "my password",
"tixstock_account_is_open": "true"
},
"meta": {
"type": "broker.authenticate"
}
}
Resellers JSON Response
It is required that resellers provide a valid JSON response back from the webhook request, providing the resellers ID for the broker if successful.
Success Response
{
"broker_id": "1231231",
"success": "true",
"message": "Broker has been successfully authenticated"
}
Error Response
{
"broker_id": null,
"success": "false",
"message": "Broker failed to authenticate"
}