Skip to main content
POST
Prepare RAMS revoke principal eligibility
Maps to ramsRevokePrincipal. signerAddress must be the ComplianceProvider owner; this admin operation is always client-signed. reason accepts a numeric code 0–8 or a name such as KYC_EXPIRED, AML_FLAG, JURISDICTION_BLOCKED, or OTHER. Revocation makes mandate execution fail its compliance check; it does not rewrite the mandate record.

Authorizations

X-Payment
string
header
required

Base64-encoded x402 payment payload. Supported for x402-eligible agentic methods on /x402/... facades, /prepare-transactions, and eligible /send-transactions retries.

Body

application/json
chainId
string
default:11155111
required

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

Examples:

"11155111"

"0xaa36a7"

signerAddress
string
required

MUST be the ComplianceProvider owner (pre-checked). Never brickken-relayed.

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

Principal whose eligibility is revoked. Must have an active (granted, not revoked) record.

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

Revocation reason: enum name or its integer code — COMPLIANT(0), KYC_EXPIRED(1), AML_FLAG(2), NOT_ACCREDITED(3), NOT_QUALIFIED(4), JURISDICTION_BLOCKED(5), IDENTITY_NOT_FOUND(6), ATTESTATION_REVOKED(7), OTHER(8).

Available options:
COMPLIANT,
KYC_EXPIRED,
AML_FLAG,
NOT_ACCREDITED,
NOT_QUALIFIED,
JURISDICTION_BLOCKED,
IDENTITY_NOT_FOUND,
ATTESTATION_REVOKED,
OTHER
complianceProviderAddress
string

Optional ComplianceProvider contract override; defaults to the chain's configured RAMS ComplianceProvider address.

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

Optional explicit gas limit.

nonce
number

Optional explicit transaction nonce when managing nonces manually.

ownerEmail
string<email>

Optional owner attribution email.

email
string<email>

Alias for ownerEmail where supported.

Response

Prepared unsigned transaction payload.

data
object