Skip to main content
Pods Ramp lets your application own the user experience while Pods handles local KYC/AML integration and fiat-to-crypto money movement. A user completes reusable KYC once, then moves money across Pix and foreign USD rails through a single set of Swap v2 quote routes.
Pods Ramp is live today for Brazil (Pix) and foreign USD (WIRE/ACH), and is expanding to more countries in Latin America. Onramp, offramp, and ramp-to-yield all run through GET /v2/swap/quote — originChain/destinationChain select the rail and tokenIn/tokenOut select the currency or on-chain asset.

​
Introduction

​
Authentication

Every request requires:
  • The key identifies your customer. Fee configuration and strategy catalog are scoped to it.
  • Success responses are the bare JSON body (HTTP 200). Errors use { "error": { "code", "message", "details?" } }.
  • Keep the API key on your backend — never expose it in a browser app.
Don’t have a key yet? Get an API key.

​
Integration flow

1

Configure Sumsub reusable KYC

Add the local KYC/AML provider as a reusable identity recipient in Sumsub and configure the pods-ramp-level verification level. Your user completes identity verification through Sumsub WebSDK in your app.Full guide: Set up Pods KYC.
2

Submit the share token to Pods

After Sumsub returns completed + GREEN, your backend generates a fresh Sumsub share token and submits it to Pods with the user’s tax id, applicant id, email, and wallet address:
The response returns a kycUserId — store it for status checks. Full guide: Set up Pods KYC.
3

Poll approval status

Local provider validation is asynchronous. Poll until the Ramp profile reaches approved, which enables money movement:
Full guide: Track Pods Ramp status.
4

Check remaining limits

Before requesting a quote, check how much of the customer’s on-ramp and off-ramp allowance remains for the requested currency:
The response reports, for each direction, the remaining amount in the requested currency and the remaining global USD cap, plus a blocked flag if the KYC provider has suspended the account. The top-level remaining and remainingGlobalUsd fields are deprecated aliases for the off-ramp values — read onramp/offramp directly instead. If no ramp provider applies to this customer, the response is { "provider": null }.
5

Get a quote

Once approved, request an onramp, offramp, or ramp-to-yield quote. originChain/destinationChain select the rail; tokenIn/tokenOut select the currency or asset:
The response includes payment instructions (Pix copy-paste or bank details) on onramps, or transactionData to sign on offramps. Full guide: Move money with Pods Ramp.
6

Execute

The user pays via the local rail (onramp has no on-chain transaction to sign), or your app signs the returned transactionData from the approved wallet (offramp):
Full guide: Move money with Pods Ramp.
7

Track money movement

Track the onramp, offramp, or yield flow to fulfilled with the quote’s quoteId:
Full guide: Track Pods Ramp status.