ready is true.
The three capabilities
Activate each capability you use: each records the customer’s consent to that service, and your app must be entitled to each one.
Each activation also names a
country (ISO 3166-1 alpha-2), a currency (ISO 4217) and a rail, such as ach. Send amountAtomic only when eligibility depends on an amount tier.
What activation needs first
Activation is idempotent
Idempotency-Key is required, 8 to 256 printable characters. Replaying the identical body with the same key returns the current state of the original action. A changed body with the same key is refused with 409 idempotency_conflict.
A new key starts a new action. Use one when the customer lost the hosted page: the new link replaces the old one, which stops working.
The hosted form
For anindividual, complete_compliance carries a one-time link to a Stableyard-hosted page. On it the customer:
- Confirms a code Stableyard emails to the account’s verified address.
- Supplies only the details their identity verification did not already provide.
- Reviews and consents to the service.
Statuses
Next actions
Read every capability
capabilities array means nothing has been activated on this account. Read ready and nextAction; never keep an old hosted URL.
Business accounts
A business passes one hosted business verification, and every capability rests on that approval. It opens US bank rails only. See Business KYB.Errors
Webhooks
Related
- Onboarding overview: the gates before activation.
- On-ramp accounts: what
bank_onrampunlocks. - Bank accounts: what
linked_bankpays out to. - Choose your pattern: which capabilities each integration needs.
Next: Payments
The Payment object: intent, destinations, frozen snapshots and states.