Platform Overview
What are the core components of Cybrid API platform?
The Cybrid Platform is an API solution for fintech developers, enabling the creation of both traditional financial applications and next-generation cryptocurrency-based products — these range from on-and-off-ramp applications to more complex solutions, such as stablecoin cross-border remittance and B2B solutions.
The Cybrid platform offers an end-to-end comprehensive API experience for fintech developers, from onboarding customers with KYC/KYB and opening bank accounts in their names, to enabling fiat money movement, cryptocurrency trading and custody, and transmission to international regions.
Platform Stack
The platform consists of multiple different component layers:
| Component | Description |
|---|---|
| RESTful API | An OpenAPI 3.0 RESTful API designed to interact with the Cybrid Platform. |
| API Clients | Auto-generated clients in Angular, Java, Kotlin, Python, Ruby, Swift, TypeScript. |
| Demo Web SDK | A packaged web SDK sample. |
| Demo Apps | Complete demo apps in Python, Ruby and Typescript. |
| Partner Portal | Web-based application for managing your integration with the Cybrid platform. |
Platform Core Resources
Understanding the core resources provided by the Cybrid platform is essential when starting your integration. The table below outlines the core models you'll be working with as you develop your solution.
| Model | Description |
|---|---|
| Organization | The root object under which all banks are created. Webhooks are set up at this level. |
| Bank | The main object for creating customer experiences and managing product configuration. |
| Customer | The core customer object. Can be individuals or businesses, onboarded through KYC/KYB. |
| Counterparty | Third-party objects for sending/receiving value. Sanctioned-screened, no KYC/KYB. |
| Identity Verification | Used to verify customers, counterparties, bank accounts, and for EDD. |
| Account | Created for customers/banks. Types: fiat, trading, storage, invoice_operations. |
| Deposit Address | On-chain wallet address linked to a trading account. |
| Deposit Bank Account | Credit-only bank account linked to a fiat platform account. |
| External Bank Account | Bank account added to platform, associated with bank, customer, or counterparty. |
| External Wallet | On-chain wallet address for withdrawing cryptocurrency. |
| Quote | Resource created in all request-for-quote operations. |
| Trade | A trade record representing an executed quote. |
| Transfers | Record representing value movement: funding, book, crypto, instant_funding, etc. |
The Importance of the Bank Model
While the root resource is an Organization, it's really the Bank that you'll predominantly interact with. The Bank is where key product configuration options are set, influencing the customer experience. These options include:
- Bank Type: A bank is in either Sandbox or Production mode. When you register with the Cybrid platform, a bank is initially created in Sandbox mode. You can create as many banks in Sandbox mode as you like. Production banks can only be created by the Cybrid team.
- Country Code: Each bank is associated with a single country of operation, identified by the Country Code, such as US or Canada. This determines the locale for KYC/KYB and funding methods, ensuring that user onboarding, money transfers, and bank account choices are correctly aligned with the banks and document types of that country.
- Fiat Account Assets: Each bank has a single base fiat asset to operate with, such as supporting USD for a US bank or CAD."
- Supported Trading Symbols: The list of trading symbols, such as BTC-USD or USDC-USD, that the bank will
support. To open
tradingaccounts in a specific cryptocurrency like BTC, the associated trading symbol must be configured at the bank for that asset. - Supported Payout Symbols: The list of payout symbols, e.g., MXN-USD, and countries, e.g., MXN, that the bank supports.
- Features: The list of features that the bank will support:
attestation_identity_records: Deprecated.attestation_identity_records_v2: Contact customer support for details.kyc_identity_verifications: Default KYC/ KYB selection.individual_customers: Bank supports onboarding individuals.business_customers: Bank supports onboarding businesses.
With a clear understanding of the core components and data models, begin your development in the Sandbox environment.
Updated about 2 months ago