Get RAMS compliance status
curl --request GET \
--url https://api.sandbox.brickken.com/rams/compliance-status \
--header 'x-api-key: <api-key>'import requests
url = "https://api.sandbox.brickken.com/rams/compliance-status"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sandbox.brickken.com/rams/compliance-status', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.brickken.com/rams/compliance-status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.brickken.com/rams/compliance-status"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.sandbox.brickken.com/rams/compliance-status")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.brickken.com/rams/compliance-status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"complianceProviderAddress": "0xa90D2503D5D9b80ECC27856Ff76F892B8C02f278",
"principal": "0x2222222222222222222222222222222222222222",
"identityRef": "0x1111111111111111111111111111111111111111111111111111111111111111",
"eligible": true,
"reason": "COMPLIANT",
"reasonCode": 0,
"expiresAt": 0
}
}RAMS Reads & Typed Data
Check RAMS Compliance
Read a principal eligibility record from a ComplianceProvider.
GET
/
rams
/
compliance-status
Get RAMS compliance status
curl --request GET \
--url https://api.sandbox.brickken.com/rams/compliance-status \
--header 'x-api-key: <api-key>'import requests
url = "https://api.sandbox.brickken.com/rams/compliance-status"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sandbox.brickken.com/rams/compliance-status', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.brickken.com/rams/compliance-status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.brickken.com/rams/compliance-status"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.sandbox.brickken.com/rams/compliance-status")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.brickken.com/rams/compliance-status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"complianceProviderAddress": "0xa90D2503D5D9b80ECC27856Ff76F892B8C02f278",
"principal": "0x2222222222222222222222222222222222222222",
"identityRef": "0x1111111111111111111111111111111111111111111111111111111111111111",
"eligible": true,
"reason": "COMPLIANT",
"reasonCode": 0,
"expiresAt": 0
}
}Send
x-api-key. These reads are also x402-payable: call without a key and, where x402 is enabled for the chain, the API answers 402 Payment Required with the amount in the PAYMENT-REQUIRED header. Reads are priced at the cheaper GETTER tier than writes — take the amount from the response rather than from a table.
Provide chainId, principal, and the bytes32 identityRef; optionally override complianceProviderAddress.
The response reports eligibility, expiry, and revocation reason details. A mandate can exist while compliance is ineligible, but canExecute will reject it.Authorizations
Query Parameters
Target chain ID. RAMS is available on Ethereum Sepolia (11155111) only at launch. Decimal and 0x hex values are accepted.
Principal wallet address.
Pattern:
^0x[a-fA-F0-9]{40}$Compliance identity reference (bytes32).
Pattern:
^0x[a-fA-F0-9]{64}$Optional ComplianceProvider contract override.
Pattern:
^0x[a-fA-F0-9]{40}$Response
200 - application/json
Successful response
Show child attributes
Show child attributes