Welcome to Cybrid, an all-in-one crypto platform that enables you to easily build and launch white-label crypto products or services.

In these documents, you'll find details on how our REST API operates and generally how our platform functions.

If you're looking for our UI SDK Widgets for Web or Mobile (iOS/Android), generated API clients, or demo applications, head over to our Github repo.

💡 We recommend bookmarking the Cybrid LinkTree which contains many helpful links to platform resources.

This is Cybrid's public interactive API documentation, which allows you to fully test our APIs. If you'd like to use a different tool to exercise our APIs, you can download the Open API 3.0 yaml for import.

If you're new to our APIs and the Cybrid Platform, follow the below guides to get set up and familiar with the platform:

1. Understanding the Platform
2. Getting Started in the Cybrid Sandbox
3. Getting Ready for Trading
4. Running the Web Demo App (or, alternatively, Testing with Hosted Web Demo App)

In Getting Started in the Cybrid Sandbox, we walk you through how to use the Cybrid Sandbox to create a test bank and generate API keys. In Getting Ready for Trading, we walk through creating customers, customer identities, accounts, as well as executing quotes and trades.

If you've already run through the first two guides, you can follow the Running the Web Demo App guide to test our web SDK with your sandbox bank and customer.

There are three primary ways you can interact with the Cybrid platform:

1. Directly via our RESTful API (this documentation)
2. Using our API clients available in a variety of languages (Angular, Java, Kotlin, Python, Ruby, Swift or Typescript)
3. Integrating a platform specific SDK (Web, Android, iOS)

Our complete set of APIs allows you to manage resources across three distinct areas: your Organization, your Banks and your Identities. For most of your testing and interaction you'll be using the Bank API, which is where the majority of APIs reside.

The complete set of APIs can be found on the following pages:

For questions please contact Support at any time for assistance, or contact the Product Team for product suggestions.

The Cybrid Platform uses OAuth 2.0 Bearer Tokens to authenticate requests to the platform. Credentials to create Organization and Bank tokens can be generated via the Cybrid Sandbox. Access tokens can be generated for a Customer as well via the Cybrid IdP as well.

An Organization access token applies broadly to the whole Organization and all of its Banks, whereas, a Bank access token is specific to an individual Bank. Customer tokens, similarly, are scoped to a specific customer in a bank.

Both Organization and Bank tokens can be created using the OAuth Client Credential Grant flow. Each Organization and Bank has its own unique Client ID and Secret that allows for machine-to-machine authentication.

A Bank can then generate Customer access tokens via API using our Identities API.

<font color="orange">⚠️ Never share your Client ID or Secret publicly or in your source code repository.

Your Client ID and Secret can be exchanged for a time-limited Bearer Token by interacting with the Cybrid Identity Provider or through interacting with the Authorize button in this document.

The following curl command can be used to quickly generate a Bearer Token for use in testing the API or demo applications.

# Example request when using Bank credentials
curl -X POST https://id.sandbox.cybrid.app/oauth/token -d '{
    \"grant_type\": \"client_credentials\",
    \"client_id\": \"<Your Client ID>\",
    \"client_secret\": \"<Your Secret>\",
    \"scope\": \"banks:read banks:write bank_applications:execute accounts:read accounts:execute counterparties:read counterparties:write counterparties:execute customers:read customers:write customers:execute prices:read quotes:execute quotes:read trades:execute trades:read transfers:execute transfers:read external_bank_accounts:read external_bank_accounts:write external_bank_accounts:execute external_wallets:read external_wallets:execute workflows:read workflows:execute deposit_addresses:read deposit_addresses:execute deposit_bank_accounts:read deposit_bank_accounts:execute invoices:read invoices:write invoices:execute\"
  }' -H \"Content-Type: application/json\"

# When using Organization credentials set `scope` to 'organizations:read organizations:write organization_applications:execute banks:read banks:write banks:execute bank_applications:execute users:read users:execute counterparties:read customers:read accounts:read prices:read quotes:execute quotes:read trades:execute trades:read transfers:read transfers:execute external_bank_accounts:read external_wallets:read workflows:read deposit_addresses:read deposit_bank_accounts:read invoices:read subscriptions:read subscriptions:write subscriptions:execute'

