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. It serves as the lowest-level interface for accessing the platform. |
| API Clients | API clients in various languages and frameworks are automatically generated from our API specification whenever we update our platform, making it easier for your engineering team to integrate with it. We automatically generate API clients in many popular languages and frameworks, such as Angular, Java, Kotlin, Python, Ruby, Swift, and TypeScript. All of our API Clients are available in our GitHub Repo. |
| Demo Web SDK | We provide a packaged web SDK as a sample implementation within a Web Component. |
| Demo Apps | We offer complete demo applications that can be referred to in Python, Ruby and Typescript. |
| Partner Portal | The web-based application that your developers and customer success representatives can use to manage 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 (i.e., subscriptions) are set up at this level. |
| Bank | The main object you will use to create your customer experience. Banks serve as the container for your customers as well as a way to manage your product configuration. |
| Customer | The core customer object. Customers can be individuals or businesses. Customers are first-party objects that you will onboard through KYC/KYB to the Cybrid platform. All objects created for your customer will be linked to this object. |
| Counterparty | Counterparties are third-party objects that are used to send and receive value. They do not undergo KYC/KYB processes, but are sanctioned-screened when interacting with. |
| Identity Verification | Identity verifications are used to verify customers, counterparties, bank accounts, and more, as well as for enhanced due diligence and document submission. |
| Account | Accounts are created for customers or banks and can be fiat (used to store fiat currency balances, e.g., USD and CAD), trading (used to store hot wallet cryptocurrency balances, e.g., USDC, USDT, BTC, etc.), storage (used to store cold wallet cryptocurrency balances), and invoice_operations (used to pre-fund BTC Lightning payment operations in USD and BTC). |
| Deposit Address | On-chain wallet address associated with a trading account. On-chain deposits sent to a deposit address will automatically be reconciled to the linked trading account's balance. |
| Deposit Bank Account | A credit-only bank account opened in the customer's or the bank's name, linked to a fiat platform account. Bank deposits sent to a deposit bank account will automatically be reconciled with the associated fiat account balance. |
| External Bank Account | A bank account is added to the platform and associated with a bank, customer, or counterparty. External bank accounts can be used to deposit money, such as ACH Pull, EFT Pull, or withdraw money, such as ACH Push, EFT Push, Wire transfer, RTP, or FedNow. |
| External Wallet | An on-chain wallet address is added to the platform and associated with a bank, customer, or counterparty. External wallets can be used to withdraw cryptocurrency. |
| Quote | Resource created and returned in all request-for-quote operations, such as trades and transfers. |
| Trade | A trade record, representing an executed quote |
| Transfers | A record representing a value moving operation: e.g., funding (moving fiat in/out of accounts on the platform), book (moving value between two or more fiat or trading accounts), crypto (moving crypto in/out of accounts on the platform), instant_funding (instantly depositing into an account on the platform), inter_account (moving crypto between trading and storage accounts, or moving fiat and crypto between a fiat/ trading account and an invoice_operations account) or lightning(sending or receiving a BTC Lightning payment). |
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 5 days ago