Skip to main content
To use certain WebSocket channels, you must authenticate with your User and API keys.

​
Request

{
    "id": "ed72693c-1545-4fa1-8a10-aca7cf5419a6",
    "data": {
        "userKey": "<your user key>",
        "apiKey": "<your API key>"
    }
}

​
Successful Response

{
    "id": "ed72693c-1545-4fa1-8a10-aca7cf5419a6",
    "success": true,
    "operation": "Authenticate"
}

​
Unsuccessful Response

{
    "id": "ed72693c-1545-4fa1-8a10-aca7cf5419a6",
    "success": false,
    "operation": "Authenticate",
    "errorMessage": "<Error Message>",
    "errorCode": "<Error Code>"
}

​
Error Codes

​
SessionAlreadyAuthenticated
Error Code
Session is already authenticated
​
DataRequired
Error Code
Data is required
​
ApiKeyRequired
Error Code
ApiKey is required
​
UserKeyRequired
Error Code
UserKey is required
​
TooManyRequests
Error Code
Too many requests
​
Forbidden
Error Code
Access to this resource is forbidden. Please contact customer support for assistance
​
UnhandledException
Error Code
Global Error
​
InvalidKey
Error Code
Key is invalid
​
Unauthorized
Error Code
Unauthorized