Platform Intro

Understanding the Cybrid Platform and key concepts

The Cybrid Platform is an API solution for fintech developers that can be used to develop traditional financial applications as well as next generation cryptocurrency based products: from on and off ramp applications to more complex applications, such as stablecoin cross-border remittance and B2B solutions.

The Cybrid platform provides an end-to-end API experience for fintech developers: from enabling the initial onboarding of their customers with KYC/ KYB, through opening bank accounts in their customers' name and enabling fiat money movement, to cryptocurrency trading and custody, and all the way to transmission to international regions.

Platform stack and core resources

The platform is composed of several different component layers:

Component	Description
RESTful API	An OpenAPI 3.0 RESTful API used to interact with the Cybrid Platform. The lowest level interface that you can use to interact with the platform.
API Clients	API clients in various languages and frameworks are auto-generated from our API spec on each update to our platform to make it easier for your engineering team to integrate. We automatically generate API clients in many popular languages and frameworks: e.g., Angular, Java, Kotlin, Python, Ruby, Swift and Typescript. All of our API Clients are available in our GitHub Repo .
Demo Web SDK	We offer a packaged web SDK as a sample implementation in a Web Component.
Demo Apps	We also offer full demo applications that can be referred to in Python, Ruby and Typescript.
Partner Portal	The web-based application your developers and customer success reps can use to manage your integration with the Cybrid platform.

Core resources

Understanding the core resources offered by Cybrid Platform is important when beginning your your integration.

The table below covers the core models that you'll be interacting with as you build out your solution:

Model	Description
Organization	The root object under which all banks are created. Webhooks (i.e., subscriptions) are created at this level.
Bank	The main object that you will use to create your customer experience. Banks are the container for your customers as well as 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 you create for your customer will be linked to this object.
Counterparty	Counterparties are third-party objects that are used to send and receive value. Counterparties do not go through KYC/ KYB, but rather are sanctioned screened when interacted with.
Identity Verification	Identity verifications are used to verify customers, counterparties, bank accounts, etc. as well as for enhanced due diligence and document submission.
Account	Accounts are created for customers or banks, 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 lightninig payment operations in USD and BTC).
Deposit Addresses	On-chain wallet address associated to a `trading` account. On-chain deposits sent to a deposit address will automatically be reconciled to the associated `trading` account's balance.
Deposit Bank Account	Credit-only bank account opened in the customer's or bank's name. Associated to a `fiat` account. Bank deposits sent to a deposit bank account will automatically be reconciled to the associated `fiat` account balance.
External Bank Accounts	A bank account added to the platform and associated to a bank, customer or counterparty. External bank accounts can be used to deposit money, e.g., ACH Pull, EFT Pull, or withdraw money, e.g., ACH Push, EFT Push, Wire, RTP, FedNow.
External Wallets	An on-chain wallet address added to the platform and associated to a bank, customer or counterparty. External wallets can be used to withdraw cryptocurrency.
Quote	Resource created and returned in all request-for-quote operations: e.g., 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 `fiat` or two `trading` accounts), `crypto`(moving crypto in/ out of accounts on the platform), `instant_funding` (instantly moving in to an account on the platform), `inter_account` (moving crypto between `trading` and `storage` accounts, 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 which is the resource that you will mostly be interacting with.

The Bank is where important product configuration options are set, which influences the customer experience.

These options include:

Bank Type: A Bank is in either Sandbox or Production mode. Initially when you register with the Cybrid platform a Bank is created in Sandbox mode. You can create as many banks in Sandbox mode as you'd like. Production banks can only be created by Cybrid.
Country Code: Each bank is associated with a single country of operation, specified via the Country Code, e.g., US or Canada. This determines which locale the KYC/ KYB and funding methods operate, ensuring that user onboarding for KYC/ KYB, money movement, and bank account selection are specifically tailored to the correct country's banks and type of documents.
Fiat Account Assets: Each bank must define a single base fiat asset to operate in, with the current supported assets being "USD" and "CAD."
Supported Trading Symbols: The list of trading symbols, e.g., BTC-USD, USDC-USD, that the bank will support. In order to open trading accounts in a specific cryptocurrency, e.g., BTC, there must be a trading symbol configured on the bank for the asset.
Supported Payout Symbols: The list of payout symbols, e.g., MXN-USD, and countries, e.g., MXN, the bank will support.
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: Select when the bank supports onboarding individuals.
- business_customers: Select when the bank supports onboardign businesses.

What's next?

With an understanding of the key components and data models, get started now in our development Sandbox: How do I sign into the Sandbox?.