Skip to main content

Family summary

SurfaceVisibilityAuthoritative artifact
Client Request / OperatorRestrictedpackages/api-docs/merged/client-request-swagger.json
KYC OperatorRestrictedrust-packages/kyc-operator/app/src/api/api-docs.yaml

Contract snapshot

SurfacePath shape in source artifactRequest / response posturePublic-doc treatment
Client Request / Operator/v2/encryption-key, /v2/requestJSON key retrieval plus encrypted application/octet-stream request submission and receipt/error responsesBoundary summary only; use public REST auth, signing, and encryption pages for the shared write-path concepts
KYC Operator/kyc/v1/* including health, encryption-key, enrollment, auth, status, and root-key operationsJSON control/status responses plus binary enrollment payload submission where the artifact calls for encrypted KYC dataBoundary summary only; public docs describe visibility and ownership, not a complete public contract

Visibility rule

These families are not public by default. Public docs may describe their boundary, audience, and source artifacts without implying general public availability.

Public-route behavior

Route typePublic behavior
Current family routeThis page is the canonical public boundary summary for restricted operator and compliance-oriented API families
Historical deep linksOlder operator/client-request/KYC detail links resolve back to this boundary summary rather than exposing a deeper public contract
Retired raw-spec mirror URLs/api-specs/operator-client-request.json and /api-specs/operator-kyc.yaml are handled as boundary-continuity routes, not as public generated-spec publication
Shared write-path conceptsPublic readers should use REST Authentication, Request Signing Reference, and Request Encryption Reference when they need the public-facing explanation of signing and encrypted submission posture

Boundary notes

TopicPublic contract
AudienceOperator and compliance-oriented readers only
Generated specsPublic Mintlify does not publish generated operator or KYC spec bundles
Public-doc scopeThis page is a boundary and source-ownership summary, not a public endpoint catalog
Escalation pathUse support or the owning operational process when a restricted-surface contract is needed but not published publicly
Historical route handlingOlder public operator/client-request/KYC detail links resolve back to this boundary summary rather than exposing a deeper public contract

Authoritative sources

  • packages/api-docs/merged/client-request-swagger.json
  • rust-packages/kyc-operator/app/src/api/api-docs.yaml

Route contract

Use this page when you need to know whether a surface is operator-oriented, compliance-oriented, or otherwise restricted before looking for deeper API detail.
Last modified on April 12, 2026