BUSINESS CASES
Where this module fits
- API credential lifecycle
- agent authentication
- webhook and SDK integration
v2BUILD · MODULE 17
Manage API access, signing keys, workload identities, webhooks, SDK discovery, and machine integration metadata.
BUSINESS CASES
PRIMARY CONSUMERS
PREREQUISITES
RECOMMENDED WORKFLOW
discover the machine contract and required scopes
register least-privilege credentials and signing keys
validate calls, retries, and event handling
MODULE CONTRACTS
Each operation states whether its request shape is authoritative in OpenAPI, reviewed as a planning profile, or intentionally left as an outline pending an owner schema.
/api/v2/me/capabilitiesReturn effective profile scopes and security features for the authenticated identity.›POSTRegister request signing key/api/v2/security/signing-keysRegister an Ed25519 public JWK after proof of possession and purpose-bound step-up authorization.›GETList account activity/api/v2/account/activityPlanned capability: list normalized, cursor-paginated activity from the services the account is authorized to view.›GETGet account posture/api/v2/account/overviewPlanned capability: return the authenticated account's operational posture across wallets, funding, compliance, billing, and activity.›GETGet countries data/api/v2/general/countriesPlanned capability: list countries data through the authoritative developer-contract and request-security service boundary.›GETGet historical rates/api/v2/general/currencies_historicalPlanned capability: list historical rates through the authoritative developer-contract and request-security service boundary.›GETGet status info/api/v2/general/infoReturn public service identity, version, and environment metadata so a client can confirm it reached the intended Hybrid-Chain V2 gateway before composing requests.›GETGet us states data/api/v2/general/us_statesPlanned capability: list us states data through the authoritative developer-contract and request-security service boundary.›GETGet currencies data/api/v2/reference/currenciesReturn canonical currency and asset-code reference data for validating supported denominations and rendering their precision and presentation metadata consistently.›GETGet status/api/v2/identity/statusReturn the current posture for status through the authoritative trust service boundary.›GETNews publications/api/v2/newsList published newsroom entries through a stable public contract with bounded pagination plus optional category and featured-content filters.›GETNews publication/api/v2/news/{identifier}Return one published newsroom entry by its canonical public identifier for article, feed, or developer-portal presentation.›GETNews publication verification/api/v2/news/{identifier}/verifyReturn the publication's integrity and provenance verification projection separately from its editorial content.›GETV2 capability registry/api/v2/capabilitiesReturn the machine-readable capability registry that maps V2 operations to implementation status, owning domains, business modules, legacy parity, and agent integration context.›GETMain hybrid chain API/api/v2/status/infoReturn the gateway's public availability and compatibility posture for lightweight connectivity checks without exposing private infrastructure or operational controls.›GETList API keys/api/v2/developer/api-keysPlanned capability: list API-key metadata without returning secret material.›POSTCreate API key/api/v2/developer/api-keysPlanned capability: create a scoped API key and return its secret exactly once.›DELETERevoke API key/api/v2/developer/api-keys/{key_uuid}Planned capability: revoke an API key owned by the active account or workspace.›GETList webhooks/api/v2/developer/webhooksPlanned capability: list webhook registrations and delivery posture.›POSTCreate webhook/api/v2/developer/webhooksPlanned capability: register a signed webhook destination and subscribed event types.›PATCHUpdate webhook/api/v2/developer/webhooks/{webhook_uuid}Planned capability: update webhook state, destination, or event subscriptions.›GETGet OpenAPI specification/api/v2/openapi.jsonReturn the machine-readable OpenAPI specification for implemented V2 contracts.›GETList request signing keys/api/v2/security/signing-keysList public request-signing key metadata for the authenticated client.›POSTRevoke request signing key/api/v2/security/signing-keys/{key_id}/revocationsRevoke an active request-signing key after purpose-bound step-up authorization.›POSTCreate step up authorization/api/v2/security/step-upVerify a fresh authenticator code and issue a five-minute purpose-bound authorization.›GETGet portal catalog/api/v2/developer-portalReturn public SDK, environment, authentication, reference, and guide discovery metadata.›GETGet SDK publication catalog/api/v2/developer-portal/sdksReturn official SDK publication status and the authoritative OpenAPI generation contract; an empty package list means no official SDK is currently published.›GETList integration guides/api/v2/integration-guidesList published implementation blueprints by product, industry, use case, and maturity.›GETGet integration guide/api/v2/integration-guides/{guide_slug}Return one versioned integration blueprint and its linked endpoint contracts.›GETList mPC custody chain capabilities/api/v2/explorer/mpc-wallets/custody-chain-capabilitiesList mpc custody chain capabilities from the public Explorer read model, with the identifiers and verification metadata defined by the live contract.›GETGet mPC custody chain capability/api/v2/explorer/mpc-wallets/custody-chain-capabilities/{identifier}Return mpc custody chain capability from the public Explorer read model, with the identifiers and verification metadata defined by the live contract.›