Informations
- OpenAPI version:
3.0.3
Overview
ParaSTA Platform User-Facing API 1.0.0-draft
Section titled “ParaSTA Platform User-Facing API 1.0.0-draft”OpenAPI specification for ParaSTA user-facing features (Auth / Account / Wallet / DID / Asset / Transfer / Exchange).
Source design documents: design/system-api.md index and per-service design/system-api-{service}.md.
Operator (/admin) and platform operations (/admin/platform) APIs are out of scope for this specification.
Common patterns:
- Prepare / Execute 2-step: operations requiring signing or 2FA use
{action}/prepare(stateless) +{action}(Idempotency-Key required). - Asynchronous operations: when Execute returns
202 { jobId, status }, pollGET {action}/{jobId}. Use theRetry-Afterresponse header. - Idempotency: POSTs with side effects require the
Idempotency-Keyheader ({PREFIX}_IDEMPOTENCY_KEY_REQUIRED/_CONFLICT). - Error envelope:
{ code, message, details }.
Authentication
Section titled “ Authentication ”BearerAuth
Section titled “BearerAuth ”Authorization: Bearer {accessToken}.
Security scheme type: http
Bearer format: JWT
ApiKeyAuth
Section titled “ApiKeyAuth ”Server-to-server authentication (PASS callback).
Security scheme type: apiKey
Header parameter name: X-Api-Key
PassTokenHeader
Section titled “PassTokenHeader ”Used for registration/recovery sub-step calls (regId / recoveryId paths).
Entry-point endpoints use the body passToken field instead (no security scheme).
Security scheme type: apiKey
Header parameter name: X-Pass-Token