Methods

Authenticate

Authenticate via API key HMAC signature

Public · 5 params · Returns response

Method authenticate

Authenticate via API key HMAC signature

Request

Send a JSON-RPC request with method: "authenticate" and the parameters below.

key*string
signature*string
timestamp*integer
passphrase*string
nonce*string

Example

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "authenticate",
  "params": {
    "key": "string",
    "signature": "string",
    "timestamp": 0,
    "passphrase": "string",
    "nonce": "string"
  }
}

Response

On success the server replies with a JSON-RPC response matching the request id and the fields below.

authenticated*boolean
permissions*string[]

Example

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "authenticated": true,
    "permissions": [
      "string"
    ]
  }
}

On failure the server replies with a JSON-RPC error object matching the request id. See Errors for the full list of codes and recovery hints.