Ramp Partner Integration Guide¶
Overview¶
BRIJ provides two integration tiers for ramp partners, each designed for different use cases and levels of integration depth. This guide helps you choose the right tier and provides references to detailed documentation for each approach.
Integration Tiers¶
Tier 1: Redirect Integration¶
In Tier 1 integration, BRIJ acts as an aggregator for your crypto on/off-ramp services. Your payment options are displayed alongside other partners on the BRIJ platform. When customers select your service, they are redirected to your platform to complete the transaction.
Best for:
- Partners with an existing customer-facing platform
- Partners who want to handle their own KYC and transaction flow
- Quick integration with minimal development effort
How it works:
- You sync your payment options to BRIJ
- BRIJ displays your services to customers
- BRIJ requests quotes from your API
- Customers who select your service are redirected to your platform
- Customers complete KYC and transactions on your platform
Tier 2: Full Integration¶
In Tier 2 integration, BRIJ handles the complete customer experience through an embedded widget. BRIJ performs initial KYC verification, and you receive verified customer data and attestations only after explicit user consent. You can define additional KYC requirements based on your compliance needs.
Best for:
- Partners who want to leverage BRIJ's KYC infrastructure
- Partners who prefer to receive pre-verified customer data
- Seamless customer experience without redirects
How it works:
- You sync your payment options and set your requirement policy
- Customers complete initial KYC through the BRIJ Widget
- Customers select your service and complete any additional KYC requirements
- Customers consent to share their data with you
- You receive verified customer data and attestations via webhook
- BRIJ creates orders through your API
- You manage the order lifecycle through the Partner API
Comparison¶
| Aspect | Tier 1 (Redirect) | Tier 2 (Full Integration) |
|---|---|---|
| Customer UI | Your platform | BRIJ Widget |
| KYC handling | You handle | BRIJ handles initial KYC |
| Customer data | Collected by you | Shared via API after consent |
| Order creation | On your platform after redirect | Via Create Order request from BRIJ |
| Transaction completion | On your platform | Within BRIJ Widget |
| Integration effort | Lower | Higher |
| Customer friction | Redirect required | Seamless experience |
Common Requirements¶
Both integration tiers require:
- API Key: Provided by BRIJ for authentication
- Payment Options: Sync your supported countries, currencies, payment methods, and limits
- Quote Endpoint: Return live pricing for transactions
- Signature Verification: Verify requests originate from BRIJ
Getting Started¶
- Contact BRIJ to obtain your API key and discuss your integration requirements
- Review the Authentication documentation
- Choose your integration tier based on your needs
- Follow the detailed guide for your chosen tier: