Capabilities
Activate a regulated capability
Start or resume readiness for a regulated capability such as a linked bank.
POST
Activate a regulated capability
Pass the
capability (linked_bank, bank_payout or bank_onramp) and the country, currency and rail it applies to. Stableyard first checks that the capability is enabled for your app in that country, currency and rail.
- 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 hosted business verification (KYB) enabled for your app. Pass
business.legalNameon the first activation. While the verification link is being prepared,nextAction.typeiscontinue_business_verification: resume the activation to get it. When it is ready,nextAction.urlcarries a third-party-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 usable only once it reports ready: true; check it with List regulated capability readiness. Idempotency-Key is required: identical input returns the original action, and changed input returns 409 idempotency_conflict.
See Off-ramps.Authorizations
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.
Required string length:
8 - 256Pattern:
^[ -~]+$Example:
"enable-linked-bank-user-123-v1"
Path Parameters
Body
application/json