API/Field names
v1.0.0-beta.mdGet API keys
Core rules

Field names

The vocabulary source of truth: the field names the engine accepts, what changed from the earlier documentation, and the two rules that never bend.

Was / is

Earlier documentationThe engineNote
scopescopesAn array, on issuance
untilexpires_atMandatory on issuance
data_releasedata_shareOne of the eight canonical scopes
ceiling.period: once|day|month|yearceiling.period: lifetime|daily|weekly|monthlyThe bucket is computed server-side
ceiling.amount: 200ceiling.amount: 4000Integer, minor unit — never a decimal
counterparty_not_permittedconstraint_violatedOne refusal reason for all constraints
facetokenremovedThe identifier is the auth.users UUID minted by the engine

Accepted on mandate-issue

FieldTypeMeans
granted_byuuidThe human who authorises
granted_tostringAn opaque machine identifier — never the label a person reads
granted_to_kindenumWhat kind of holder it is
agent_display_namestring ≤64The readable name shown on authorisation, revocation and receipts
agent_descriptorstring ≤140One line saying what the agent does
scopesarrayExact match, no wildcard, no dot-notation
constraintsobjectmerchant_allowlist, category_allowlist, country_allowlist
ceilingobjectkind: amount|count|both|none, amount, currency, count, period
expires_attimestampMandatory
step_up_ofuuidThe mandate this one steps up from
proof.capture_idstringA live capture no older than five minutes

Two immutables

  • Money is always an integer in the minor unit, in and out. 4000 is forty dollars; a float is refused with AMOUNT_INVALID.
  • Recurrence lives in ceiling.period and nowhere else. There is no recurring scope, and no dot-notation in a scope.
Sidaxis is the human authorisation layer. It never moves money, holds funds or settles. The machine-readable contract is openapi.yaml.
Sidaxis API documentationQuickstartAuthenticationHosted or headlessSandbox and productionIdempotencyRate limitsErrors and refusalsField namesWebhooksAssuranceThe document ruleAlias availabilityMerchant themeMCP serverCompatibilityStatusRoadmapChangelogIdentityEnroll an identityRecognise a personDisclose an attributeMandatesThe eight scopesIssue a mandateCheck an actionConsume a mandateRead a mandateRevoke a mandateReceiptsRead a merchant's receiptsVerify a receiptHosted sessionsCreate a hosted sessionConsume a hosted sessionOne Face for agents