cybrid_api_bank_ruby 0.123.153 → 0.123.203
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/README.md +18 -7
- data/cybrid_api_bank_ruby.gemspec +2 -2
- data/docs/ComplianceCheckBankModel.md +1 -1
- data/docs/ComplianceDecisionBankModel.md +1 -1
- data/docs/FilesBankApi.md +240 -0
- data/docs/IdentificationNumberBankModel.md +1 -1
- data/docs/IdentityVerificationBankModel.md +1 -1
- data/docs/IdentityVerificationWithDetailsBankModel.md +1 -1
- data/docs/PlatformFileBankModel.md +30 -0
- data/docs/PlatformFileListBankModel.md +24 -0
- data/docs/PostCustomerAddressBankModel.md +6 -6
- data/docs/PostCustomerAliasesInnerBankModel.md +18 -0
- data/docs/PostCustomerBankModel.md +10 -6
- data/docs/PostCustomerNameBankModel.md +3 -1
- data/docs/PostFileBankModel.md +26 -0
- data/docs/PostIdentityVerificationAddressBankModel.md +6 -6
- data/docs/PostIdentityVerificationAliasesInnerBankModel.md +18 -0
- data/docs/PostIdentityVerificationBankModel.md +21 -7
- data/docs/PostIdentityVerificationNameBankModel.md +4 -4
- data/docs/PostUltimateBeneficialOwnerBankModel.md +20 -0
- data/lib/cybrid_api_bank_ruby/api/accounts_bank_api.rb +2 -2
- data/lib/cybrid_api_bank_ruby/api/assets_bank_api.rb +2 -2
- data/lib/cybrid_api_bank_ruby/api/banks_bank_api.rb +2 -2
- data/lib/cybrid_api_bank_ruby/api/counterparties_bank_api.rb +2 -2
- data/lib/cybrid_api_bank_ruby/api/customers_bank_api.rb +2 -2
- data/lib/cybrid_api_bank_ruby/api/deposit_addresses_bank_api.rb +2 -2
- data/lib/cybrid_api_bank_ruby/api/deposit_bank_accounts_bank_api.rb +2 -2
- data/lib/cybrid_api_bank_ruby/api/external_bank_accounts_bank_api.rb +2 -2
- data/lib/cybrid_api_bank_ruby/api/external_wallets_bank_api.rb +2 -2
- data/lib/cybrid_api_bank_ruby/api/files_bank_api.rb +243 -0
- data/lib/cybrid_api_bank_ruby/api/identity_verifications_bank_api.rb +2 -2
- data/lib/cybrid_api_bank_ruby/api/invoices_bank_api.rb +2 -2
- data/lib/cybrid_api_bank_ruby/api/payment_instructions_bank_api.rb +2 -2
- data/lib/cybrid_api_bank_ruby/api/prices_bank_api.rb +2 -2
- data/lib/cybrid_api_bank_ruby/api/quotes_bank_api.rb +2 -2
- data/lib/cybrid_api_bank_ruby/api/symbols_bank_api.rb +2 -2
- data/lib/cybrid_api_bank_ruby/api/trades_bank_api.rb +2 -2
- data/lib/cybrid_api_bank_ruby/api/transfers_bank_api.rb +2 -2
- data/lib/cybrid_api_bank_ruby/api/workflows_bank_api.rb +2 -2
- data/lib/cybrid_api_bank_ruby/api_client.rb +2 -2
- data/lib/cybrid_api_bank_ruby/api_error.rb +2 -2
- data/lib/cybrid_api_bank_ruby/configuration.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/account_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/account_list_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/account_state_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/account_type_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/activity_limit_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/activity_type_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/asset_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/asset_list_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/asset_types_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/bank_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/bank_feature_bank_model.rb +3 -2
- data/lib/cybrid_api_bank_ruby/models/bank_list_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/bank_supported_payout_symbols_inner_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/bank_type_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/compliance_check_bank_model.rb +3 -3
- data/lib/cybrid_api_bank_ruby/models/compliance_check_outcome_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/compliance_check_type_bank_model.rb +3 -2
- data/lib/cybrid_api_bank_ruby/models/compliance_decision_bank_model.rb +3 -3
- data/lib/cybrid_api_bank_ruby/models/compliance_decision_state_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/compliance_decision_type_bank_model.rb +3 -2
- data/lib/cybrid_api_bank_ruby/models/counterparty_address_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/counterparty_aliases_inner_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/counterparty_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/counterparty_list_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/counterparty_name_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/counterparty_state_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/counterparty_type_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/customer_address_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/customer_aliases_inner_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/customer_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/customer_list_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/customer_name_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/customer_state_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/customer_type_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/deposit_address_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/deposit_address_format_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/deposit_address_list_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/deposit_address_state_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_account_details_inner_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_counterparty_address_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_list_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_routing_details_inner_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_routing_number_type_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_state_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/error_response_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/external_bank_account_balances_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/external_bank_account_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/external_bank_account_kind_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/external_bank_account_list_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/external_bank_account_pii_inner_addresses_inner_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/external_bank_account_pii_inner_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/external_bank_account_pii_inner_routing_details_inner_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/external_bank_account_state_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/external_wallet_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/external_wallet_environment_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/external_wallet_list_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/external_wallet_state_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/identification_number_bank_model.rb +3 -3
- data/lib/cybrid_api_bank_ruby/models/identity_verification_bank_model.rb +3 -3
- data/lib/cybrid_api_bank_ruby/models/identity_verification_list_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/identity_verification_method_bank_model.rb +5 -3
- data/lib/cybrid_api_bank_ruby/models/identity_verification_outcome_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/identity_verification_persona_state_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/identity_verification_state_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/identity_verification_type_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_bank_model.rb +3 -3
- data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_pii_address_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_pii_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_pii_name_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/invoice_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/invoice_list_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/patch_bank_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/patch_customer_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/patch_external_bank_account_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/payment_instruction_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/payment_instruction_list_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/platform_file_bank_model.rb +363 -0
- data/lib/cybrid_api_bank_ruby/models/platform_file_list_bank_model.rb +329 -0
- data/lib/cybrid_api_bank_ruby/models/post_account_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/post_bank_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/post_counterparty_address_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/post_counterparty_aliases_inner_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/post_counterparty_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/post_counterparty_name_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/post_customer_address_bank_model.rb +34 -18
- data/lib/cybrid_api_bank_ruby/models/post_customer_aliases_inner_bank_model.rb +221 -0
- data/lib/cybrid_api_bank_ruby/models/post_customer_bank_model.rb +75 -27
- data/lib/cybrid_api_bank_ruby/models/post_customer_name_bank_model.rb +19 -8
- data/lib/cybrid_api_bank_ruby/models/post_deposit_address_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/post_deposit_bank_account_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/post_external_bank_account_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/post_external_bank_account_counterparty_address_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/post_external_bank_account_counterparty_bank_account_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/post_external_bank_account_counterparty_name_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/post_external_wallet_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/post_fee_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/post_file_bank_model.rb +399 -0
- data/lib/cybrid_api_bank_ruby/models/post_identification_number_bank_model.rb +4 -4
- data/lib/cybrid_api_bank_ruby/models/post_identity_verification_address_bank_model.rb +9 -9
- data/lib/cybrid_api_bank_ruby/models/post_identity_verification_aliases_inner_bank_model.rb +221 -0
- data/lib/cybrid_api_bank_ruby/models/post_identity_verification_bank_model.rb +194 -22
- data/lib/cybrid_api_bank_ruby/models/post_identity_verification_name_bank_model.rb +7 -7
- data/lib/cybrid_api_bank_ruby/models/post_invoice_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/post_payment_instruction_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/post_quote_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/post_quote_entry_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/post_trade_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/post_transfer_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/post_transfer_participant_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/post_ultimate_beneficial_owner_bank_model.rb +269 -0
- data/lib/cybrid_api_bank_ruby/models/post_workflow_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/quote_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/quote_entry_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/quote_entry_destination_account_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/quote_entry_source_account_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/quote_list_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/quote_side_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/quote_type_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/symbol_price_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/trade_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/trade_failure_code_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/trade_list_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/trade_side_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/trade_state_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/trade_type_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/transfer_account_type_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/transfer_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/transfer_destination_account_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/transfer_entry_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/transfer_entry_destination_account_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/transfer_failure_code_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/transfer_list_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/transfer_participant_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/transfer_side_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/transfer_source_account_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/transfer_state_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/transfer_type_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/workflow_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/workflow_state_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/workflow_type_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/workflow_with_details_all_of_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/workflow_with_details_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/workflows_list_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/version.rb +3 -3
- data/lib/cybrid_api_bank_ruby.rb +9 -2
- data/spec/api/accounts_bank_api_spec.rb +2 -2
- data/spec/api/assets_bank_api_spec.rb +2 -2
- data/spec/api/banks_bank_api_spec.rb +2 -2
- data/spec/api/counterparties_bank_api_spec.rb +2 -2
- data/spec/api/customers_bank_api_spec.rb +2 -2
- data/spec/api/deposit_addresses_bank_api_spec.rb +2 -2
- data/spec/api/deposit_bank_accounts_bank_api_spec.rb +2 -2
- data/spec/api/external_bank_accounts_bank_api_spec.rb +2 -2
- data/spec/api/external_wallets_bank_api_spec.rb +2 -2
- data/spec/api/files_bank_api_spec.rb +77 -0
- data/spec/api/identity_verifications_bank_api_spec.rb +2 -2
- data/spec/api/invoices_bank_api_spec.rb +2 -2
- data/spec/api/payment_instructions_bank_api_spec.rb +2 -2
- data/spec/api/prices_bank_api_spec.rb +2 -2
- data/spec/api/quotes_bank_api_spec.rb +2 -2
- data/spec/api/symbols_bank_api_spec.rb +2 -2
- data/spec/api/trades_bank_api_spec.rb +2 -2
- data/spec/api/transfers_bank_api_spec.rb +2 -2
- data/spec/api/workflows_bank_api_spec.rb +2 -2
- data/spec/api_client_spec.rb +2 -2
- data/spec/configuration_spec.rb +2 -2
- data/spec/models/account_bank_model_spec.rb +2 -2
- data/spec/models/account_list_bank_model_spec.rb +2 -2
- data/spec/models/account_state_bank_model_spec.rb +2 -2
- data/spec/models/account_type_bank_model_spec.rb +2 -2
- data/spec/models/activity_limit_bank_model_spec.rb +2 -2
- data/spec/models/activity_type_bank_model_spec.rb +2 -2
- data/spec/models/asset_bank_model_spec.rb +2 -2
- data/spec/models/asset_list_bank_model_spec.rb +2 -2
- data/spec/models/asset_types_bank_model_spec.rb +2 -2
- data/spec/models/bank_bank_model_spec.rb +2 -2
- data/spec/models/bank_feature_bank_model_spec.rb +2 -2
- data/spec/models/bank_list_bank_model_spec.rb +2 -2
- data/spec/models/bank_supported_payout_symbols_inner_bank_model_spec.rb +2 -2
- data/spec/models/bank_type_bank_model_spec.rb +2 -2
- data/spec/models/compliance_check_bank_model_spec.rb +2 -2
- data/spec/models/compliance_check_outcome_bank_model_spec.rb +2 -2
- data/spec/models/compliance_check_type_bank_model_spec.rb +2 -2
- data/spec/models/compliance_decision_bank_model_spec.rb +2 -2
- data/spec/models/compliance_decision_state_bank_model_spec.rb +2 -2
- data/spec/models/compliance_decision_type_bank_model_spec.rb +2 -2
- data/spec/models/counterparty_address_bank_model_spec.rb +2 -2
- data/spec/models/counterparty_aliases_inner_bank_model_spec.rb +2 -2
- data/spec/models/counterparty_bank_model_spec.rb +2 -2
- data/spec/models/counterparty_list_bank_model_spec.rb +2 -2
- data/spec/models/counterparty_name_bank_model_spec.rb +2 -2
- data/spec/models/counterparty_state_bank_model_spec.rb +2 -2
- data/spec/models/counterparty_type_bank_model_spec.rb +2 -2
- data/spec/models/customer_address_bank_model_spec.rb +2 -2
- data/spec/models/customer_aliases_inner_bank_model_spec.rb +2 -2
- data/spec/models/customer_bank_model_spec.rb +2 -2
- data/spec/models/customer_list_bank_model_spec.rb +2 -2
- data/spec/models/customer_name_bank_model_spec.rb +2 -2
- data/spec/models/customer_state_bank_model_spec.rb +2 -2
- data/spec/models/customer_type_bank_model_spec.rb +2 -2
- data/spec/models/deposit_address_bank_model_spec.rb +2 -2
- data/spec/models/deposit_address_format_bank_model_spec.rb +2 -2
- data/spec/models/deposit_address_list_bank_model_spec.rb +2 -2
- data/spec/models/deposit_address_state_bank_model_spec.rb +2 -2
- data/spec/models/deposit_bank_account_account_details_inner_bank_model_spec.rb +2 -2
- data/spec/models/deposit_bank_account_bank_model_spec.rb +2 -2
- data/spec/models/deposit_bank_account_counterparty_address_bank_model_spec.rb +2 -2
- data/spec/models/deposit_bank_account_list_bank_model_spec.rb +2 -2
- data/spec/models/deposit_bank_account_routing_details_inner_bank_model_spec.rb +2 -2
- data/spec/models/deposit_bank_account_routing_number_type_bank_model_spec.rb +2 -2
- data/spec/models/deposit_bank_account_state_bank_model_spec.rb +2 -2
- data/spec/models/error_response_bank_model_spec.rb +2 -2
- data/spec/models/external_bank_account_balances_bank_model_spec.rb +2 -2
- data/spec/models/external_bank_account_bank_model_spec.rb +2 -2
- data/spec/models/external_bank_account_kind_bank_model_spec.rb +2 -2
- data/spec/models/external_bank_account_list_bank_model_spec.rb +2 -2
- data/spec/models/external_bank_account_pii_inner_addresses_inner_bank_model_spec.rb +2 -2
- data/spec/models/external_bank_account_pii_inner_bank_model_spec.rb +2 -2
- data/spec/models/external_bank_account_pii_inner_routing_details_inner_bank_model_spec.rb +2 -2
- data/spec/models/external_bank_account_state_bank_model_spec.rb +2 -2
- data/spec/models/external_wallet_bank_model_spec.rb +2 -2
- data/spec/models/external_wallet_environment_bank_model_spec.rb +2 -2
- data/spec/models/external_wallet_list_bank_model_spec.rb +2 -2
- data/spec/models/external_wallet_state_bank_model_spec.rb +2 -2
- data/spec/models/identification_number_bank_model_spec.rb +2 -2
- data/spec/models/identity_verification_bank_model_spec.rb +2 -2
- data/spec/models/identity_verification_list_bank_model_spec.rb +2 -2
- data/spec/models/identity_verification_method_bank_model_spec.rb +2 -2
- data/spec/models/identity_verification_outcome_bank_model_spec.rb +2 -2
- data/spec/models/identity_verification_persona_state_bank_model_spec.rb +2 -2
- data/spec/models/identity_verification_state_bank_model_spec.rb +2 -2
- data/spec/models/identity_verification_type_bank_model_spec.rb +2 -2
- data/spec/models/identity_verification_with_details_bank_model_spec.rb +2 -2
- data/spec/models/identity_verification_with_details_pii_address_bank_model_spec.rb +2 -2
- data/spec/models/identity_verification_with_details_pii_bank_model_spec.rb +2 -2
- data/spec/models/identity_verification_with_details_pii_name_bank_model_spec.rb +2 -2
- data/spec/models/invoice_bank_model_spec.rb +2 -2
- data/spec/models/invoice_list_bank_model_spec.rb +2 -2
- data/spec/models/patch_bank_bank_model_spec.rb +2 -2
- data/spec/models/patch_customer_bank_model_spec.rb +2 -2
- data/spec/models/patch_external_bank_account_bank_model_spec.rb +2 -2
- data/spec/models/payment_instruction_bank_model_spec.rb +2 -2
- data/spec/models/payment_instruction_list_bank_model_spec.rb +2 -2
- data/spec/models/platform_file_bank_model_spec.rb +82 -0
- data/spec/models/platform_file_list_bank_model_spec.rb +52 -0
- data/spec/models/post_account_bank_model_spec.rb +2 -2
- data/spec/models/post_bank_bank_model_spec.rb +3 -3
- data/spec/models/post_counterparty_address_bank_model_spec.rb +2 -2
- data/spec/models/post_counterparty_aliases_inner_bank_model_spec.rb +2 -2
- data/spec/models/post_counterparty_bank_model_spec.rb +2 -2
- data/spec/models/post_counterparty_name_bank_model_spec.rb +2 -2
- data/spec/models/post_customer_address_bank_model_spec.rb +2 -2
- data/spec/models/post_customer_aliases_inner_bank_model_spec.rb +34 -0
- data/spec/models/post_customer_bank_model_spec.rb +20 -8
- data/spec/models/post_customer_name_bank_model_spec.rb +8 -2
- data/spec/models/post_deposit_address_bank_model_spec.rb +2 -2
- data/spec/models/post_deposit_bank_account_bank_model_spec.rb +2 -2
- data/spec/models/post_external_bank_account_bank_model_spec.rb +2 -2
- data/spec/models/post_external_bank_account_counterparty_address_bank_model_spec.rb +2 -2
- data/spec/models/post_external_bank_account_counterparty_bank_account_bank_model_spec.rb +2 -2
- data/spec/models/post_external_bank_account_counterparty_name_bank_model_spec.rb +2 -2
- data/spec/models/post_external_wallet_bank_model_spec.rb +2 -2
- data/spec/models/post_fee_bank_model_spec.rb +2 -2
- data/spec/models/post_file_bank_model_spec.rb +66 -0
- data/spec/models/post_identification_number_bank_model_spec.rb +3 -3
- data/spec/models/post_identity_verification_address_bank_model_spec.rb +2 -2
- data/spec/models/post_identity_verification_aliases_inner_bank_model_spec.rb +34 -0
- data/spec/models/post_identity_verification_bank_model_spec.rb +46 -4
- data/spec/models/post_identity_verification_name_bank_model_spec.rb +2 -2
- data/spec/models/post_invoice_bank_model_spec.rb +2 -2
- data/spec/models/post_payment_instruction_bank_model_spec.rb +2 -2
- data/spec/models/post_quote_bank_model_spec.rb +2 -2
- data/spec/models/post_quote_entry_bank_model_spec.rb +2 -2
- data/spec/models/post_trade_bank_model_spec.rb +2 -2
- data/spec/models/post_transfer_bank_model_spec.rb +2 -2
- data/spec/models/post_transfer_participant_bank_model_spec.rb +2 -2
- data/spec/models/post_ultimate_beneficial_owner_bank_model_spec.rb +40 -0
- data/spec/models/post_workflow_bank_model_spec.rb +2 -2
- data/spec/models/quote_bank_model_spec.rb +2 -2
- data/spec/models/quote_entry_bank_model_spec.rb +2 -2
- data/spec/models/quote_entry_destination_account_bank_model_spec.rb +2 -2
- data/spec/models/quote_entry_source_account_bank_model_spec.rb +2 -2
- data/spec/models/quote_list_bank_model_spec.rb +2 -2
- data/spec/models/quote_side_bank_model_spec.rb +2 -2
- data/spec/models/quote_type_bank_model_spec.rb +2 -2
- data/spec/models/symbol_price_bank_model_spec.rb +2 -2
- data/spec/models/trade_bank_model_spec.rb +2 -2
- data/spec/models/trade_failure_code_bank_model_spec.rb +2 -2
- data/spec/models/trade_list_bank_model_spec.rb +2 -2
- data/spec/models/trade_side_bank_model_spec.rb +2 -2
- data/spec/models/trade_state_bank_model_spec.rb +2 -2
- data/spec/models/trade_type_bank_model_spec.rb +2 -2
- data/spec/models/transfer_account_type_bank_model_spec.rb +2 -2
- data/spec/models/transfer_bank_model_spec.rb +2 -2
- data/spec/models/transfer_destination_account_bank_model_spec.rb +2 -2
- data/spec/models/transfer_entry_bank_model_spec.rb +2 -2
- data/spec/models/transfer_entry_destination_account_bank_model_spec.rb +2 -2
- data/spec/models/transfer_failure_code_bank_model_spec.rb +2 -2
- data/spec/models/transfer_list_bank_model_spec.rb +2 -2
- data/spec/models/transfer_participant_bank_model_spec.rb +2 -2
- data/spec/models/transfer_side_bank_model_spec.rb +2 -2
- data/spec/models/transfer_source_account_bank_model_spec.rb +2 -2
- data/spec/models/transfer_state_bank_model_spec.rb +2 -2
- data/spec/models/transfer_type_bank_model_spec.rb +2 -2
- data/spec/models/workflow_bank_model_spec.rb +2 -2
- data/spec/models/workflow_state_bank_model_spec.rb +2 -2
- data/spec/models/workflow_type_bank_model_spec.rb +2 -2
- data/spec/models/workflow_with_details_all_of_bank_model_spec.rb +2 -2
- data/spec/models/workflow_with_details_bank_model_spec.rb +2 -2
- data/spec/models/workflows_list_bank_model_spec.rb +2 -2
- data/spec/spec_helper.rb +2 -2
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/byebug-11.1.3/gem_make.out +5 -5
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/date-3.4.1/gem_make.out +5 -5
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/jaro_winkler-1.5.6/gem_make.out +5 -5
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/psych-5.2.3/gem_make.out +5 -5
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/racc-1.8.1/gem_make.out +5 -5
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/stringio-3.1.2/gem_make.out +5 -5
- metadata +30 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: f06ae52c34abcd31d5d7da072430a9ed842cef4fcb98edf40dce0026c0b237a5
|
|
4
|
+
data.tar.gz: e9a26197298547efce7a3cc3b92afdd1d00d8c6d8cab4de1acf83116161ef861
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: e4f2ed5434abfbe0ad0b7d6fd4f2e40dbb401812a251732de3453d534415bed84fdeb4032f686614da5f5a74750298e81d8116a2f669fa676ea1fdfdfeec3150
|
|
7
|
+
data.tar.gz: 98c71f5fb796e28995e982a4b5bd3f4c301bc38bb6a74546aab787ed12291e315713bade29a84b4c99475d7c26f5acd6e023fc503aa94143a22a024ec0f06513
|
data/Gemfile.lock
CHANGED
data/README.md
CHANGED
|
@@ -66,10 +66,10 @@ curl -X POST https://id.production.cybrid.app/oauth/token -d '{
|
|
|
66
66
|
\"grant_type\": \"client_credentials\",
|
|
67
67
|
\"client_id\": \"<Your Client ID>\",
|
|
68
68
|
\"client_secret\": \"<Your Secret>\",
|
|
69
|
-
\"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 identity_verifications:read identity_verifications:write identity_verifications:execute\"
|
|
69
|
+
\"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 identity_verifications:read identity_verifications:write identity_verifications:execute files:read files:execute\"
|
|
70
70
|
}' -H \"Content-Type: application/json\"
|
|
71
71
|
|
|
72
|
-
# 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 subscription_events:read subscription_events:execute identity_verifications:read'
|
|
72
|
+
# 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 subscription_events:read subscription_events:execute identity_verifications:read files:read files:execute'
|
|
73
73
|
```
|
|
74
74
|
<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.**</font>
|
|
75
75
|
|
|
@@ -151,8 +151,8 @@ An `Organization` can have multiple `banks`, in either `Sandbox` or `Production`
|
|
|
151
151
|
|
|
152
152
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
153
153
|
|
|
154
|
-
- API version: v0.123.
|
|
155
|
-
- Package version: 0.123.
|
|
154
|
+
- API version: v0.123.203
|
|
155
|
+
- Package version: 0.123.203
|
|
156
156
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
157
157
|
|
|
158
158
|
## Installation
|
|
@@ -168,16 +168,16 @@ gem build cybrid_api_bank_ruby.gemspec
|
|
|
168
168
|
Then either install the gem locally:
|
|
169
169
|
|
|
170
170
|
```shell
|
|
171
|
-
gem install ./cybrid_api_bank_ruby-0.123.
|
|
171
|
+
gem install ./cybrid_api_bank_ruby-0.123.203.gem
|
|
172
172
|
```
|
|
173
173
|
|
|
174
|
-
(for development, run `gem install --dev ./cybrid_api_bank_ruby-0.123.
|
|
174
|
+
(for development, run `gem install --dev ./cybrid_api_bank_ruby-0.123.203.gem` to install the development dependencies)
|
|
175
175
|
|
|
176
176
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
|
177
177
|
|
|
178
178
|
Finally add this to the Gemfile:
|
|
179
179
|
|
|
180
|
-
gem 'cybrid_api_bank_ruby', '~> 0.123.
|
|
180
|
+
gem 'cybrid_api_bank_ruby', '~> 0.123.203'
|
|
181
181
|
|
|
182
182
|
### Install from Git
|
|
183
183
|
|
|
@@ -259,6 +259,9 @@ Class | Method | HTTP request | Description
|
|
|
259
259
|
*CybridApiBank::ExternalWalletsBankApi* | [**delete_external_wallet**](docs/ExternalWalletsBankApi.md#delete_external_wallet) | **DELETE** /api/external_wallets/{external_wallet_guid} | Delete External Wallet
|
|
260
260
|
*CybridApiBank::ExternalWalletsBankApi* | [**get_external_wallet**](docs/ExternalWalletsBankApi.md#get_external_wallet) | **GET** /api/external_wallets/{external_wallet_guid} | Get External Wallet
|
|
261
261
|
*CybridApiBank::ExternalWalletsBankApi* | [**list_external_wallets**](docs/ExternalWalletsBankApi.md#list_external_wallets) | **GET** /api/external_wallets | Get external wallets list
|
|
262
|
+
*CybridApiBank::FilesBankApi* | [**create_file**](docs/FilesBankApi.md#create_file) | **POST** /api/files | Create File
|
|
263
|
+
*CybridApiBank::FilesBankApi* | [**get_file**](docs/FilesBankApi.md#get_file) | **GET** /api/files/{file_guid} | Get File
|
|
264
|
+
*CybridApiBank::FilesBankApi* | [**list_files**](docs/FilesBankApi.md#list_files) | **GET** /api/files | List Files
|
|
262
265
|
*CybridApiBank::IdentityVerificationsBankApi* | [**create_identity_verification**](docs/IdentityVerificationsBankApi.md#create_identity_verification) | **POST** /api/identity_verifications | Create Identity Verification
|
|
263
266
|
*CybridApiBank::IdentityVerificationsBankApi* | [**get_identity_verification**](docs/IdentityVerificationsBankApi.md#get_identity_verification) | **GET** /api/identity_verifications/{identity_verification_guid} | Get Identity Verification
|
|
264
267
|
*CybridApiBank::IdentityVerificationsBankApi* | [**list_identity_verifications**](docs/IdentityVerificationsBankApi.md#list_identity_verifications) | **GET** /api/identity_verifications | List Identity Verifications
|
|
@@ -364,6 +367,8 @@ Class | Method | HTTP request | Description
|
|
|
364
367
|
- [CybridApiBank::PatchExternalBankAccountBankModel](docs/PatchExternalBankAccountBankModel.md)
|
|
365
368
|
- [CybridApiBank::PaymentInstructionBankModel](docs/PaymentInstructionBankModel.md)
|
|
366
369
|
- [CybridApiBank::PaymentInstructionListBankModel](docs/PaymentInstructionListBankModel.md)
|
|
370
|
+
- [CybridApiBank::PlatformFileBankModel](docs/PlatformFileBankModel.md)
|
|
371
|
+
- [CybridApiBank::PlatformFileListBankModel](docs/PlatformFileListBankModel.md)
|
|
367
372
|
- [CybridApiBank::PostAccountBankModel](docs/PostAccountBankModel.md)
|
|
368
373
|
- [CybridApiBank::PostBankBankModel](docs/PostBankBankModel.md)
|
|
369
374
|
- [CybridApiBank::PostCounterpartyAddressBankModel](docs/PostCounterpartyAddressBankModel.md)
|
|
@@ -371,6 +376,7 @@ Class | Method | HTTP request | Description
|
|
|
371
376
|
- [CybridApiBank::PostCounterpartyBankModel](docs/PostCounterpartyBankModel.md)
|
|
372
377
|
- [CybridApiBank::PostCounterpartyNameBankModel](docs/PostCounterpartyNameBankModel.md)
|
|
373
378
|
- [CybridApiBank::PostCustomerAddressBankModel](docs/PostCustomerAddressBankModel.md)
|
|
379
|
+
- [CybridApiBank::PostCustomerAliasesInnerBankModel](docs/PostCustomerAliasesInnerBankModel.md)
|
|
374
380
|
- [CybridApiBank::PostCustomerBankModel](docs/PostCustomerBankModel.md)
|
|
375
381
|
- [CybridApiBank::PostCustomerNameBankModel](docs/PostCustomerNameBankModel.md)
|
|
376
382
|
- [CybridApiBank::PostDepositAddressBankModel](docs/PostDepositAddressBankModel.md)
|
|
@@ -381,8 +387,10 @@ Class | Method | HTTP request | Description
|
|
|
381
387
|
- [CybridApiBank::PostExternalBankAccountCounterpartyNameBankModel](docs/PostExternalBankAccountCounterpartyNameBankModel.md)
|
|
382
388
|
- [CybridApiBank::PostExternalWalletBankModel](docs/PostExternalWalletBankModel.md)
|
|
383
389
|
- [CybridApiBank::PostFeeBankModel](docs/PostFeeBankModel.md)
|
|
390
|
+
- [CybridApiBank::PostFileBankModel](docs/PostFileBankModel.md)
|
|
384
391
|
- [CybridApiBank::PostIdentificationNumberBankModel](docs/PostIdentificationNumberBankModel.md)
|
|
385
392
|
- [CybridApiBank::PostIdentityVerificationAddressBankModel](docs/PostIdentityVerificationAddressBankModel.md)
|
|
393
|
+
- [CybridApiBank::PostIdentityVerificationAliasesInnerBankModel](docs/PostIdentityVerificationAliasesInnerBankModel.md)
|
|
386
394
|
- [CybridApiBank::PostIdentityVerificationBankModel](docs/PostIdentityVerificationBankModel.md)
|
|
387
395
|
- [CybridApiBank::PostIdentityVerificationNameBankModel](docs/PostIdentityVerificationNameBankModel.md)
|
|
388
396
|
- [CybridApiBank::PostInvoiceBankModel](docs/PostInvoiceBankModel.md)
|
|
@@ -392,6 +400,7 @@ Class | Method | HTTP request | Description
|
|
|
392
400
|
- [CybridApiBank::PostTradeBankModel](docs/PostTradeBankModel.md)
|
|
393
401
|
- [CybridApiBank::PostTransferBankModel](docs/PostTransferBankModel.md)
|
|
394
402
|
- [CybridApiBank::PostTransferParticipantBankModel](docs/PostTransferParticipantBankModel.md)
|
|
403
|
+
- [CybridApiBank::PostUltimateBeneficialOwnerBankModel](docs/PostUltimateBeneficialOwnerBankModel.md)
|
|
395
404
|
- [CybridApiBank::PostWorkflowBankModel](docs/PostWorkflowBankModel.md)
|
|
396
405
|
- [CybridApiBank::QuoteBankModel](docs/QuoteBankModel.md)
|
|
397
406
|
- [CybridApiBank::QuoteEntryBankModel](docs/QuoteEntryBankModel.md)
|
|
@@ -476,4 +485,6 @@ Class | Method | HTTP request | Description
|
|
|
476
485
|
- identity_verifications:read: identity_verifications read
|
|
477
486
|
- identity_verifications:write: identity_verifications write
|
|
478
487
|
- identity_verifications:execute: identity_verifications execute
|
|
488
|
+
- files:read: files read
|
|
489
|
+
- files:execute: files execute
|
|
479
490
|
|
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
=begin
|
|
4
4
|
#Cybrid Bank API
|
|
5
5
|
|
|
6
|
-
## 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.production.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. [Introduction](https://docs.cybrid.xyz/docs/introduction) 2. [Platform Introduction](https://docs.cybrid.xyz/docs/how-is-cybrid-architected) 3. [Testing with Hosted Web Demo App](https://docs.cybrid.xyz/docs/testing-with-hosted-web-demo-app) In [Getting Started in the Cybrid Sandbox](https://docs.cybrid.xyz/docs/how-do-i-get-started-with-the-sandbox), we walk you through how to use the [Cybrid Sandbox](https://id.sandbox.cybrid.app/) to create a test bank and generate API keys. In [Getting Ready for Trading](https://kb.cybrid.xyz/getting-ready-for-trading), we walk through creating customers, customer identities, accounts, as well as executing quotes and trades. ## 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.production.cybrid.app/api/schema/swagger-ui) | APIs to manage organizations | | [Bank API](https://bank.production.cybrid.app/api/schema/swagger-ui) | APIs to manage banks (and all downstream customer activity) | | [Identities API](https://id.production.cybrid.app/api/schema/swagger-ui) | APIs to manage organization and bank identities | For questions please contact [Support](mailto:support@cybrid.xyz) at any time for assistance, or contact the [Product Team](mailto:product@cybrid.xyz) 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.production.cybrid.app). Access tokens can be generated for a `Customer` as well via the [Cybrid IdP](https://id.production.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.production.cybrid.app/api/schema/swagger-ui). <font color=\"orange\">**⚠️ Never share your Client ID or Secret publicly or in your source code repository.**</font> 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.production.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 identity_verifications:read identity_verifications:write identity_verifications: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 subscription_events:read subscription_events:execute identity_verifications:read' ``` <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.**</font> ## 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) | |-----------------------|------------------------------------------------------------|-----------------------------------------------|--------------------------------------------------| | Account | accounts:read (Organization, Bank, Customer) | | accounts:execute (Bank, Customer) | | Bank | banks:read (Organization, Bank) | banks:write (Organization, Bank) | banks:execute (Organization) | | Customer | customers:read (Organization, Bank, Customer) | customers:write (Bank, Customer) | customers:execute (Bank) | | Counterparty | counterparties:read (Organization, Bank, Customer) | counterparties:write (Bank, Customer) | counterparties:execute (Bank) | | Deposit Address | deposit_addresses:read (Organization, Bank, Customer) | deposit_addresses:write (Bank, Customer) | deposit_addresses:execute (Bank, Customer) | | External Bank Account | external_bank_accounts:read (Organization, Bank, Customer) | external_bank_accounts:write (Bank, Customer) | external_bank_accounts:execute (Bank, Customer) | | External Wallet | external_wallet:read (Organization, Bank, Customer) | | external_wallet:execute (Bank, Customer) | | Organization | organizations:read (Organization) | organizations:write (Organization) | | | User | users:read (Organization) | | users:execute (Organization) | | Price | prices:read (Bank, Customer) | | | | Quote | quotes:read (Organization, Bank, Customer) | | quotes:execute (Organization, Bank, Customer) | | Trade | trades:read (Organization, Bank, Customer) | | trades:execute (Organization, Bank, Customer) | | Transfer | transfers:read (Organization, Bank, Customer) | | transfers:execute (Organization, Bank, Customer) | | Workflow | workflows:read (Organization, Bank, Customer) | | workflows:execute (Bank, Customer) | | Invoice | invoices:read (Organization, Bank, Customer) | invoices:write (Bank, Customer) | invoices:execute (Bank, Customer) | ## Available Endpoints The available APIs for the [Identity](https://id.production.cybrid.app/api/schema/swagger-ui), [Organization](https://organization.production.cybrid.app/api/schema/swagger-ui) and [Bank](https://bank.production.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 | CustomerToken | /api/customer_tokens | Create customer JWT access tokens | | Identity | Organization | /api/organization_applications | Create and list organizations | | Identity | Organization | /api/users | Create and list organization users | | Organization | Organization | /api/organizations | APIs to retrieve and update organization name | | Bank | Account | /api/accounts | Create and list accounts, which hold a specific asset for a customers | | Bank | Asset | /api/assets | Get a list of assets supported by the platform (ex: BTC, ETH) | | Bank | Bank | /api/banks | Create, update and list banks, the parent to customers, accounts, etc | | Bank | Customer | /api/customers | Create and list customers | | Bank | Counterparty | /api/counterparties | Create and list counterparties | | Bank | DepositAddress | /api/deposit_addresses | Create, get and list deposit addresses | | Bank | ExternalBankAccount | /api/external_bank_accounts | Create, get and list external bank accounts, which connect customer bank accounts to the platform | | Bank | ExternalWallet | /api/external_wallets | Create, get, list and delete external wallets, which connect customer wallets to the platform | | Bank | IdentityVerification | /api/identity_verifications | Create and list identity verifications, which are performed on customers for KYC | | Bank | Invoice | /api/invoices | Create, get, cancel and list invoices | | Bank | PaymentInstruction | /api/payment_instructions | Create, get and list payment instructions for invoices | | Bank | Price | /api/prices | Get the current prices for assets on the platform | | Bank | Quote | /api/quotes | Create and list quotes, which are required to execute trades | | Bank | Symbol | /api/symbols | Get a list of symbols supported for trade (ex: BTC-USD) | | Bank | Trade | /api/trades | Create and list trades, which buy or sell cryptocurrency | | Bank | Transfer | /api/transfers | Create, get and list transfers (e.g., funding, book) | | Bank | Workflow | /api/workflows | Create, get and list workflows | ## Understanding Object Models & Endpoints **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.
|
|
6
|
+
## 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.production.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. [Introduction](https://docs.cybrid.xyz/docs/introduction) 2. [Platform Introduction](https://docs.cybrid.xyz/docs/how-is-cybrid-architected) 3. [Testing with Hosted Web Demo App](https://docs.cybrid.xyz/docs/testing-with-hosted-web-demo-app) In [Getting Started in the Cybrid Sandbox](https://docs.cybrid.xyz/docs/how-do-i-get-started-with-the-sandbox), we walk you through how to use the [Cybrid Sandbox](https://id.sandbox.cybrid.app/) to create a test bank and generate API keys. In [Getting Ready for Trading](https://kb.cybrid.xyz/getting-ready-for-trading), we walk through creating customers, customer identities, accounts, as well as executing quotes and trades. ## 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.production.cybrid.app/api/schema/swagger-ui) | APIs to manage organizations | | [Bank API](https://bank.production.cybrid.app/api/schema/swagger-ui) | APIs to manage banks (and all downstream customer activity) | | [Identities API](https://id.production.cybrid.app/api/schema/swagger-ui) | APIs to manage organization and bank identities | For questions please contact [Support](mailto:support@cybrid.xyz) at any time for assistance, or contact the [Product Team](mailto:product@cybrid.xyz) 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.production.cybrid.app). Access tokens can be generated for a `Customer` as well via the [Cybrid IdP](https://id.production.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.production.cybrid.app/api/schema/swagger-ui). <font color=\"orange\">**⚠️ Never share your Client ID or Secret publicly or in your source code repository.**</font> 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.production.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 identity_verifications:read identity_verifications:write identity_verifications:execute files:read files: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 subscription_events:read subscription_events:execute identity_verifications:read files:read files: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.**</font> ## 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) | |-----------------------|------------------------------------------------------------|-----------------------------------------------|--------------------------------------------------| | Account | accounts:read (Organization, Bank, Customer) | | accounts:execute (Bank, Customer) | | Bank | banks:read (Organization, Bank) | banks:write (Organization, Bank) | banks:execute (Organization) | | Customer | customers:read (Organization, Bank, Customer) | customers:write (Bank, Customer) | customers:execute (Bank) | | Counterparty | counterparties:read (Organization, Bank, Customer) | counterparties:write (Bank, Customer) | counterparties:execute (Bank) | | Deposit Address | deposit_addresses:read (Organization, Bank, Customer) | deposit_addresses:write (Bank, Customer) | deposit_addresses:execute (Bank, Customer) | | External Bank Account | external_bank_accounts:read (Organization, Bank, Customer) | external_bank_accounts:write (Bank, Customer) | external_bank_accounts:execute (Bank, Customer) | | External Wallet | external_wallet:read (Organization, Bank, Customer) | | external_wallet:execute (Bank, Customer) | | Organization | organizations:read (Organization) | organizations:write (Organization) | | | User | users:read (Organization) | | users:execute (Organization) | | Price | prices:read (Bank, Customer) | | | | Quote | quotes:read (Organization, Bank, Customer) | | quotes:execute (Organization, Bank, Customer) | | Trade | trades:read (Organization, Bank, Customer) | | trades:execute (Organization, Bank, Customer) | | Transfer | transfers:read (Organization, Bank, Customer) | | transfers:execute (Organization, Bank, Customer) | | Workflow | workflows:read (Organization, Bank, Customer) | | workflows:execute (Bank, Customer) | | Invoice | invoices:read (Organization, Bank, Customer) | invoices:write (Bank, Customer) | invoices:execute (Bank, Customer) | ## Available Endpoints The available APIs for the [Identity](https://id.production.cybrid.app/api/schema/swagger-ui), [Organization](https://organization.production.cybrid.app/api/schema/swagger-ui) and [Bank](https://bank.production.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 | CustomerToken | /api/customer_tokens | Create customer JWT access tokens | | Identity | Organization | /api/organization_applications | Create and list organizations | | Identity | Organization | /api/users | Create and list organization users | | Organization | Organization | /api/organizations | APIs to retrieve and update organization name | | Bank | Account | /api/accounts | Create and list accounts, which hold a specific asset for a customers | | Bank | Asset | /api/assets | Get a list of assets supported by the platform (ex: BTC, ETH) | | Bank | Bank | /api/banks | Create, update and list banks, the parent to customers, accounts, etc | | Bank | Customer | /api/customers | Create and list customers | | Bank | Counterparty | /api/counterparties | Create and list counterparties | | Bank | DepositAddress | /api/deposit_addresses | Create, get and list deposit addresses | | Bank | ExternalBankAccount | /api/external_bank_accounts | Create, get and list external bank accounts, which connect customer bank accounts to the platform | | Bank | ExternalWallet | /api/external_wallets | Create, get, list and delete external wallets, which connect customer wallets to the platform | | Bank | IdentityVerification | /api/identity_verifications | Create and list identity verifications, which are performed on customers for KYC | | Bank | Invoice | /api/invoices | Create, get, cancel and list invoices | | Bank | PaymentInstruction | /api/payment_instructions | Create, get and list payment instructions for invoices | | Bank | Price | /api/prices | Get the current prices for assets on the platform | | Bank | Quote | /api/quotes | Create and list quotes, which are required to execute trades | | Bank | Symbol | /api/symbols | Get a list of symbols supported for trade (ex: BTC-USD) | | Bank | Trade | /api/trades | Create and list trades, which buy or sell cryptocurrency | | Bank | Transfer | /api/transfers | Create, get and list transfers (e.g., funding, book) | | Bank | Workflow | /api/workflows | Create, get and list workflows | ## Understanding Object Models & Endpoints **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.
|
|
7
7
|
|
|
8
|
-
The version of the OpenAPI document: v0.123.
|
|
8
|
+
The version of the OpenAPI document: v0.123.203
|
|
9
9
|
Contact: support@cybrid.app
|
|
10
10
|
Generated by: https://openapi-generator.tech
|
|
11
11
|
OpenAPI Generator version: 6.0.0
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **type** | **String** | The type of compliance check; one of business_watchlists, business_verification, business_tax_id_verification, person_attested, person_tax_id_attested, person_watchlists, person_verification, person_authentication, person_gov_id_verification, person_tax_id_verification, external_bank_account_verification, or external_bank_account_attested. | |
|
|
7
|
+
| **type** | **String** | The type of compliance check; one of business_watchlists, business_verification, business_tax_id_verification, business_attested, person_attested, person_tax_id_attested, person_watchlists, person_verification, person_authentication, person_gov_id_verification, person_tax_id_verification, external_bank_account_verification, or external_bank_account_attested. | |
|
|
8
8
|
| **outcome** | **String** | The outcome of the compliance check; one of passed, failed, or inconclusive. | |
|
|
9
9
|
| **failure_codes** | **Array<String>** | The reason codes explaining the outcome. | [optional] |
|
|
10
10
|
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **type** | **String** | The type of verification check; one of business_watchlists, business_verification, business_tax_id_verification, person_attested, person_tax_id_attested, person_watchlists, person_verification, person_authentication, person_gov_id_verification, person_tax_id_verification, external_bank_account_verification, or external_bank_account_attested. | |
|
|
7
|
+
| **type** | **String** | The type of verification check; one of business_watchlists, business_verification, business_tax_id_verification, business_attested, person_attested, person_tax_id_attested, person_watchlists, person_verification, person_authentication, person_gov_id_verification, person_tax_id_verification, external_bank_account_verification, or external_bank_account_attested. | |
|
|
8
8
|
| **state** | **String** | The state of the verification check; one of passed, failed, expired, or invalidated. | |
|
|
9
9
|
| **failure_codes** | **Array<String>** | The reason codes explaining the outcome. | [optional] |
|
|
10
10
|
|
|
@@ -0,0 +1,240 @@
|
|
|
1
|
+
# CybridApiBank::FilesBankApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://bank.sandbox.cybrid.app*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**create_file**](FilesBankApi.md#create_file) | **POST** /api/files | Create File |
|
|
8
|
+
| [**get_file**](FilesBankApi.md#get_file) | **GET** /api/files/{file_guid} | Get File |
|
|
9
|
+
| [**list_files**](FilesBankApi.md#list_files) | **GET** /api/files | List Files |
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
## create_file
|
|
13
|
+
|
|
14
|
+
> <PlatformFileBankModel> create_file(post_file_bank_model)
|
|
15
|
+
|
|
16
|
+
Create File
|
|
17
|
+
|
|
18
|
+
Creates a file. #### This feature is currently in preview mode and is not yet available for partner use. ## Data The attribute contains the base64 encoded file content. The value needs to be smaller than 10MB otherwise the Platform will reject the request. To upload files larger than 10MB do not provide the content and use the returned upload URL to provide the file. ## State | State | Description | |-------|-------------| | storing | The Platform is storing the file in our private store | | completed | The Platform has completed storing the file | | failed | The Platform failed to store the file | Required scope: **files:execute**
|
|
19
|
+
|
|
20
|
+
### Examples
|
|
21
|
+
|
|
22
|
+
```ruby
|
|
23
|
+
require 'time'
|
|
24
|
+
require 'cybrid_api_bank_ruby'
|
|
25
|
+
# setup authorization
|
|
26
|
+
CybridApiBank.configure do |config|
|
|
27
|
+
# Configure Bearer authorization (JWT): BearerAuth
|
|
28
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
29
|
+
|
|
30
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
31
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
32
|
+
end
|
|
33
|
+
|
|
34
|
+
api_instance = CybridApiBank::FilesBankApi.new
|
|
35
|
+
post_file_bank_model = CybridApiBank::PostFileBankModel.new({type: 'drivers_license_front', customer_guid: 'customer_guid_example', filename: 'filename_example', content_type: 'image/jpeg'}) # PostFileBankModel |
|
|
36
|
+
|
|
37
|
+
begin
|
|
38
|
+
# Create File
|
|
39
|
+
result = api_instance.create_file(post_file_bank_model)
|
|
40
|
+
p result
|
|
41
|
+
rescue CybridApiBank::ApiError => e
|
|
42
|
+
puts "Error when calling FilesBankApi->create_file: #{e}"
|
|
43
|
+
end
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
#### Using the create_file_with_http_info variant
|
|
47
|
+
|
|
48
|
+
This returns an Array which contains the response data, status code and headers.
|
|
49
|
+
|
|
50
|
+
> <Array(<PlatformFileBankModel>, Integer, Hash)> create_file_with_http_info(post_file_bank_model)
|
|
51
|
+
|
|
52
|
+
```ruby
|
|
53
|
+
begin
|
|
54
|
+
# Create File
|
|
55
|
+
data, status_code, headers = api_instance.create_file_with_http_info(post_file_bank_model)
|
|
56
|
+
p status_code # => 2xx
|
|
57
|
+
p headers # => { ... }
|
|
58
|
+
p data # => <PlatformFileBankModel>
|
|
59
|
+
rescue CybridApiBank::ApiError => e
|
|
60
|
+
puts "Error when calling FilesBankApi->create_file_with_http_info: #{e}"
|
|
61
|
+
end
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
### Parameters
|
|
65
|
+
|
|
66
|
+
| Name | Type | Description | Notes |
|
|
67
|
+
| ---- | ---- | ----------- | ----- |
|
|
68
|
+
| **post_file_bank_model** | [**PostFileBankModel**](PostFileBankModel.md) | | |
|
|
69
|
+
|
|
70
|
+
### Return type
|
|
71
|
+
|
|
72
|
+
[**PlatformFileBankModel**](PlatformFileBankModel.md)
|
|
73
|
+
|
|
74
|
+
### Authorization
|
|
75
|
+
|
|
76
|
+
[BearerAuth](../README.md#BearerAuth), [oauth2](../README.md#oauth2)
|
|
77
|
+
|
|
78
|
+
### HTTP request headers
|
|
79
|
+
|
|
80
|
+
- **Content-Type**: application/json
|
|
81
|
+
- **Accept**: application/json
|
|
82
|
+
|
|
83
|
+
|
|
84
|
+
## get_file
|
|
85
|
+
|
|
86
|
+
> <PlatformFileBankModel> get_file(file_guid)
|
|
87
|
+
|
|
88
|
+
Get File
|
|
89
|
+
|
|
90
|
+
Retrieves a file. Required scope: **files:read**
|
|
91
|
+
|
|
92
|
+
### Examples
|
|
93
|
+
|
|
94
|
+
```ruby
|
|
95
|
+
require 'time'
|
|
96
|
+
require 'cybrid_api_bank_ruby'
|
|
97
|
+
# setup authorization
|
|
98
|
+
CybridApiBank.configure do |config|
|
|
99
|
+
# Configure Bearer authorization (JWT): BearerAuth
|
|
100
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
101
|
+
|
|
102
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
103
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
104
|
+
end
|
|
105
|
+
|
|
106
|
+
api_instance = CybridApiBank::FilesBankApi.new
|
|
107
|
+
file_guid = 'file_guid_example' # String | Identifier for the file.
|
|
108
|
+
|
|
109
|
+
begin
|
|
110
|
+
# Get File
|
|
111
|
+
result = api_instance.get_file(file_guid)
|
|
112
|
+
p result
|
|
113
|
+
rescue CybridApiBank::ApiError => e
|
|
114
|
+
puts "Error when calling FilesBankApi->get_file: #{e}"
|
|
115
|
+
end
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
#### Using the get_file_with_http_info variant
|
|
119
|
+
|
|
120
|
+
This returns an Array which contains the response data, status code and headers.
|
|
121
|
+
|
|
122
|
+
> <Array(<PlatformFileBankModel>, Integer, Hash)> get_file_with_http_info(file_guid)
|
|
123
|
+
|
|
124
|
+
```ruby
|
|
125
|
+
begin
|
|
126
|
+
# Get File
|
|
127
|
+
data, status_code, headers = api_instance.get_file_with_http_info(file_guid)
|
|
128
|
+
p status_code # => 2xx
|
|
129
|
+
p headers # => { ... }
|
|
130
|
+
p data # => <PlatformFileBankModel>
|
|
131
|
+
rescue CybridApiBank::ApiError => e
|
|
132
|
+
puts "Error when calling FilesBankApi->get_file_with_http_info: #{e}"
|
|
133
|
+
end
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
### Parameters
|
|
137
|
+
|
|
138
|
+
| Name | Type | Description | Notes |
|
|
139
|
+
| ---- | ---- | ----------- | ----- |
|
|
140
|
+
| **file_guid** | **String** | Identifier for the file. | |
|
|
141
|
+
|
|
142
|
+
### Return type
|
|
143
|
+
|
|
144
|
+
[**PlatformFileBankModel**](PlatformFileBankModel.md)
|
|
145
|
+
|
|
146
|
+
### Authorization
|
|
147
|
+
|
|
148
|
+
[BearerAuth](../README.md#BearerAuth), [oauth2](../README.md#oauth2)
|
|
149
|
+
|
|
150
|
+
### HTTP request headers
|
|
151
|
+
|
|
152
|
+
- **Content-Type**: Not defined
|
|
153
|
+
- **Accept**: application/json
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
## list_files
|
|
157
|
+
|
|
158
|
+
> <PlatformFileListBankModel> list_files(opts)
|
|
159
|
+
|
|
160
|
+
List Files
|
|
161
|
+
|
|
162
|
+
Retrieves a list of files. Required scope: **files:read**
|
|
163
|
+
|
|
164
|
+
### Examples
|
|
165
|
+
|
|
166
|
+
```ruby
|
|
167
|
+
require 'time'
|
|
168
|
+
require 'cybrid_api_bank_ruby'
|
|
169
|
+
# setup authorization
|
|
170
|
+
CybridApiBank.configure do |config|
|
|
171
|
+
# Configure Bearer authorization (JWT): BearerAuth
|
|
172
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
173
|
+
|
|
174
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
175
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
176
|
+
end
|
|
177
|
+
|
|
178
|
+
api_instance = CybridApiBank::FilesBankApi.new
|
|
179
|
+
opts = {
|
|
180
|
+
page: 56, # Integer | The page index to retrieve.
|
|
181
|
+
per_page: 56, # Integer | The number of entities per page to return.
|
|
182
|
+
guid: 'guid_example', # String | Comma separated file_guids to list files for.
|
|
183
|
+
type: 'type_example', # String | Comma separated file types to list files for.
|
|
184
|
+
state: 'state_example', # String | Comma separated file states to list files for.
|
|
185
|
+
bank_guid: 'bank_guid_example', # String | Comma separated bank_guids to list files for.
|
|
186
|
+
customer_guid: 'customer_guid_example' # String | Comma separated customer_guids to list files for.
|
|
187
|
+
}
|
|
188
|
+
|
|
189
|
+
begin
|
|
190
|
+
# List Files
|
|
191
|
+
result = api_instance.list_files(opts)
|
|
192
|
+
p result
|
|
193
|
+
rescue CybridApiBank::ApiError => e
|
|
194
|
+
puts "Error when calling FilesBankApi->list_files: #{e}"
|
|
195
|
+
end
|
|
196
|
+
```
|
|
197
|
+
|
|
198
|
+
#### Using the list_files_with_http_info variant
|
|
199
|
+
|
|
200
|
+
This returns an Array which contains the response data, status code and headers.
|
|
201
|
+
|
|
202
|
+
> <Array(<PlatformFileListBankModel>, Integer, Hash)> list_files_with_http_info(opts)
|
|
203
|
+
|
|
204
|
+
```ruby
|
|
205
|
+
begin
|
|
206
|
+
# List Files
|
|
207
|
+
data, status_code, headers = api_instance.list_files_with_http_info(opts)
|
|
208
|
+
p status_code # => 2xx
|
|
209
|
+
p headers # => { ... }
|
|
210
|
+
p data # => <PlatformFileListBankModel>
|
|
211
|
+
rescue CybridApiBank::ApiError => e
|
|
212
|
+
puts "Error when calling FilesBankApi->list_files_with_http_info: #{e}"
|
|
213
|
+
end
|
|
214
|
+
```
|
|
215
|
+
|
|
216
|
+
### Parameters
|
|
217
|
+
|
|
218
|
+
| Name | Type | Description | Notes |
|
|
219
|
+
| ---- | ---- | ----------- | ----- |
|
|
220
|
+
| **page** | **Integer** | The page index to retrieve. | [optional] |
|
|
221
|
+
| **per_page** | **Integer** | The number of entities per page to return. | [optional] |
|
|
222
|
+
| **guid** | **String** | Comma separated file_guids to list files for. | [optional] |
|
|
223
|
+
| **type** | **String** | Comma separated file types to list files for. | [optional] |
|
|
224
|
+
| **state** | **String** | Comma separated file states to list files for. | [optional] |
|
|
225
|
+
| **bank_guid** | **String** | Comma separated bank_guids to list files for. | [optional] |
|
|
226
|
+
| **customer_guid** | **String** | Comma separated customer_guids to list files for. | [optional] |
|
|
227
|
+
|
|
228
|
+
### Return type
|
|
229
|
+
|
|
230
|
+
[**PlatformFileListBankModel**](PlatformFileListBankModel.md)
|
|
231
|
+
|
|
232
|
+
### Authorization
|
|
233
|
+
|
|
234
|
+
[BearerAuth](../README.md#BearerAuth), [oauth2](../README.md#oauth2)
|
|
235
|
+
|
|
236
|
+
### HTTP request headers
|
|
237
|
+
|
|
238
|
+
- **Content-Type**: Not defined
|
|
239
|
+
- **Accept**: application/json
|
|
240
|
+
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **type** | **String** | The source of the identification number; one of drivers_license, passport, passport_card, residence_card, social_security_number, tax_identification_number, or
|
|
7
|
+
| **type** | **String** | The source of the identification number; one of drivers_license, passport, passport_card, residence_card, social_security_number, tax_identification_number, identification_card, employer_identification_number, or business_registration_number. | |
|
|
8
8
|
| **issuing_country_code** | **String** | The ISO 3166 country 2-Alpha country code of the identification number issuer. | |
|
|
9
9
|
| **identification_number** | **String** | The identification number. | |
|
|
10
10
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **guid** | **String** | Auto-generated unique identifier for the identity verification. | [optional] |
|
|
8
8
|
| **type** | **String** | The identity verification type; one of kyc, bank_account, or counterparty. | [optional] |
|
|
9
|
-
| **method** | **String** | The identity verification method; one of attested, document_submission, id_and_selfie, tax_id_and_selfie, business_registration,
|
|
9
|
+
| **method** | **String** | The identity verification method; one of attested, document_submission, id_and_selfie, tax_id_and_selfie, business_registration, attested_id_and_selfie, attested_business_registration, watchlists, attested_ownership, or account_ownership. | [optional] |
|
|
10
10
|
| **created_at** | **Time** | ISO8601 datetime the record was created at. | [optional] |
|
|
11
11
|
| **updated_at** | **Time** | ISO8601 datetime the record was last updated at. | [optional] |
|
|
12
12
|
| **customer_guid** | **String** | The customer's identifier. | [optional] |
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **guid** | **String** | Auto-generated unique identifier for the identity verification. | [optional] |
|
|
8
8
|
| **type** | **String** | The identity verification type; one of kyc, bank_account, or counterparty. | [optional] |
|
|
9
|
-
| **method** | **String** | The identity verification method; one of attested, document_submission, id_and_selfie, tax_id_and_selfie, business_registration,
|
|
9
|
+
| **method** | **String** | The identity verification method; one of attested, document_submission, id_and_selfie, tax_id_and_selfie, business_registration, attested_id_and_selfie, attested_business_registration, watchlists, attested_ownership, or account_ownership. | [optional] |
|
|
10
10
|
| **created_at** | **Time** | ISO8601 datetime the record was created at. | [optional] |
|
|
11
11
|
| **updated_at** | **Time** | ISO8601 datetime the record was last updated at. | [optional] |
|
|
12
12
|
| **customer_guid** | **String** | The identity verification's identifier. | [optional] |
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# CybridApiBank::PlatformFileBankModel
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **guid** | **String** | The unique identifier for the file. | [optional] |
|
|
8
|
+
| **file_type** | **String** | The file type; one of drivers_license_front, drivers_license_back, passport, identification_card, residence_card, selfie, selfie_left, selfie_right, utility_bill, bank_statement, property_tax, tax_document, ein_letter, or incorporation_certificate. | [optional] |
|
|
9
|
+
| **content_type** | **String** | The media type; one of image/jpeg, image/png, or application/pdf. | [optional] |
|
|
10
|
+
| **completed_at** | **Time** | The ISO8601 datetime the file was completed at. | [optional] |
|
|
11
|
+
| **failed_at** | **Time** | The ISO8601 datetime the file failed at. | [optional] |
|
|
12
|
+
| **state** | **String** | The state of the file. One of storing, completed, or failed. | [optional] |
|
|
13
|
+
| **failure_code** | **String** | The failure code for failed files. | [optional] |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```ruby
|
|
18
|
+
require 'cybrid_api_bank_ruby'
|
|
19
|
+
|
|
20
|
+
instance = CybridApiBank::PlatformFileBankModel.new(
|
|
21
|
+
guid: null,
|
|
22
|
+
file_type: null,
|
|
23
|
+
content_type: null,
|
|
24
|
+
completed_at: null,
|
|
25
|
+
failed_at: null,
|
|
26
|
+
state: null,
|
|
27
|
+
failure_code: null
|
|
28
|
+
)
|
|
29
|
+
```
|
|
30
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# CybridApiBank::PlatformFileListBankModel
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **total** | **Integer** | The total number of records available. | |
|
|
8
|
+
| **page** | **Integer** | The page index to retrieve. | |
|
|
9
|
+
| **per_page** | **Integer** | The number of entities per page to return. | |
|
|
10
|
+
| **objects** | [**Array<PlatformFileBankModel>**](PlatformFileBankModel.md) | Array of file entities | |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'cybrid_api_bank_ruby'
|
|
16
|
+
|
|
17
|
+
instance = CybridApiBank::PlatformFileListBankModel.new(
|
|
18
|
+
total: null,
|
|
19
|
+
page: null,
|
|
20
|
+
per_page: null,
|
|
21
|
+
objects: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -4,12 +4,12 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **street** | **String** | The first line of the address.
|
|
8
|
-
| **street2** | **String** | The optional second line of the address.
|
|
9
|
-
| **city** | **String** | The city of the address.
|
|
10
|
-
| **subdivision** | **String** | The ISO 3166-2 subdivision code of the address. Applicable only for countries that use subnational states, provinces, lands, oblasts or regions.
|
|
11
|
-
| **postal_code** | **String** | The postal, zip or post code of the address. Applicable only for countries that use postal, zip or post codes.
|
|
12
|
-
| **country_code** | **String** | The ISO 3166 country 2-Alpha country code of the address.
|
|
7
|
+
| **street** | **String** | The first line of the address. | |
|
|
8
|
+
| **street2** | **String** | The optional second line of the address. | [optional] |
|
|
9
|
+
| **city** | **String** | The city of the address. | |
|
|
10
|
+
| **subdivision** | **String** | The ISO 3166-2 subdivision code of the address. Applicable only for countries that use subnational states, provinces, lands, oblasts or regions. | [optional] |
|
|
11
|
+
| **postal_code** | **String** | The postal, zip or post code of the address. Applicable only for countries that use postal, zip or post codes. | [optional] |
|
|
12
|
+
| **country_code** | **String** | The ISO 3166 country 2-Alpha country code of the address. | |
|
|
13
13
|
|
|
14
14
|
## Example
|
|
15
15
|
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# CybridApiBank::PostCustomerAliasesInnerBankModel
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **full** | **String** | The customer's full name. Required when type is business. | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'cybrid_api_bank_ruby'
|
|
13
|
+
|
|
14
|
+
instance = CybridApiBank::PostCustomerAliasesInnerBankModel.new(
|
|
15
|
+
full: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -5,12 +5,14 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **type** | **String** | The type of customer. | |
|
|
8
|
-
| **name** | [**PostCustomerNameBankModel**](PostCustomerNameBankModel.md) | | [optional] |
|
|
9
8
|
| **address** | [**PostCustomerAddressBankModel**](PostCustomerAddressBankModel.md) | | [optional] |
|
|
9
|
+
| **phone_number** | **String** | The customer's phone number. | [optional] |
|
|
10
|
+
| **email_address** | **String** | The customer's email address. | [optional] |
|
|
11
|
+
| **identification_numbers** | [**Array<PostIdentificationNumberBankModel>**](PostIdentificationNumberBankModel.md) | The customer's identification numbers. | [optional] |
|
|
12
|
+
| **name** | [**PostCustomerNameBankModel**](PostCustomerNameBankModel.md) | | [optional] |
|
|
10
13
|
| **date_of_birth** | **Date** | The customer's date of birth. Optional when type is individual. | [optional] |
|
|
11
|
-
| **
|
|
12
|
-
| **
|
|
13
|
-
| **identification_numbers** | [**Array<PostIdentificationNumberBankModel>**](PostIdentificationNumberBankModel.md) | The customer's identification numbers. Optional when type is individual. | [optional] |
|
|
14
|
+
| **aliases** | [**Array<PostCustomerAliasesInnerBankModel>**](PostCustomerAliasesInnerBankModel.md) | The aliases of the customer. Optional when type is business. | [optional] |
|
|
15
|
+
| **website** | **String** | The customer's website. Optional when type is business. | [optional] |
|
|
14
16
|
| **labels** | **Array<String>** | The labels associated with the customer. | [optional] |
|
|
15
17
|
|
|
16
18
|
## Example
|
|
@@ -20,12 +22,14 @@ require 'cybrid_api_bank_ruby'
|
|
|
20
22
|
|
|
21
23
|
instance = CybridApiBank::PostCustomerBankModel.new(
|
|
22
24
|
type: null,
|
|
23
|
-
name: null,
|
|
24
25
|
address: null,
|
|
25
|
-
date_of_birth: null,
|
|
26
26
|
phone_number: null,
|
|
27
27
|
email_address: null,
|
|
28
28
|
identification_numbers: null,
|
|
29
|
+
name: null,
|
|
30
|
+
date_of_birth: null,
|
|
31
|
+
aliases: null,
|
|
32
|
+
website: null,
|
|
29
33
|
labels: null
|
|
30
34
|
)
|
|
31
35
|
```
|