Register schema
Registers a custom schema and publishes its version 1. The document must be a valid JSON Schema with known x-specter-type names and markers; internal $ref must resolve, external and recursive $ref are rejected, and caps on size, field count, nesting depth, and $ref count apply. Built-in and reserved names are rejected. Registrations and publications share a per-instance rate limit over a sliding hour; beyond it, 429 with Retry-After.
Authorizations
HS256-signed JWT bearer token, obtained via the OAuth2 client-credentials grant (see Authentication).
Body
The version-1 JSON Schema document (same format as SchemaVersion.document).
Stable merchant-chosen identifier. Lowercase alphanumeric, hyphens, dots and underscores; 1-64 characters; must not start with a dot or hyphen; no consecutive dots; Unicode-normalized to NFC. Collides case-insensitively with built-in and reserved names (transaction, _internal*), case-sensitively with other custom schemas.
^[a-z0-9_][a-z0-9._-]{0,63}$"customer-registration"
Response
Registered schema at version 1
Whether velocity counters carry over from the previous version for field paths present in both versions. When false, rulesets bound to this version count from zero — counters of earlier versions are untouched and keep serving the rulesets bound to them. Blacklist entries are not versioned — they are global and unaffected by this flag. Fixed at publication and immutable thereafter. Always true for version 1.
Null for version 1 of a built-in schema, which ships with the platform.
The JSON Schema document. Each field carries x-specter-type (one of the 23 entries of the type vocabulary — string, integer, number, boolean, email, iban, country-code, currency-code, language-code, date, datetime, url, uuid, phone, ip, amount, pan, masked-pan, scheme-enum, card-funding-type-enum, card-segment-enum, object, array) and optionally x-data-classification (any — the default — pii, pci-pan, pci-sad). A pan field is always pci-pan; masked-pan defaults to pii. Types validate the decision payload at ingestion; markers drive the PCI gate, redaction, and retention. See Schemas.
"customer-registration"
active, deprecated System-assigned monotonic integer per schema, starting at 1. Merchants never choose it.
2