This request returns a challenge to be used in handshake for user authentication.
Authentication is not required.
Event Type |
Permissible API Keys |
challenge
|
Read-only, Read-write, Master |
Sample Sent Message |
{ "event":"challenge", "api_key":"CMl2SeSn09Tz+2tWuzPfdaJdsahq6qv5UaexXuQ3SnahDQU/gO3aT+" } |
Field |
Type | Description |
event | string | The request event type |
api_key | string | The user API key. |
Sample Return if Successful |
{ "event":"challenge", "message":"226aee50-88fc-4618-a42a-34f7709570b2" } |
Field |
Type | Description |
event
|
String | Always challenge |
message | String | The message that user will have to sign for authentication reasons |
Sample Return if Unsuccessful |
{ "event":"error", "message":"Json Error" } |
Field |
Type | Description |
event | string | Always error |
message
|
string | Json Error |