Create Recipient
Creates a new recipient and initiates KYB verification. Accounts (on-ramp or off-ramp) are created separately after KYB approval.Request
string
required
Business name
string
default:"business"
Business type
string
Your internal reference ID for this recipient
object
Physical address. Optional at creation, but required before creating off-ramp accounts.
Response
List Recipients
Returns all recipients with KYB status, account counts, and volume summaries.Query Parameters
integer
default:"1"
Page number
integer
default:"20"
Results per page (max 100)
Response
Get Recipient
Returns a single recipient with full detail, including all on-ramp and off-ramp accounts.integer
required
Recipient ID
Response
Create On-Ramp Account
Creates a virtual bank account for the recipient. Requires KYB approval.integer
required
Recipient ID
integer
required
OrgWallet ID where USDC/USDT will be delivered
string
default:"USDC"
Destination asset:
USDC or USDTstring
default:"ach"
Payment rail:
ach, fedwire, or swiftResponse
Create Off-Ramp Account
Creates a crypto deposit address for the recipient. Requires KYB approval and a recipient address on file.integer
required
Recipient ID
integer
required
Source OrgWallet ID (where crypto is sent from)
string
default:"USDC"
Source crypto asset
string
default:"ach"
Payment rail:
ach, fedwire, or swiftobject
required
Bank account where USD will be delivered
Response
List Off-Ramp Accounts
integer
required
Recipient ID
Response
Returns an array of off-ramp accounts for the recipient.Archive Recipient
Archives a recipient, removing them from all lists.integer
required
Recipient ID