Skip to main content
GET
Get RAMS compliance status
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

x-api-key
string
header
required

Query Parameters

chainId
string
default:11155111
required

Target chain ID. RAMS is available on Ethereum Sepolia (11155111) only at launch. Decimal and 0x hex values are accepted.

principal
string
required

Principal wallet address.

Pattern: ^0x[a-fA-F0-9]{40}$
identityRef
string
required

Compliance identity reference (bytes32).

Pattern: ^0x[a-fA-F0-9]{64}$
complianceProviderAddress
string

Optional ComplianceProvider contract override.

Pattern: ^0x[a-fA-F0-9]{40}$

Response

200 - application/json

Successful response

data
object