POST
https://api.stableyard.fi
/
sdk
/
v1
/
register
curl -X POST https://api.stableyard.fi/sdk/v1/register \
  -H "x-sdk-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "partnerId": "your_partner_id",
    "username": "alice",
    "addresses": ["0x742d35Cc6634C0532925a3b844Bc9e7595f..."]
  }'
{
  "success": true,
  "data": {
    "userId": "user_abc123def456",
    "username": "alice",
    "paymentAddress": "alice@your_partner_id",
    "vaultAddress": null,
    "addresses": ["0x742d35Cc6634C0532925a3b844Bc9e7595f..."],
    "kycStatus": "pending",
    "createdAt": "2024-01-15T10:30:00Z"
  },
  "requestId": "req_xyz789"
}
Register a new Money Account for a user. This creates their universal payment identity on the Stableyard network.

Authentication

x-sdk-key
string
required
Your API authentication key

Body Parameters

partnerId
string
required
Your partner identifier
username
string
required
Unique username for the account (3-20 characters, alphanumeric and underscores)
addresses
string[]
required
Array of wallet addresses to link to this account
preferredSettlementChain
integer
Preferred chain ID for settlements (e.g., 8453 for Base)
preferredSettlementToken
string
Preferred token for settlements (e.g., “USDC”)

Response

success
boolean
Indicates if the request was successful
data
object
User account data
curl -X POST https://api.stableyard.fi/sdk/v1/register \
  -H "x-sdk-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "partnerId": "your_partner_id",
    "username": "alice",
    "addresses": ["0x742d35Cc6634C0532925a3b844Bc9e7595f..."]
  }'
{
  "success": true,
  "data": {
    "userId": "user_abc123def456",
    "username": "alice",
    "paymentAddress": "alice@your_partner_id",
    "vaultAddress": null,
    "addresses": ["0x742d35Cc6634C0532925a3b844Bc9e7595f..."],
    "kycStatus": "pending",
    "createdAt": "2024-01-15T10:30:00Z"
  },
  "requestId": "req_xyz789"
}

Usage Notes

Check username availability first — Before calling /register, use /check-username to verify the username is available.

Username Rules

  • 3-20 characters
  • Alphanumeric and underscores only
  • Case-insensitive
  • Must be unique within your partner namespace