Activate a regulated capability
Start or resume readiness for a regulated capability such as a linked bank.
capability (linked_bank, bank_payout or bank_onramp) and the country, currency and rail it applies to. Stableyard checks the app entitlement, approved program market and active execution route before creating an action.
- Individual UPAs need a verified email and current identity approval. Any extra information or consent is collected on the Stableyard-hosted form.
- Business UPAs need a program explicitly enabled for hosted business KYB. Pass
business.legalNameon the first activation. When provisioning finishes, the response carries a credential-bearing, provider-hosted verification link: send it only to the authorized business representative, and never log or cache it.
nextAction.url to the account holder. The capability is ready only after provider approval. Idempotency-Key is required: identical input returns the original action, and changed input returns 409 idempotency_conflict.
See Off-ramps.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
Required retry key for this capability activation. Reuse the same key only with the identical account, capability, country, currency, rail, and amount. Changed input returns 409 idempotency_conflict.
8 - 256^[ -~]+$"enable-linked-bank-user-123-v1"
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.
2026-09-09 Path Parameters
Canonical account id returned by the Accounts API.
"acct_123"
Body
Regulated capability to make ready for this UPA.
linked_bank, bank_payout, bank_onramp ISO 3166-1 alpha-2 market for the requested capability.
^[A-Z]{2}$"US"
ISO 4217 currency for the requested capability.
^[A-Z]{3}$"USD"
Stableyard rail code advertised in partner configuration.
1 - 64^[a-z0-9][a-z0-9._-]*$"ach"
Business UPAs only. Required when creating the first hosted KYB application; omit when resuming or activating another capability.
Optional intended amount in the requested fiat currency's atomic unit. Use only when capability eligibility depends on an amount tier.
^[1-9][0-9]{0,79}$"5000"