<font color="orange">⚠️ Note: The above curl will create a bearer token with full scope access. Delete scopes if you'd like to restrict access.

The Cybrid platform supports the use of scopes to control the level of access a token is limited to. Scopes do not grant access to resources; instead, they provide limits, in support of the least privilege principal.

The following scopes are available on the platform and can be requested when generating either an Organization, Bank or Customer token. Generally speaking, the Read scope is required to read and list resources, the Write scope is required to update a resource and the Execute scope is required to create a resource.

The available APIs for the Identity, Organization and Bank API services are listed below:

Organizations

An Organization is meant to represent the organization partnering with Cybrid to use our platform.

An Organization typically does not directly interact with customers. Instead, an Organization has one or more banks, which encompass the financial service offerings of the platform.

Banks

A Bank is owned by an Organization and can be thought of as an environment or container for customers and product offerings. Banks are created in either Sandbox or Production mode, where Sandbox is the environment that you would test, prototype and build in prior to moving to Production.

An Organization can have multiple banks, in either Sandbox or Production environments. A Sandbox Bank will be backed by stubbed data and process flows. For instance, funding source transfer processes as well as trades will be simulated rather than performed, however asset prices are representative of real-world values. You have an unlimited amount of simulated fiat currency for testing purposes.

Customers

Customers represent your banking users on the platform. At present, we offer support for Individuals as Customers.

