Skip to main content
Pick the pattern that matches who your customers are and how their money moves. Each one lists the parties to confirm, the gates in order, and what works where today.

Embedded ramps for individuals

People fund from a US bank and cash out to their own bank, inside your app.

Platform for business customers

Companies get US bank access through your product after hosted verification.

Crypto-only payouts

Stablecoin to wallets, accounts and handles, with no verification.

Pattern: Embedded ramps for individuals

Use when: a consumer app, wallet or fintech gives individual users a USD on-ramp and an off-ramp to their own bank, inside its own product.
1

Create the account

POST /v2/accounts with subjectType: "individual" and the user’s wallet. See Universal Payment Account.
2

Verify the email

A code Stableyard emails, or your own assertion where Stableyard has enabled it. See Email verification.
3

Verify identity

POST /v2/accounts/{accountId}/kyc/session, then send the user to the provider-hosted verificationUrl. See Individual KYC.
4

Activate the bank capabilities

bank_onramp to fund, linked_bank to cash out. Each can return a one-time Stableyard-hosted form. See Capability activation.
5

Issue an on-ramp account

POST /v2/accounts/{accountId}/onramp-bank-accounts, then show the deposit instructions. See On-ramp accounts.
6

Link the user's bank

POST /v2/accounts/{accountId}/bank-accounts with the country’s fields. See Bank accounts.
7

Pay out

POST /v2/payments with destination.type: "bank_account". The wallet funds the payment’s escrow. See Sending payments.
Verification needs a person. Every user completes an identity check hosted by a verification provider and, for each bank capability, a form hosted by Stableyard. No API accepts identity documents from you.
Stableyard enables: Identity & KYC, the on-ramp, the linked-bank route for each country, and External Bank Transfer for one-time bank transfers.

Pattern: Platform for business customers

Use when: your customers are companies, such as merchants, suppliers or payroll clients, and each needs US bank access through your product.
1

Create the account

POST /v2/accounts with subjectType: "business". Add a displayProfile for how payers see the company. See Universal Payment Account.
2

Start business verification

POST /v2/accounts/{accountId}/capability-activations with capability: "linked_bank" and business.legalName. A business skips the email and individual identity steps. See Business KYB.
3

Send the representative the hosted link

continue_business_verification means the link is not ready: send the same request again. complete_compliance carries the link. Wait for ready: true. See Capability activation.
4

Fund in USD, if you need it

Activate bank_onramp on the same approved company, without business, then issue an on-ramp account. See On-ramp accounts.
5

Link the company's US bank

POST /v2/accounts/{accountId}/bank-accounts with country: "US". See Bank accounts.
6

Pay out

POST /v2/payments with destination.type: "bank_account". See Sending payments.
Stableyard enables: business verification for the banking program, plus the on-ramp and the US linked-bank route. Until it is enabled, a business activation is refused.

Pattern: Crypto-only payouts

Use when: value stays in stablecoin: payouts to wallets, transfers between your customers by handle, or top-ups to a reusable deposit address.
1

Create the account with a wallet

POST /v2/accounts with wallets. See Universal Payment Account.
2

Set the payment source

PUT /v2/accounts/{accountId}/payment-source names the wallet or Vault that funds sends. See Sending payments.
3

Preview the send

POST /v2/payments/preview. Proceed only when your source’s funding option reports available: true.
4

Create and confirm it

POST /v2/payments with a crypto_wallet, payment_handle or upa destination, then POST /v2/payments/{paymentId}/confirm with the proof nextAction asks for.
5

Collect, if you need it

Give a customer a reusable address with POST /v2/accounts/{accountId}/deposit-addresses. See Depositing funds.
Chains and assets come from networks in GET /v2/partners/config, not from a table. See Supported regions and currencies.

Confirm before building

1

Name the customer of record

Decide individual or business for every customer type. It cannot be changed after creation.
2

Read your configuration

compliance.partnerKyb.status is approved and the products you need are available. See Going live.
3

Check coverage for your markets

Fiat is enabled per country, per rail and per app. See Supported regions and currencies.
4

Decide who signs

Stableyard never signs for a connected wallet. Your user or your platform does.
5

Assign support ownership

Rejected verification, expired links and payments that need intervention all reach a person. Decide whose.

Next: Quickstart

Run the embedded-ramps pattern end to end on staging.