Check OTC Eligibility

Retrieves the client permissions for the OTC Portal.

API Key Permissions Required: Funds permissions - Query and Funds permissions - Deposit

POST /private/CheckOtcClient

Check OTC Eligibility

cURL

curl --request POST \
  --url https://api.kraken.com/0/private/CheckOtcClient \
  --header 'API-Key: <api-key>' \
  --header 'API-Sign: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "nonce": 123
}'

import requests

url = "https://api.kraken.com/0/private/CheckOtcClient"

payload = { "nonce": 123 }
headers = {
    "API-Key": "<api-key>",
    "API-Sign": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'API-Key': '<api-key>',
    'API-Sign': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({nonce: 123})
};

fetch('https://api.kraken.com/0/private/CheckOtcClient', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.kraken.com/0/private/CheckOtcClient"

	payload := strings.NewReader("{\n  \"nonce\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("API-Key", "<api-key>")
	req.Header.Add("API-Sign", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

200

{
  "error": [
    "EGeneral:Invalid arguments"
  ],
  "result": {
    "permissions": [
      "<string>"
    ]
  }
}

{
  "errors": [
    {
      "field": null,
      "value": null,
      "type": "Internal Error",
      "msg": "Internal error",
      "severity": "E",
      "errorClass": "General"
    }
  ]
}

Authorizations

API-Key · string · header · required

The "API-Key" header should contain your API key.

API-Sign · string · header · required

Authenticated requests should be signed with the "API-Sign" header, using a signature generated with your private key, nonce, encoded payload, and URI path.

Body

application/json

This schema represents the request body for checking an OTC client's status. No request body is required as the client information is typically passed through authentication headers.

nonce · integer<int64> · required

Nonce used in construction of API-Sign header

Response

200

application/json

OTC client check result.

Response schema for checking OTC client permissions

error · string[] · required

Kraken API error

result · object

Contains the successful response data

Show child attributes