Customers must be verified (i.e., KYC'd) in our system before they can play any part on the platform, which means they must have an associated and a passing Identity Verification. See the Identity Verifications section for more details on how a customer can be verified.

Customers must also have an Account to be able to transact, in the desired asset class. See the Accounts APIs for more details on setting up accounts for the customer.

This Python package is automatically generated by the OpenAPI Generator project:

• API version: v0.115.122
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Python >=3.6

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import cybrid_api_bank

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import cybrid_api_bank

Please follow the installation procedure and then run the following:

import time
import cybrid_api_bank
from pprint import pprint
from cybrid_api_bank.api import accounts_bank_api
from cybrid_api_bank.model.account import Account
from cybrid_api_bank.model.account_list import AccountList
from cybrid_api_bank.model.error_response import ErrorResponse
from cybrid_api_bank.model.post_account import PostAccount
# Defining the host is optional and defaults to https://bank.sandbox.cybrid.app
# See configuration.py for a list of all supported configuration parameters.
configuration = cybrid_api_bank.Configuration(
    host = "https://bank.sandbox.cybrid.app"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): BearerAuth
configuration = cybrid_api_bank.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Configure OAuth2 access token for authorization: oauth2
configuration = cybrid_api_bank.Configuration(
    host = "https://bank.sandbox.cybrid.app"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'


# Enter a context with an instance of the API client
with cybrid_api_bank.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = accounts_bank_api.AccountsBankApi(api_client)
    post_account = PostAccount(
        type="trading",
        customer_guid="customer_guid_example",
        asset="asset_example",
        name="name_example",
        labels=[
            "labels_example",
        ],
    ) # PostAccount | 

    try:
        # Create Account
        api_response = api_instance.create_account(post_account)
        pprint(api_response)
    except cybrid_api_bank.ApiException as e:
        print("Exception when calling AccountsBankApi->create_account: %s\n" % e)

All URIs are relative to https://bank.sandbox.cybrid.app

• Account
• AccountList
• AccountState
• AccountType
• Asset
• AssetList
• AssetTypes
• Bank
• BankFeature
• BankList
• BankType
• Counterparty
• CounterpartyAddress
• CounterpartyAliasesInner
• CounterpartyList
• CounterpartyName
• CounterpartyState
• CounterpartyType
• Customer
• CustomerAddress
• CustomerAliasesInner
• CustomerList
• CustomerName
• CustomerState
• CustomerType
• DepositAddress
• DepositAddressFormat
• DepositAddressList
• DepositAddressState
• DepositBankAccount
• DepositBankAccountAccountDetailsInner
• DepositBankAccountCounterpartyAddress
• DepositBankAccountList
• DepositBankAccountRoutingDetailsInner
• DepositBankAccountRoutingNumberType
• DepositBankAccountState
• ErrorResponse
• ExternalBankAccount
• ExternalBankAccountBalances
• ExternalBankAccountKind
• ExternalBankAccountList
• ExternalBankAccountPiiInner
• ExternalBankAccountPiiInnerAddressesInner
• ExternalBankAccountState
• ExternalWallet
• ExternalWalletEnvironment
• ExternalWalletList
• ExternalWalletState
• IdentityVerification
• IdentityVerificationList
• IdentityVerificationMethod
• IdentityVerificationOutcome
• IdentityVerificationPersonaState
• IdentityVerificationState
• IdentityVerificationType
• IdentityVerificationWithDetails
• IdentityVerificationWithDetailsPii
• IdentityVerificationWithDetailsPiiAddress
• IdentityVerificationWithDetailsPiiName
• Invoice
• InvoiceList
• ListRequestPage
• ListRequestPerPage
• PatchBank
• PatchCustomer
• PatchExternalBankAccount
• PaymentInstruction
• PaymentInstructionList
• PostAccount
• PostBank
• PostCounterparty
• PostCounterpartyName
• PostCustomer
• PostCustomerAddress
• PostCustomerName
• PostDepositAddress
• PostDepositBankAccount
• PostExternalBankAccount
• PostExternalBankAccountCounterpartyAddress
• PostExternalBankAccountCounterpartyBankAccount
• PostExternalBankAccountCounterpartyName
• PostExternalWallet
• PostFee
• PostIdentificationNumber
• PostIdentityVerification
• PostIdentityVerificationAddress
• PostIdentityVerificationName
• PostInvoice
• PostPaymentInstruction
• PostQuote
• PostTrade
• PostTransfer
• PostWorkflow
• Quote
• QuoteList
• QuoteSide
• QuoteType
• SymbolPrice
• SymbolPriceResponse
• Symbols
• Trade
• TradeFailureCode
• TradeList
• TradeSide
• TradeState
• TradeType
• Transfer
• TransferAccountType
• TransferDestinationAccount
• TransferFailureCode
• TransferList
• TransferSide
• TransferSourceAccount
• TransferState
• TransferType
• VerificationCheck
• VerificationCheckState
• VerificationCheckType
• Workflow
• WorkflowState
• WorkflowType
• WorkflowWithDetails
• WorkflowWithDetailsAllOf
• WorkflowsList

• Type: Bearer authentication (JWT)

• Type: OAuth
• Flow: application
• Authorization URL:
• Scopes:
• banks:read: banks read
• banks:write: banks write
• bank_applications:execute: bank_applications execute
• accounts:read: accounts read
• accounts:execute: accounts execute
• counterparties:read: counterparties read
• counterparties:write: counterparties write
• counterparties:execute: counterparties execute
• customers:read: customers read
• customers:write: customers write
• customers:execute: customers execute
• prices:read: prices read
• quotes:execute: quotes execute
• quotes:read: quotes read
• trades:execute: trades execute
• trades:read: trades read
• transfers:execute: transfers execute
• transfers:read: transfers read
• external_bank_accounts:read: external_bank_accounts read
• external_bank_accounts:write: external_bank_accounts write
• external_bank_accounts:execute: external_bank_accounts execute
• external_wallets:read: external_wallets read
• external_wallets:execute: external_wallets execute
• workflows:read: workflows read
• workflows:execute: workflows execute
• deposit_addresses:read: deposit_addresses read
• deposit_addresses:execute: deposit_addresses execute
• deposit_bank_accounts:read: deposit_bank_accounts read
• deposit_bank_accounts:execute: deposit_bank_accounts execute
• invoices:read: invoices read
• invoices:write: invoices write
• invoices:execute: invoices execute

support@cybrid.app

If the OpenAPI document is large, imports in cybrid_api_bank.apis and cybrid_api_bank.models may fail with a RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:

Solution 1: Use specific imports for apis and models like:

• from cybrid_api_bank.api.default_api import DefaultApi
• from cybrid_api_bank.model.pet import Pet

Solution 2: Before importing the package, adjust the maximum recursion limit as shown below:

import sys
sys.setrecursionlimit(1500)
import cybrid_api_bank
from cybrid_api_bank.apis import *
from cybrid_api_bank.models import *