Getting Started
Overview
Welcome to Coinme's crypto-as-a-service API platform! This guide walks you through the high-level integration flow to get you up and running.
Prerequisites
Before you begin, make sure you have:
Obtain your API keys from your Coinme dashboard to authenticate requests
Access to Sandbox environment for testing (Production access granted after certification)
New to Coinme?Contact our team to get your API credentials and sandbox access set up.
Integration Flow
Partners integrating with Coinme follow this three-step user flow:
Create a customer account with KYC verification
Retrieve current crypto prices and fees
Process buy or sell orders
Step 1: Customer Onboarding
Create a customer account with KYC verification. You have two flexible options:
Option A: Use Your Existing KYC
If you already have a KYC process in place, you can leverage it and pass the verified customer data to Coinme.
Option B: Use Coinme's KYC
Let Coinme handle the entire KYC process for your customers with our compliant, streamlined verification flow.
Step 2: Quote
Get a quote for your customer that provides:
- Current cryptocurrency price
- Associated fees and total cost
- Quote expiration time
Step 3: Buy/Sell Transaction
Execute transactions using a transactional quote:
- Create a buy order - Customer purchases crypto
- Create a sell order - Customer sells crypto
Custody Options
Choose how to manage your users' crypto assets:
Custody with Coinme
Let Coinme securely hold user assets. Query balances anytime using the Crypto Asset Balance endpoint.
Best for: Partners who want a fully managed solution
Testing Your Integration
Use the Sandbox environment to test the complete integration flow:
- Test customer onboarding with sample KYC data
- Request quotes and verify pricing calculations
- Execute test buy/sell transactions
- Verify balance updates and transaction statuses
Important: Always test thoroughly in Sandbox before moving to Production
Next Steps
Explore all available endpoints and parameters
Learn how to authenticate your API requests
Need help? Contact our integration support team
Updated about 1 month ago