The CipherOwl API uses OAuth 2.0 authentication. After registration, you'll receive a client_id and client_secret to obtain access tokens for API requests.

How to Get `client_id` and `client_secret`

Credentials are unique to each user or organization. To obtain your credentials, contact CipherOwl Support. Test credentials for sandbox environments may be provided upon request.

How to Obtain an OAuth Token

Obtain an access token by making a POST request to the OAuth endpoint with your client_id and client_secret.

Example Request to Obtain OAuth Token

curl --request POST \
     --url https://svc.cipherowl.ai/oauth/token \
     --header 'Content-Type: application/json' \
     --data '{
         "client_id": "{YOUR_CLIENT_ID}",
         "client_secret": "{YOUR_CLIENT_SECRET}",
         "audience": "svc.cipherowl.ai",
         "grant_type": "client_credentials"
     }'

var client = new RestClient("svc.cipherowl.ai/oauth/token");
var request = new RestRequest(Method.POST);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\"client_id\":\"{}\",\"client_secret\":\"{YOUR_CLIENT_SECRET}\",\"audience\":\"svc.cipherowl.ai\",\"grant_type\":\"client_credentials\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

package main

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

func main() {

  url := "https://svc.cipherowl.ai/oauth/token"

  payload := strings.NewReader("{\"client_id\":\"{YOUR_CLIENT_ID}\",\"client_secret\":\"{YOUR_CLIENT_SECRET}\",\"audience\":\"svc.cipherowl.ai\",\"grant_type\":\"client_credentials\"}")

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

  req.Header.Add("content-type", "application/json")

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

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

  fmt.Println(res)
  fmt.Println(string(body))
}

HttpResponse<String> response = Unirest.post("https://svc.cipherowl.ai/oauth/token")
  .header("content-type", "application/json")
  .body("{\"client_id\":\"{YOUR_CLIENT_ID}\",\"client_secret\":\"{YOUR_CLIENT_SECRET}\",\"audience\":\"svc.cipherowl.ai\",\"grant_type\":\"client_credentials\"}")
  .asString();

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://svc.cipherowl.ai/oauth/token",
  "method": "POST",
  "headers": {
    "content-type": "application/json"
  },
  "data": "{\"client_id\":\"{YOUR_CLIENT_ID}\",\"client_secret\":\"{YOUR_CLIENT_SECRET}\",\"audience\":\"svc.cipherowl.ai\",\"grant_type\":\"client_credentials\"}"
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

var request = require("request");

var options = { method: 'POST',
  url: 'https://svc.cipherowl.ai/oauth/token',
  headers: { 'content-type': 'application/json' },
  body: '{"client_id":"{YOUR_CLIENT_ID}","client_secret":"{YOUR_CLIENT_SECRET}","audience":"svc.cipherowl.ai","grant_type":"client_credentials"}' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://svc.cipherowl.ai/oauth/token",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{\"client_id\":\"{YOUR_CLIENT_ID}\",\"client_secret\":\"{YOUR_CLIENT_SECRET}\",\"audience\":\"svc.cipherowl.ai\",\"grant_type\":\"client_credentials\"}",
  CURLOPT_HTTPHEADER => array(
    "content-type: application/json"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

import http.client

conn = http.client.HTTPSConnection("svc.cipherowl.ai")

payload = "{\"client_id\":\"{YOUR_CLIENT_ID}\",\"client_secret\":\"{YOUR_CLIENT_SECRET}\",\"audience\":\"svc.cipherowl.ai\",\"grant_type\":\"client_credentials\"}"

headers = { 'content-type': "application/json" }

conn.request("POST", "/oauth/token", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

require 'uri'
require 'net/http'

url = URI("https://svc.cipherowl.ai/oauth/token")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{\"client_id\":\"{YOUR_CLIENT_ID}\",\"client_secret\":\"{YOUR_CLIENT_SECRET}\",\"audience\":\"svc.cipherowl.ai\",\"grant_type\":\"client_credentials\"}"

response = http.request(request)
puts response.read_body

The response includes an access_token for authenticating API requests:

{"access_token":"{your_access_token}","scope":"onchain:read sanction:read","expires_in":86400,"token_type":"Bearer"}

How to Use `access_token`

Include the access_token in the Authorization header as a Bearer token for all API requests.

curl --request GET \ 
     --url https://svc.cipherowl.ai/api/screen/v1/chains/bitcoin/addresses/339khCuymVi4FKbW9hCHkH3CQwdopXiTvA?config=co-high_risk_hops_0 \
     --header 'accept: application/json' \
     --header 'Authorization: Bearer {YOUR_ACCESS_TOKEN}'

Token Expiration

Access tokens expire after a specified period. When you receive a 401 Unauthorized response, request a new token using the same OAuth endpoint and credentials.

Security

Keep your client_id, client_secret, and access_token confidential. Do not expose credentials in public repositories or insecure locations.

If credentials are compromised, immediately contact CipherOwl Support to revoke and replace them.

📘
Note
All OAuth tokens are rate-limited. Monitor your usage to avoid exceeding limits.