app.cybrid.cybrid_api_bank.client.models.IdentityVerificationWithDetailsBankModel.kt Maven / Gradle / Ivy
/**
* Cybrid Bank API
*
* # Cybrid API documentation 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](https://github.com/Cybrid-app). 💡 We recommend bookmarking the [Cybrid LinkTree](https://linktr.ee/cybridtechnologies) which contains many helpful links to platform resources. ## Getting Started 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](https://bank.demo.cybrid.app/api/schema/v1/swagger.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. [Getting Started in the Cybrid Sandbox](https://www.cybrid.xyz/guides/getting-started) 2. [Getting Ready for Trading](https://www.cybrid.xyz/guides/getting-ready-for-trading) 3. [Running the Web Demo App](https://www.cybrid.xyz/guides/running-the-cybrid-web-demo-crypto-app) (or, alternatively, [Testing with Hosted Web Demo App](https://www.cybrid.xyz/guides/testing-with-the-web-demo-crypo-app)) In [Getting Started in the Cybrid Sandbox](https://www.cybrid.xyz/guides/getting-started), we walk you through how to use the [Cybrid Sandbox](https://id.demo.cybrid.app/) to create a test bank, generate API keys, and set banks fees. In [Getting Ready for Trading](https://www.cybrid.xyz/guides/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](https://www.cybrid.xyz/guides/running-the-cybrid-web-demo-crypto-app) guide to test our web SDK with your sandbox `bank` and `customer`. ## Working with the Cybrid Platform 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](https://github.com/Cybrid-app/cybrid-api-bank-angular), [Java](https://github.com/Cybrid-app/cybrid-api-bank-java), [Kotlin](https://github.com/Cybrid-app/cybrid-api-bank-kotlin), [Python](https://github.com/Cybrid-app/cybrid-api-bank-python), [Ruby](https://github.com/Cybrid-app/cybrid-api-bank-ruby), [Swift](https://github.com/Cybrid-app/cybrid-api-bank-swift) or [Typescript](https://github.com/Cybrid-app/cybrid-api-bank-typescript)) 3. Integrating a platform specific SDK ([Web](https://github.com/Cybrid-app/cybrid-sdk-web), [Android](https://github.com/Cybrid-app/cybrid-sdk-android), [iOS](https://github.com/Cybrid-app/cybrid-sdk-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:* | API | Description | |------------------------------------------------------------------|-------------------------------------------------------------| | [Organization API](https://organization.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage organizations | | [Bank API](https://bank.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage banks (and all downstream customer activity) | | [Identities API](https://id.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage organization and bank identities | For questions please contact [Support](mailto:[email protected]) at any time for assistance, or contact the [Product Team](mailto:[email protected]) for product suggestions. ## Authenticating with the API 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](https://id.demo.cybrid.app). Access tokens can be generated for a `Customer` as well via the [Cybrid IdP](https://id.demo.cybrid.app) 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](https://id.demo.cybrid.app/api/schema/swagger-ui). **⚠️ 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. ``` curl -X POST https://id.demo.cybrid.app/oauth/token -d '{ \"grant_type\": \"client_credentials\", \"client_id\": \"\", \"client_secret\": \"\", \"scope\": \"banks:read banks:write accounts:read accounts:execute customers:read customers:write customers:execute prices:read quotes:execute trades:execute trades:read\" }' -H \"Content-Type: application/json\" ``` **⚠️ Note: The above curl will create a bearer token with full scope access. Delete scopes if you'd like to restrict access.** ## Authentication Scopes 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. | Resource | Read scope (Token Type) | Write scope (Token Type) | Execute scope (Token Type) | |------------------------|------------------------------------------------------------|------------------------------------|-------------------------------------------------| | Organizations | organizations:read (Organization) | organizations:write (Organization) | | | Banks | banks:read (Organization, Bank) | banks:write (Organization, Bank) | banks:execute (Organization) | | Customers | customers:read (Organization, Bank, Customer) | customers:write (Bank, Customer) | customers:execute (Bank) | | Accounts | accounts:read (Organization, Bank, Customer) | | accounts:execute (Bank, Customer) | | Prices | prices:read (Bank, Customer) | | | | Quotes | quotes:read (Organization, Bank, Customer) | | quotes:execute (Bank, Customer) | | Trades | trades:read (Organization, Bank, Customer) | | trades:execute (Bank, Customer) | | Rewards | rewards:read (Bank, Customer) | | rewards:execute (Bank) | | External bank accounts | external_bank_accounts:read (Organization, Bank, Customer) | | external_bank_accounts:execute (Bank, Customer) | | Workflows | workflows:read (Organization, Bank, Customer) | | workflows:execute (Bank, Customer) | | Transfers | workflows:read (Organization, Bank, Customer) | | workflows:execute (Bank, Customer) | ## Available Endpoints The available APIs for the [Identity](https://id.demo.cybrid.app/api/schema/swagger-ui), [Organization](https://organization.demo.cybrid.app/api/schema/swagger-ui) and [Bank](https://bank.demo.cybrid.app/api/schema/swagger-ui) API services are listed below: | API Service | Model | API Endpoint Path | Description | |--------------|----------------------|--------------------------------|---------------------------------------------------------------------------------------------------| | Identity | Bank | /api/bank_applications | Create and list banks | | Identity | Organization | /api/organization_applications | Create and list organizations | | Identity | CustomerToken | /api/customer_tokens | Create customer JWT access tokens | | Organization | Organization | /api/organizations | APIs to retrieve and update organization name | | Bank | Asset | /api/assets | Get a list of assets supported by the platform (ex: BTC, ETH) | | Bank | VerificationKey | /api/bank_verification_keys | Create, list and retrive verification keys, used for signing identities | | Bank | Banks | /api/banks | Create, update and list banks, the parent to customers, accounts, etc | | Bank | FeeConfiguration | /api/fee_configurations | Create and list bank fees (spread or fixed) | | Bank | Customers | /api/customers | Create and list customers | | Bank | IdentityRecord | /api/identity_records | Create and list identity records, which are attached to customers for KYC | | Bank | Accounts | /api/accounts | Create and list accounts, which hold a specific asset for a customers | | Bank | Symbols | /api/symbols | Get a list of symbols supported for trade (ex: BTC-USD) | | Bank | Prices | /api/prices | Get the current prices for assets on the platform | | Bank | Quotes | /api/quotes | Create and list quotes, which are required to execute trades | | Bank | Trades | /api/trades | Create and list trades, which buy or sell cryptocurrency | | Bank | Rewards | /api/rewards | Create a new reward (automates quote/trade for simplicity) | | Bank | ExternalBankAccounts | /api/external_bank_accounts | Create, get and list external bank accounts, which connect customer bank accounts to the platform | | Bank | Workflows | /api/workflows | Create, get and list workflows | | Bank | Transfers | /api/transfers | Create, get and list transfers (e.g., funding, book) | ## Understanding Object Models & Endpoints **Organizations** An `Organization` is meant to represent the organization partnering with Cybrid to use our platform. An `Organization` 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 valid `Identity Record`. See the Identity Records 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.
*
* The version of the OpenAPI document: v0.56.5
* Contact: [email protected]
*
* Please note:
* This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* Do not edit this file manually.
*/
@file:Suppress(
"ArrayInDataClass",
"EnumEntryName",
"RemoveRedundantQualifierName",
"UnusedImport"
)
package app.cybrid.cybrid_api_bank.client.models
import app.cybrid.cybrid_api_bank.client.models.IdentityVerificationBankModel
import app.cybrid.cybrid_api_bank.client.models.IdentityVerificationWithDetailsAllOfBankModel
import com.google.gson.annotations.SerializedName
/**
*
*
* @param guid Auto-generated unique identifier for the identity verification.
* @param customerGuid The customer's identifier.
* @param type The type of identity verification.
* @param method The identity verification method.
* @param createdAt ISO8601 datetime the customer was created at.
* @param state The state of the verification process.
* @param outcome The outcome of the verification process.
* @param failureCodes The reason codes explaining the outcome.
* @param personaInquiryId The Persona identifier of the backing inquiry.
* @param personaState The Persona state of the backing inquiry.
*/
data class IdentityVerificationWithDetailsBankModel (
/* Auto-generated unique identifier for the identity verification. */
@SerializedName("guid")
val guid: kotlin.String? = null,
/* The customer's identifier. */
@SerializedName("customer_guid")
val customerGuid: kotlin.String? = null,
/* The type of identity verification. */
@SerializedName("type")
val type: IdentityVerificationWithDetailsBankModel.Type? = null,
/* The identity verification method. */
@SerializedName("method")
val method: IdentityVerificationWithDetailsBankModel.Method? = null,
/* ISO8601 datetime the customer was created at. */
@SerializedName("created_at")
val createdAt: java.time.OffsetDateTime? = null,
/* The state of the verification process. */
@SerializedName("state")
val state: IdentityVerificationWithDetailsBankModel.State? = null,
/* The outcome of the verification process. */
@SerializedName("outcome")
val outcome: IdentityVerificationWithDetailsBankModel.Outcome? = null,
/* The reason codes explaining the outcome. */
@SerializedName("failure_codes")
val failureCodes: kotlin.collections.List? = null,
/* The Persona identifier of the backing inquiry. */
@SerializedName("persona_inquiry_id")
val personaInquiryId: kotlin.String? = null,
/* The Persona state of the backing inquiry. */
@SerializedName("persona_state")
val personaState: IdentityVerificationWithDetailsBankModel.PersonaState? = null
) {
/**
* The type of identity verification.
*
* Values: kyc
*/
enum class Type(val value: kotlin.String) {
@SerializedName(value = "kyc") kyc("kyc");
}
/**
* The identity verification method.
*
* Values: idAndSelfie
*/
enum class Method(val value: kotlin.String) {
@SerializedName(value = "id_and_selfie") idAndSelfie("id_and_selfie");
}
/**
* The state of the verification process.
*
* Values: storing,waiting,expired,completed
*/
enum class State(val value: kotlin.String) {
@SerializedName(value = "storing") storing("storing"),
@SerializedName(value = "waiting") waiting("waiting"),
@SerializedName(value = "expired") expired("expired"),
@SerializedName(value = "completed") completed("completed");
}
/**
* The outcome of the verification process.
*
* Values: passed,failed
*/
enum class Outcome(val value: kotlin.String) {
@SerializedName(value = "passed") passed("passed"),
@SerializedName(value = "failed") failed("failed");
}
/**
* The reason codes explaining the outcome.
*
* Values: requestedFailure,idCheckFailure,databaseCheckFailure,selfieFailure,pepCheckFailure,watchlistCheckFailure
*/
enum class FailureCodes(val value: kotlin.String) {
@SerializedName(value = "requested_failure") requestedFailure("requested_failure"),
@SerializedName(value = "id_check_failure") idCheckFailure("id_check_failure"),
@SerializedName(value = "database_check_failure") databaseCheckFailure("database_check_failure"),
@SerializedName(value = "selfie_failure") selfieFailure("selfie_failure"),
@SerializedName(value = "pep_check_failure") pepCheckFailure("pep_check_failure"),
@SerializedName(value = "watchlist_check_failure") watchlistCheckFailure("watchlist_check_failure");
}
/**
* The Persona state of the backing inquiry.
*
* Values: waiting,pending,reviewing,processing,expired,completed,unknown
*/
enum class PersonaState(val value: kotlin.String) {
@SerializedName(value = "waiting") waiting("waiting"),
@SerializedName(value = "pending") pending("pending"),
@SerializedName(value = "reviewing") reviewing("reviewing"),
@SerializedName(value = "processing") processing("processing"),
@SerializedName(value = "expired") expired("expired"),
@SerializedName(value = "completed") completed("completed"),
@SerializedName(value = "unknown") unknown("unknown");
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy