Payment handles
Check whether a payment handle is available
Check whether a handle is free before you assign it to a UPA.
GET
Check handle availability
Call this before setting a username or payment handle. The response reports
available and a status of available or taken for the handle in its namespace.
A bare handle such as alice uses the authenticated app’s namespace. A qualified alice@namespace is accepted when the namespace matches the authenticated app. Assign the handle with Set an account’s payment handle.Authorizations
HTTP Basic auth. Username is the Stableyard app ID. Password is the app secret. The optional Stableyard-Version request header must match the environment pin.
Headers
Optional contract-version assertion. Omit it to use the app environment's pinned version. A different supported version is accepted only after that environment is explicitly migrated.
Available options:
2026-09-09 Path Parameters
Example:
"alice"