# Models

## The Client object

```json
{"openapi":"3.1.0","info":{"title":"Rialto Manager API","version":"1.0.0"},"components":{"schemas":{"Client":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the client."},"status":{"type":"string","enum":["ONBOARDING_IN_PROGRESS","ONBOARDING_UNDER_REVIEW","RESUBMISSION_REQUIRED","WAITING_FOR_TERMS_AND_CONDITIONS_SIGNATURE","VERIFIED","DELETED"],"description":"The status of the client. <br />\n  - ONBOARDING_IN_PROGRESS: The client is in the onboarding process. <br />\n  - ONBOARDING_UNDER_REVIEW: The client is under review. <br />\n  - RESUBMISSION_REQUIRED: Rialto's compliance team has required more information for onboarding, information must be resubmitted.<br />\n  - WAITING_FOR_TERMS_AND_CONDITIONS_SIGNATURE: The client is waiting for the terms and conditions signature. <br />\n  - VERIFIED: The client is verified,\n  - DELETED: The client is deleted.\n"},"clientType":{"type":"string","enum":["INDIVIDUAL","ENTITY"],"description":"The type of the client. <br />\n  - INDIVIDUAL: The client is an individual client. <br />\n  - ENTITY: The client is an entity client.\n"},"company":{"type":["object","null"],"description":"The company information of the client.<br /> This field is only present for entity clients, i.e. when the `clientType` is **ENTITY**.\n","properties":{"name":{"type":"string","description":"The name of the company."},"registrationNumber":{"type":["string","null"],"description":"The registration number of the company.<br /> Can be null during the onboarding process.\n"},"registeredAddress":{"type":["string","null"],"description":"The registered address of the company.<br /> Can be null during the onboarding process.\n"},"registeredAddressCity":{"type":["string","null"],"description":"The registered address city of the company.<br /> Can be null during the onboarding process.\n"},"registeredAddressPostalCode":{"type":["string","null"],"description":"The registered address postal code of the company.<br /> Can be null during the onboarding process.\n"},"registeredAddressCountryCode":{"type":["string","null"],"description":"The registered address country code of the company.<br /> Can be null during the onboarding process.<br /> See the [list of supported country codes](https://docs.rialtobridge.xyz/concepts).\n"},"placeOfEffectiveBusiness":{"type":["string","null"],"description":"The place of effective business of the company.<br /> Can be null during the onboarding process.\n"},"businessSector":{"type":["string","null"],"description":"The business sector of the company.<br /> Can be null during the onboarding process.<br /> See the [list of supported business sectors](https://docs.rialtobridge.xyz/concepts).\n"},"businessSectorDescription":{"type":["string","null"],"description":"The business sector description of the company if not in the list of business sectors."},"turnover":{"type":["string","null"],"description":"The turnover of the company.<br /> Can be null during the onboarding process.\n"},"turnoverDocuments":{"type":["array"],"description":"The keys of the documents related to the turnover of the company.<br /> Each key can be used in order to download the document.\n","items":{"type":"string"}},"lastTaxNoticeDocuments":{"type":["array"],"description":"The keys of the documents related to the last tax notice of the company.<br /> Each key can be used in order to download the document.\n","items":{"type":"string"}},"purposeOfOnboarding":{"type":["string","null"],"description":"The purpose of onboarding of the company.<br /> Can be null during the onboarding process.<br /> See the [list of supported purposes of onboarding](https://docs.rialtobridge.xyz/concepts).\n"},"proofOfIncorporationDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the proof of incorporation of the company.<br /> Each key can be used in order to download the document.\n"}},"memorandumOfAssociationDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the memorandum of association of the company.<br /> Each key can be used in order to download the document.\n"}},"registryOfDirectorsAndShareholdersDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the registry of directors and shareholders of the company.<br /> Each key can be used in order to download the document.\n"}},"structureChartOfShareholdersDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the structure chart of shareholders of the company.<br /> Each key can be used in order to download the document.\n"}},"proofOfAmlDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the proof of AML of the company.<br /> Each key can be used in order to download the document.\n"}}}},"companyRepresentatives":{"type":["array","null"],"description":"The entity representatives of the client.<br /> This field is only present for entity clients, i.e. when the `clientType` is **ENTITY**.\n","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the representative."},"firstName":{"type":"string","description":"The first name of the representative."},"lastName":{"type":"string","description":"The last name of the representative."},"email":{"type":"string","format":"email","description":"The email of the representative."},"phone":{"type":["string","null"],"description":"The phone number of the representative.<br /> Can be null during the onboarding process.\n"},"jobTitle":{"type":["string","null"],"description":"The job title of the representative.<br /> Can be null during the onboarding process.\n"},"supportingDocuments":{"type":"array","items":{"type":"string"},"description":"The keys of the documents related to the representative.<br /> Each key can be used in order to download the document.\n"},"role":{"type":"string","enum":["AUTHORIZED_SIGNATORY","OPERATOR"],"description":"The role of the representative.<br />\n  - AUTHORIZED_SIGNATORY: The representative is an authorized signatory of the company,\n  - OPERATOR: The representative is an operator of the company.\n"},"createdAt":{"type":"string","format":"date-time","description":"The creation date of the representative."},"updatedAt":{"type":"string","format":"date-time","description":"The last update date of the representative."},"deletedAt":{"type":["string","null"],"format":"date-time","description":"The deletion date of the representative."}}}},"companyDirectorsAndUbos":{"type":["object","null"],"description":"The directors and UBOs of the company.<br /> This field is only present for entity clients, i.e. when the `clientType` is **ENTITY**. Null for individual clients.\n","properties":{"directors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the director."},"idDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the ID of the director.<br /> Each key can be used in order to download the document.\n"}},"proofOfAddressDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the proof of address of the director.<br /> Each key can be used in order to download the document.\n"}},"proofOfAmlDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the proof of AML of the director.<br /> Each key can be used in order to download the document.\n"}}}}},"ubos":{"type":"array","items":{"allOf":[{"type":"object","properties":{"name":{"type":"string","description":"The name of the director."},"typeOfPerson":{"type":"string","pattern":"NATURAL"},"idDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the ID of the director.<br /> Each key can be used in order to download the document.\n"}},"proofOfAddressDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the proof of address of the director.<br /> Each key can be used in order to download the document.\n"}},"proofOfAmlDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the proof of AML of the director.<br /> Each key can be used in order to download the document.\n"}}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the director."},"typeOfPerson":{"type":"string","pattern":"LEGAL"},"proofOfIncorporationDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the proof of incorporation of the company.<br /> Each key can be used in order to download the document.\n"}},"memorandumOfAssociationDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the memorandum of association of the company.<br /> Each key can be used in order to download the document.\n"}},"registryOfDirectorsAndShareholdersDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the registry of directors and shareholders of the company.<br /> Each key can be used in order to download the document.\n"}},"proofOfAmlDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the proof of AML of the director.<br /> Each key can be used in order to download the document.\n"}}}}],"discriminator":{"propertyName":"typeOfPerson"}}}}},"individualProfile":{"type":["object","null"],"description":"The individual profile of the client.<br /> This field is only present for individual clients, i.e. when the `clientType` is **INDIVIDUAL**.\n","properties":{"firstName":{"type":"string","description":"The first name of the individual."},"lastName":{"type":"string","description":"The last name of the individual."},"email":{"type":["string","null"],"format":"email","description":"The email of the individual.<br /> Can be null during the onboarding process.\n"},"phone":{"type":["string","null"],"description":"The phone of the individual.<br /> Can be null during the onboarding process.\n"},"address":{"type":["string","null"],"description":"The address of the individual.<br /> Can be null during the onboarding process.\n"},"city":{"type":["string","null"],"description":"The city of the individual.<br /> Can be null during the onboarding process.\n"},"postalCode":{"type":["string","null"],"description":"The postal code of the individual.<br /> Can be null during the onboarding process.\n"},"countryCode":{"type":["string","null"],"description":"The country code of the individual.<br /> Can be null during the onboarding process.\n"},"occupation":{"type":["string","null"],"description":"The occupation of the individual.<br /> Can be null during the onboarding process.<br /> See the [list of supported occupations](https://docs.rialtobridge.xyz/concepts).\n"},"occupationDescription":{"type":["string","null"],"description":"The occupation description of the individual if not in the list of occupations."},"companyName":{"type":["string","null"],"description":"The company name of the individual.<br /> Can be null during the onboarding process.\n"},"jobBusinessSector":{"type":["string","null"],"description":"The job business sector of the individual.<br /> Can be null during the onboarding process.<br /> See the [list of supported business sectors](https://docs.rialtobridge.xyz/concepts).\n"},"jobBusinessSectorDescription":{"type":["string","null"],"description":"The job business sector description of the individual if not in the list of business sectors."},"purposeOfOnboarding":{"type":["string","null"],"description":"The purpose of onboarding of the individual.<br /> Can be null during the onboarding process.<br /> See the [list of supported purposes of onboarding](https://docs.rialtobridge.xyz/concepts).\n"},"idDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the ID Documentation of the individual.<br /> Each key can be used in order to download the document.\n"}},"proofOfAddressDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the proof of address of the individual.<br /> Each key can be used in order to download the document.\n"}},"proofOfAmlDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the proof of AML of the individual.<br /> Each key can be used in order to download the document.\n"}}}},"individualSourceOfFunds":{"type":["object","null"],"description":"The source of funds of the individual.<br /> This field is only present for individual clients, i.e. when the `clientType` is **INDIVIDUAL**.\n","properties":{"sourceOfFunds":{"type":["string","null"],"description":"The source of funds of the user.<br /> Can be null during the onboarding process.<br /> See the [list of supported sources of funds](https://docs.rialtobridge.xyz/concepts).\n"},"sourceOfFundsDescription":{"type":["string","null"],"description":"The source of funds description of the user if not in the list of sources of funds."},"annualRevenueRange":{"type":["string","null"],"description":"The annual revenue range of the user.<br /> Can be null during the onboarding process.<br /> See the [list of supported annual revenue ranges](https://docs.rialtobridge.xyz/concepts).\n"},"globalWealthRange":{"type":["string","null"],"description":"The global wealth range of the user.<br /> Can be null during the onboarding process. <br /> See the [list of supported global wealth ranges](https://docs.rialtobridge.xyz/concepts).\n"},"sourceOfFundsDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the source of funds of the individual.<br /> Each key can be used in order to download the document.\n"}},"proofOfTaxResidencyDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the proof of tax residency of the individual.<br /> Each key can be used in order to download the document.\n"}},"taxNoticeDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the tax notice of the individual.<br /> Each key can be used in order to download the document.\n"}},"supportingOccupationDocuments":{"type":"array","items":{"type":"string","description":"The keys of the documents related to the occupation of the individual.<br /> Each key can be used in order to download the document.\n"}}}},"onboardingResubmissionReason":{"type":["string","null"],"description":"The reason why the onboarding information must be resubmitted.<br /> This field is only present when the client is in the status **RESUBMISSION_REQUIRED**.\n"},"createdAt":{"type":"string","format":"date-time","description":"The creation date of the client."},"updatedAt":{"type":"string","format":"date-time","description":"The last update date of the client."},"deletedAt":{"type":["string","null"],"format":"date-time","description":"The deletion date of the client."}}}}}}
```

## The BankAccountIdentifiers object

```json
{"openapi":"3.1.0","info":{"title":"Rialto Manager API","version":"1.0.0"},"components":{"schemas":{"BankAccountIdentifiers":{"type":"object","description":"The identifiers of the bank account.","oneOf":[{"type":"object","properties":{"format":{"type":"string","enum":["IBAN"]},"iban":{"type":"string","description":"The IBAN of the bank account."},"bic":{"type":"string","description":"The BIC of the bank account."}}},{"type":"object","properties":{"format":{"type":"string","enum":["SWIFT"]},"accountNumber":{"type":"string","description":"The account number of the bank account."},"swift":{"type":"string","description":"The SWIFT of the bank account."}}},{"type":"object","properties":{"format":{"type":"string","enum":["SWIFT_MX"]},"clabe":{"type":"string","description":"The CLABE of the bank account."},"bic":{"type":"string","description":"The BIC of the bank account."}}},{"type":"object","properties":{"format":{"type":"string","enum":["ROUTING_NUMBER"]},"accountNumber":{"type":"string","description":"The account number of the bank account."},"routingNumber":{"type":"string","description":"The routing number of the bank account."}}},{"type":"object","properties":{"format":{"type":"string","enum":["SORT_CODE"]},"accountNumber":{"type":"string","description":"The account number of the bank account."},"sortCode":{"type":"string","description":"The sort code of the bank account."}}},{"type":"object","properties":{"format":{"type":"string","enum":["IN_INR"]},"accountNumber":{"type":"string","description":"The account number of the bank account."},"ifsc":{"type":"string","description":"The IFSC of the bank account."}}},{"type":"object","properties":{"format":{"type":"string","enum":["AU"]},"accountNumber":{"type":"string","description":"The account number of the bank account."},"bsb":{"type":"string","description":"The BSB of the bank account."}}}]}}}}
```

## The CreateBankAccountPayload object

```json
{"openapi":"3.1.0","info":{"title":"Rialto Manager API","version":"1.0.0"},"components":{"schemas":{"CreateBankAccountPayload":{"type":"object","properties":{"label":{"type":["string","null"],"description":"The label of the bank account."},"fiatCurrency":{"type":"string","description":"The fiat currency of the bank account. See [the list of supported](https://docs.rialtobridge.xyz/concepts) fiat currencies."},"countryCode":{"type":"string","description":"The country code of the bank account."},"type":{"type":"string","description":"The type of the bank account. Possible values are:\n  - PERSONAL: The bank account is owned by the user,\n  - THIRD_PARTY: The bank account is owned by a third party, other than the user.\n","enum":["PERSONAL","THIRD_PARTY"]},"identifiers":{"$ref":"#/components/schemas/BankAccountIdentifiers"},"thirdPartyBankAccountOwnerName":{"type":["string","null"],"description":"The name of the owner of the bank account.<br /> Only present if the bank account is of type **THIRD_PARTY**.\n"},"thirdPartyBankAccountOwnerAddress":{"type":["string","null"],"description":"The address of the owner of the bank account.<br /> Only present if the bank account is of type **THIRD_PARTY**.\n"},"thirdPartyBankAccountOwnerCity":{"type":["string","null"],"description":"The city of the owner of the bank account.<br /> Only present if the bank account is of type **THIRD_PARTY**.\n"},"thirdPartyBankAccountOwnerPostalCode":{"type":["string","null"],"description":"The postal code of the owner of the bank account.<br /> Only present if the bank account is of type **THIRD_PARTY**.\n"},"thirdPartyBankAccountOwnerCountryCode":{"type":["string","null"],"description":"The country code of the owner of the bank account.<br /> Only present if the bank account is of type **THIRD_PARTY**.\n"},"thirdPartyBankAccountOwnerDocuments":{"type":["array","null"],"description":"The filenames of the documents of the owner of the bank account.<br /> The documents must be uploaded before creating the bank account.<br /> Only present if the bank account is of type **THIRD_PARTY**.\n","items":{"type":"string"}}}},"BankAccountIdentifiers":{"type":"object","description":"The identifiers of the bank account.","oneOf":[{"type":"object","properties":{"format":{"type":"string","enum":["IBAN"]},"iban":{"type":"string","description":"The IBAN of the bank account."},"bic":{"type":"string","description":"The BIC of the bank account."}}},{"type":"object","properties":{"format":{"type":"string","enum":["SWIFT"]},"accountNumber":{"type":"string","description":"The account number of the bank account."},"swift":{"type":"string","description":"The SWIFT of the bank account."}}},{"type":"object","properties":{"format":{"type":"string","enum":["SWIFT_MX"]},"clabe":{"type":"string","description":"The CLABE of the bank account."},"bic":{"type":"string","description":"The BIC of the bank account."}}},{"type":"object","properties":{"format":{"type":"string","enum":["ROUTING_NUMBER"]},"accountNumber":{"type":"string","description":"The account number of the bank account."},"routingNumber":{"type":"string","description":"The routing number of the bank account."}}},{"type":"object","properties":{"format":{"type":"string","enum":["SORT_CODE"]},"accountNumber":{"type":"string","description":"The account number of the bank account."},"sortCode":{"type":"string","description":"The sort code of the bank account."}}},{"type":"object","properties":{"format":{"type":"string","enum":["IN_INR"]},"accountNumber":{"type":"string","description":"The account number of the bank account."},"ifsc":{"type":"string","description":"The IFSC of the bank account."}}},{"type":"object","properties":{"format":{"type":"string","enum":["AU"]},"accountNumber":{"type":"string","description":"The account number of the bank account."},"bsb":{"type":"string","description":"The BSB of the bank account."}}}]}}}}
```

## The CreateBlockchainWalletPayload object

```json
{"openapi":"3.1.0","info":{"title":"Rialto Manager API","version":"1.0.0"},"components":{"schemas":{"CreateBlockchainWalletPayload":{"type":"object","properties":{"label":{"type":["string","null"],"description":"The label of the blockchain wallet."},"blockchainNetwork":{"type":"string","description":"The blockchain network of the wallet. See [the list of supported](https://docs.rialtobridge.xyz/concepts) blockchains."},"address":{"type":"string","description":"The address of the blockchain wallet."}}}}}}
```

## The BankAccount object

```json
{"openapi":"3.1.0","info":{"title":"Rialto Manager API","version":"1.0.0"},"components":{"schemas":{"BankAccount":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the bank account."},"label":{"type":["string","null"],"description":"The label of the bank account."},"fiatCurrency":{"type":"string","description":"The fiat currency of the bank account. See [the list of supported](https://docs.rialtobridge.xyz/concepts) fiat currencies."},"countryCode":{"type":"string","description":"The country code of the bank account. See [the list of supported](https://docs.rialtobridge.xyz/concepts) country codes."},"type":{"type":"string","description":"The type of the bank account. Possible values are:\n  - PERSONAL: The bank account is owned by the user,\n  - THIRD_PARTY: The bank account is owned by a third party, other than the user.\n","enum":["PERSONAL","THIRD_PARTY"]},"identifiers":{"$ref":"#/components/schemas/BankAccountIdentifiers"},"thirdPartyBankAccountOwnerName":{"type":["string","null"],"description":"The name of the owner of the bank account.<br /> Only present if the bank account is of type **THIRD_PARTY**.\n"},"thirdPartyBankAccountOwnerAddress":{"type":["string","null"],"description":"The address of the owner of the bank account.<br /> Only present if the bank account is of type **THIRD_PARTY**.\n"},"thirdPartyBankAccountOwnerCity":{"type":["string","null"],"description":"The city of the owner of the bank account.<br /> Only present if the bank account is of type **THIRD_PARTY**.\n"},"thirdPartyBankAccountOwnerPostalCode":{"type":["string","null"],"description":"The postal code of the owner of the bank account.<br /> Only present if the bank account is of type **THIRD_PARTY**.\n"},"thirdPartyBankAccountOwnerCountryCode":{"type":["string","null"],"description":"The country code of the owner of the bank account.<br /> Only present if the bank account is of type **THIRD_PARTY**.\n"},"thirdPartyBankAccountOwnerDocuments":{"type":["array","null"],"description":"The keys of the documents of the owner of the bank account.<br /> Each key can be used in order to download the document.<br /> Only present if the bank account is of type **THIRD_PARTY**.\n","items":{"type":"string"}},"createdAt":{"type":"string","format":"date-time","description":"The creation date of the bank account."},"approvedAt":{"type":["string","null"],"format":"date-time","description":"The date when the bank account was approved.<br /> Only present if the bank account was approved.\n"},"deletedAt":{"type":["string","null"],"format":"date-time","description":"The date when the bank account was deleted.<br /> Only present if the bank account was deleted.\n"}}},"BankAccountIdentifiers":{"type":"object","description":"The identifiers of the bank account.","oneOf":[{"type":"object","properties":{"format":{"type":"string","enum":["IBAN"]},"iban":{"type":"string","description":"The IBAN of the bank account."},"bic":{"type":"string","description":"The BIC of the bank account."}}},{"type":"object","properties":{"format":{"type":"string","enum":["SWIFT"]},"accountNumber":{"type":"string","description":"The account number of the bank account."},"swift":{"type":"string","description":"The SWIFT of the bank account."}}},{"type":"object","properties":{"format":{"type":"string","enum":["SWIFT_MX"]},"clabe":{"type":"string","description":"The CLABE of the bank account."},"bic":{"type":"string","description":"The BIC of the bank account."}}},{"type":"object","properties":{"format":{"type":"string","enum":["ROUTING_NUMBER"]},"accountNumber":{"type":"string","description":"The account number of the bank account."},"routingNumber":{"type":"string","description":"The routing number of the bank account."}}},{"type":"object","properties":{"format":{"type":"string","enum":["SORT_CODE"]},"accountNumber":{"type":"string","description":"The account number of the bank account."},"sortCode":{"type":"string","description":"The sort code of the bank account."}}},{"type":"object","properties":{"format":{"type":"string","enum":["IN_INR"]},"accountNumber":{"type":"string","description":"The account number of the bank account."},"ifsc":{"type":"string","description":"The IFSC of the bank account."}}},{"type":"object","properties":{"format":{"type":"string","enum":["AU"]},"accountNumber":{"type":"string","description":"The account number of the bank account."},"bsb":{"type":"string","description":"The BSB of the bank account."}}}]}}}}
```

## The BlockchainWallet object

```json
{"openapi":"3.1.0","info":{"title":"Rialto Manager API","version":"1.0.0"},"components":{"schemas":{"BlockchainWallet":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the blockchain wallet."},"label":{"type":["string","null"],"description":"The label of the blockchain wallet."},"blockchainNetwork":{"type":"string","description":"The blockchain network of the wallet. See [the list of supported](https://docs.rialtobridge.xyz/concepts) blockchains."},"address":{"type":"string","description":"The address of the blockchain wallet."},"createdAt":{"type":"string","format":"date-time","description":"The creation date of the blockchain wallet."},"approvedAt":{"type":["string","null"],"format":"date-time","description":"The date when the blockchain wallet was approved.<br /> Only present if the blockchain wallet aws approved.\n"},"deletedAt":{"type":["string","null"],"format":"date-time","description":"The date when the blockchain wallet was deleted.<br /> Only present if the blockchain wallet was deleted.\n"}}}}}}
```

## The PresetFee object

```json
{"openapi":"3.1.0","info":{"title":"Rialto Manager API","version":"1.0.0"},"components":{"schemas":{"PresetFee":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the preset fee."},"feeDirection":{"type":"string","description":"The type of the fee. Possible values are:\n  - OFFRAMP: The fee only concerns off-ramping of blockchain asset to fiat currency,\n  - ONRAMP: The fee only concerns on-ramping of fiat currency to blockchain asset.\n  - ONOFFRAMP: The fee concerns both on-ramping and off-ramping.\n","enum":["OFFRAMP","ONRAMP","ONOFFRAMP"]},"fiatFeeGroup":{"type":"string","description":"The fiat fee group of the preset fee. See [the list of supported](https://docs.rialtobridge.xyz/concepts) fiat fee groups."},"blockchainFeeGroup":{"type":"string","description":"The blockchain fee group of the preset fee. See [the list of supported](https://docs.rialtobridge.xyz/concepts) blockchain fee groups."},"configuration":{"type":"object","description":"The configuration of the preset fee.","oneOf":[{"type":"object","description":"The same fee is applied to all transactions.","properties":{"type":{"type":"string","enum":["FLAT"]},"fee":{"type":"number","format":"uint32","description":"The fee in BPS (basis points) applied to any transaction for this path.<br />. The value is always positive.\n"},"fixedFee":{"type":"object","additionalProperties":{"type":"string"},"description":"A fixed fee amount denominated in origin currency applied to any transaction for this path.<br />. The property is an object for which keys are currencies or assets, and values are the applied fixed fee.<br />. Fixed fees are always positive.\n"}}},{"type":"object","description":"The fee is computed based on the monthly volume of the transactions for this path. The reference date is using the UTC timezone.","properties":{"type":{"type":"string","enum":["MONTHLY_VOLUME"]},"fixedFee":{"type":"object","additionalProperties":{"type":"string"},"description":"A fixed fee amount denominated in origin currency applied to any transaction for this path.<br />. The property is an object for which keys are currencies or assets, and values are the applied fixed fee.<br />. Fixed fees are always positive.\n"},"intermediaryLimits":{"type":"array","items":{"type":"object","properties":{"to":{"type":"number","format":"float","description":"The upper limit for this range of monthly volume.<br /> The value is always positive. Only two decimal places are allowed.\n"},"fee":{"type":"number","format":"uint32","description":"The fee in BPS (basis points) applied in this range.<br /> The value is always positive.\n"}}}},"upperLimitFee":{"type":"number","format":"uint32","description":"The fee in BPS (basis points) applied to any transaction for this path above the last range.<br /> The value is always positive.\n"}}},{"type":"object","description":"The fee is computed based on the daily volume of the transactions for this path. The reference date is using the UTC timezone.","properties":{"type":{"type":"string","enum":["DAILY_VOLUME"]},"intermediaryLimits":{"type":"array","items":{"type":"object","properties":{"to":{"type":"number","format":"float","description":"The upper limit for this range of monthly volume.<br /> The value is always positive. Only two decimal places are allowed.\n"},"fee":{"type":"number","format":"uint32","description":"The fee in BPS (basis points) applied in this range.<br /> The value is always positive.\n"}}}},"upperLimitFee":{"type":"number","format":"uint32","description":"The fee in BPS (basis points) applied to any transaction for this path above the last range.<br /> The value is always positive.\n"}}}]},"createdAt":{"type":"string","format":"date-time","description":"The creation date of the preset fee."}}}}}}
```

## The FiatDepositInstruction object

```json
{"openapi":"3.1.0","info":{"title":"Rialto Manager API","version":"1.0.0"},"components":{"schemas":{"FiatDepositInstruction":{"type":"object","properties":{"label":{"type":"string","description":"The label of the deposit instruction."},"fiatCurrency":{"type":"string","description":"The fiat currency of the bank account. See [the list of supported](https://docs.rialtobridge.xyz/concepts) fiat currencies."},"bankName":{"type":"string","description":"The name of the bank."},"countryCode":{"type":"string","description":"The country code of the bank account. See [the list of supported](https://docs.rialtobridge.xyz/concepts) country codes."},"identifiers":{"type":"object","description":"The identifiers of the bank account.","properties":{"iban":{"type":"string","description":"The IBAN of the bank account."},"bic":{"type":"string","description":"The BIC of the bank account."},"intermediaryBic":{"type":["string","null"],"description":"The intermediary BIC of the bank account."}}},"beneficiary":{"type":"object","description":"The beneficiary of the bank account.","properties":{"name":{"type":"string","description":"The name of the beneficiary."},"address":{"type":["string","null"],"description":"The address of the beneficiary."},"city":{"type":["string","null"],"description":"The city of the beneficiary."},"postalCode":{"type":"string","description":"The postal code of the beneficiary."},"countryCode":{"type":"string","description":"The country code of the beneficiary. See [the list of supported](https://docs.rialtobridge.xyz/concepts) country codes."}}},"isSegregated":{"type":"boolean","description":"The flag indicating if the bank account is segregated for the beneficiary."}}}}}}
```

## The BlockchainDepositInstruction object

```json
{"openapi":"3.1.0","info":{"title":"Rialto Manager API","version":"1.0.0"},"components":{"schemas":{"BlockchainDepositInstruction":{"type":"object","properties":{"label":{"type":"string","description":"The label of the deposit instruction."},"blockchainNetwork":{"type":"string","description":"The blockchain network of the deposit instruction. See [the list of supported](https://docs.rialtobridge.xyz/concepts) blockchains."},"walletAddress":{"type":"string","description":"The wallet address of the deposit instruction."},"isSegregated":{"type":"boolean","description":"The flag indicating if the wallet is segregated for the beneficiary."}}}}}}
```

## The Transaction object

```json
{"openapi":"3.1.0","info":{"title":"Rialto Manager API","version":"1.0.0"},"components":{"schemas":{"Transaction":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the transaction."},"transactionType":{"type":"string","description":"The type of the transaction. Possible values are:\n  - OFFRAMP: The transaction is an off-ramping of blockchain asset to fiat currency,\n  - ONRAMP: The transaction is an on-ramping of fiat currency to blockchain asset.\n","enum":["OFFRAMP","ONRAMP"]},"status":{"type":"string","description":"The status of the transaction. Possible values are:\n  - IDLE: The transaction has been created and is waiting for the initial funds transfer to be initiated,\n  - INITIATED: transaction has been initiated, it is in progress of resolution by Rialto,\n  - COMPLETED: The transaction has been completed,\n  - CANCELLED: The transaction has been cancelled,\n  - DISMISSED: The transaction has been dismissed by Rialto.\n","enum":["IDLE","INITIATED","COMPLETED","CANCELLED","DISMISSED"]},"idempotencyKey":{"type":["string","null"],"description":"The idempotency key input at the transaction creation.<br /> It is only defined for transactions created by the API\n"},"originalAmount":{"type":"number","format":"float","description":"The original amount of the transaction.<br /> The value is always positive.\n"},"fiatCurrency":{"type":"string","description":"The fiat currency of the transaction. See [the list of supported](https://docs.rialtobridge.xyz/concepts) fiat currencies."},"blockchainAsset":{"type":"string","description":"The blockchain asset of the transaction. See [the list of supported](https://docs.rialtobridge.xyz/concepts) blockchain assets."},"blockchainNetwork":{"type":"string","description":"The blockchain network of the transaction. See [the list of supported](https://docs.rialtobridge.xyz/concepts) blockchains."},"blockchainWalletId":{"type":"string","format":"uuid","description":"The blockchain wallet identifier of transaction."},"bankAccountId":{"type":"string","format":"uuid","description":"The bank account identifier of transaction.<br /> The fiat currency of the transaction is the one of the bank account.\n"},"wireReferenceOverride":{"type":["string","null"],"description":"In case of offramp, string that will replace the default wire reference.<br /> Use for specific cases of matching and integration on the client bank side.<br /> Field is optional.\n"},"additionalDetails":{"type":"object","description":"The additional details of the transaction.<br /> It can be used to store additional information about the transaction.\n","properties":{"sourceOfFundsDocuments":{"type":"array","items":{"type":"string"},"description":"The keys of the documents uploaded by the user as the source of funds.<br /> Each key can be used in order to download the document.\n"},"businessJustificationDocuments":{"type":"array","items":{"type":"string"},"description":"The keys of the documents uploaded by the user as the business justification.<br /> Each key can be used in order to download the document.\n"},"comments":{"type":"string","description":"Comments added by the user at the creation of the transaction."}}},"initiationInstruction":{"type":"object","description":"The initiation instruction of the transaction.<br /> It changes depending on the transaction type.<br />\n","properties":{"blockchainWallet":{"type":["object","null"],"description":"The Rialto blockchain wallet to which the initiation transfer must be done.<br /> Only present if the transaction is an off-ramp transaction, i.e. transaction type **OFFRAMP**.\n","properties":{"address":{"type":"string","description":"The blockchain wallet address."},"blockchainNetwork":{"type":"string","description":"The blockchain network of the wallet."}}},"bankAccount":{"type":["object","null"],"description":"The Rialto bank account to which the initiation transfer must be done.<br /> Only present if the transaction is an on-ramp transaction, i.e. transaction type **ONRAMP**.\n","properties":{"countryCode":{"type":"string","description":"The country code of the bank account."},"iban":{"type":"string","description":"The IBAN of the bank account."},"bic":{"type":"string","description":"The BIC of the bank account."},"intermediaryBic":{"type":["string","null"],"description":"The intermediary BIC of the bank account."},"beneficiary":{"type":"object","description":"The beneficiary of the bank account.","properties":{"name":{"type":"string","description":"The name of the beneficiary."},"address":{"type":["string","null"],"description":"The address of the beneficiary."},"city":{"type":["string","null"],"description":"The city of the beneficiary."},"postcode":{"type":"string","description":"The postcode of the beneficiary."},"countryCode":{"type":"string","description":"The country code of the beneficiary."}}}}},"wireReference":{"type":["string","null"],"description":"The wire reference to include in the initiation transfer to Rialto bank account.<br /> Only present if the transaction is an on-ramp transaction, i.e. transaction type **ONRAMP**.\n"}}},"createdAt":{"type":"string","format":"date-time","description":"The creation date of the transaction."},"initiation":{"type":["object","null"],"description":"The initiation object of the transaction.<br /> Only present if the transaction has been initiated, i.e. in statuses **INITIATED** or **COMPLETED**.<br /> Object will also be present if the transaction has been dismissed by Rialto after initiation, i.e. in status **DISMISSED**.\n","properties":{"amount":{"type":"number","format":"float","description":"The amount of the initial funds transfer to Rialto.<br /> A margin of 1% with respect to the original amount is allowed.<br /> The value is always positive.\n"},"bpsFee":{"type":"number","format":"uint32","description":"The previsionnal fee of the transaction in BPS (basis points).<br /> The volume part of the fee amount can be derived by applying the BPS fee to the amount of the initial funds transfer.<br /> The value is always positive.\n"},"fixedFee":{"type":"number","format":"uint32","description":"The previsionnal fixed fee applied to the transaction.<br /> The fixed fee is applied after the calculation of the volume fee in the total fee computation.<br /> This fee is only applied on offramps, for flows originating from usd or euro stablecoins.<br /> The value is always positive.\n"},"timestamp":{"type":"string","format":"date-time","description":"The date when the funds were received by Rialto, activating the transaction"},"transactionHash":{"type":["string","null"],"description":"The transaction hash of the initiation of the transaction.<br /> Only present for off-ramps, i.e. transaction type **OFFRAMP**.\n"},"wireReference":{"type":["string","null"],"description":"The wire reference of the initiation of the transaction.<br /> Only present for on-ramps, i.e. transaction type **ONRAMP**.\n"}}},"completion":{"type":["object","null"],"description":"The completion object of the transaction.<br /> Only present if the transaction is completed, i.e. in status **COMPLETED**.\n","properties":{"amount":{"type":"number","format":"float","description":"The amount of the transfer to the user.<br /> The value is always positive.\n"},"conversionRate":{"type":"number","format":"float","description":"The conversion rate of the transaction.<br /> For off-ramp transactions, it is the rate of the blockchain asset to fiat currency.<br /> For on-ramp transactions, it is the rate of the fiat currency to blockchain asset.<br/> The value is always positive.\n"},"volumeConsumption":{"type":"number","format":"float","description":"The consumption of the monthly volume of the transaction. <br /> The value is in US dollars. It is computed based on the amount of the transaction, the blockchain asset, the fiat currency, the execution conversion rate and possibly the conversion rate to USD at the time of completion of the transaction.<br /> The value is always positive. Only two decimal places are allowed.\n"},"transactionHash":{"type":["string","null"],"description":"The transaction hash of the completion of the transaction.<br /> Only present for on-ramps, i.e. transaction type **ONRAMP**.\n"},"wireReference":{"type":["string","null"],"description":"The wire reference of the completion of the transaction.<br /> Only present for off-ramps, i.e. transaction type **OFFRAMP**.\n"},"timestamp":{"type":"string","format":"date-time","description":"The date when the transaction was completed"}}},"cancelledAt":{"type":["string","null"],"format":"date-time","description":"The date when the transaction was cancelled.<br /> Only present if the transaction was cancelled, i.e. in status **CANCELLED**.\n"},"dismissal":{"type":["object","null"],"description":"The dismissal object of the transaction.<br /> A transaction can be dismissed by Rialto at any time in case of a problem.<br /> Only present if the transaction was dismissed by Rialto, i.e. in status **DISMISSED**.\n","properties":{"reason":{"type":"string","description":"The reason why the transaction was dismissed."},"timestamp":{"type":"string","format":"date-time","description":"The date when the transaction was dismissed"}}},"clientId":{"type":"string","format":"uuid","description":"The unique identifier of the client."},"clientType":{"type":"string","enum":["INDIVIDUAL","ENTITY"],"description":"The type of the client. <br />\n  - INDIVIDUAL: The client is an individual. <br />\n  - ENTITY: The client is an entity.\n"}}}}}}
```

## The TransactionQuote object

```json
{"openapi":"3.1.0","info":{"title":"Rialto Manager API","version":"1.0.0"},"components":{"schemas":{"TransactionQuote":{"type":"object","properties":{"initiationAmount":{"type":"number","format":"float","description":"The input amount of the transaction.<br /> It will be the amount of the initial funds transfer to Rialto.<br /> The value is always positive.\n"},"completionAmount":{"type":"number","format":"float","description":"The estimated amount of the transferred amount to the user.<br /> The value is always positive.\n"},"bpsFee":{"type":"number","format":"uint32","description":"The previsionnal fee of the transaction in BPS (basis points).<br /> The volume part of the fee amount can be derived by applying the BPS fee to the amount of the initial funds transfer.<br /> The value is always positive.\n"},"fixedFee":{"type":"number","format":"uint32","description":"The previsionnal fixed fee applied to the transaction.<br /> The fixed fee is applied after the calculation of the volume fee in the total fee computation.<br /> This fee is only applied on offramps, for flows originating from usd or euro stablecoins.<br /> The value is always positive.\n"},"conversionRate":{"type":"number","format":"float","description":"The conversion rate of the transaction.<br /> For off-ramp transactions, it is the rate of the blockchain asset to fiat currency.<br /> For on-ramp transactions, it is the rate of the fiat currency to blockchain asset.<br/> The value is always positive.\n"},"volumeConsumption":{"type":"number","format":"float","description":"The estimated consumption of the monthly volume of the transaction. <br /> The value is in US dollars. It is computed based on the amount of the transaction, the blockchain asset, the fiat currency, the execution conversion rate and possibly the conversion rate to USD at the time of completion of the transaction.<br /> The value is always positive. Only two decimal places are allowed.\n"},"remainingPrevisionalVolume":{"type":"number","format":"float","description":"The remaining previsional volume of the user for the current month.<br /> It takes into account the volume consumed by the transaction and the volume consumed by the other transactions of the user.<br /> The value is in US dollars. It is computed based on the amount of the transaction, the blockchain asset, the fiat currency, the execution conversion rate and possibly the conversion rate to USD at the time of completion of the transaction.<br /> The value is always positive. Only two decimal places are allowed.\n"},"presetFeeId":{"type":"string","format":"uuid","description":"The unique identifier of the preset fee applied to the transaction.<br /> The value is null if no preset fee is applicable.\n"},"fiatCurrency":{"type":"string","description":"The fiat currency of the transaction. See [the list of supported](https://docs.rialtobridge.xyz/concepts) fiat currencies.<br /> The value is the one of the bank account.\n"},"blockchainAsset":{"type":"string","description":"The blockchain asset of the transaction. See [the list of supported](https://docs.rialtobridge.xyz/concepts) blockchain assets."},"blockchainNetwork":{"type":"string","description":"The blockchain network of the transaction. See [the list of supported](https://docs.rialtobridge.xyz/concepts) blockchains.<br /> The value is the one of the blockchain wallet.\n"}}}}}}
```

## The TransactionVolumeBreakdown object

```json
{"openapi":"3.1.0","info":{"title":"Rialto Manager API","version":"1.0.0"},"components":{"schemas":{"TransactionVolumeBreakdown":{"type":"object","properties":{"currentMonth":{"type":"object","properties":{"limit":{"type":"number","format":"float","description":"The monthly volume limit of the user.<br /> The value is in US dollars. Only two decimal places are allowed.\n"},"remaining":{"type":"number","format":"float","description":"The remaining volume of the user for the current month.<br /> The value is in US dollars. Only two decimal places are allowed.\n"},"idle":{"type":"number","format":"float","description":"The volume consumed by the user in **IDLE** transactions for the current month.<br /> The value is in US dollars. Only two decimal places are allowed.\n"},"initiated":{"type":"number","format":"float","description":"The volume consumed by the user in **INITIATED** transactions for the current month.<br /> The value is in US dollars. Only two decimal places are allowed.\n"},"completed":{"type":"number","format":"float","description":"The volume consumed by the user in **COMPLETED** transactions for the current month.<br /> The value is in US dollars. Only two decimal places are allowed.\n"},"total":{"type":"number","format":"float","description":"The total volume consumed by the user for the current month.<br /> The value is in US dollars. Only two decimal places are allowed.\n"}}},"paths":{"type":"array","items":{"type":"object","properties":{"transactionType":{"type":"string","description":"The type of the transaction path. Possible values are:\n  - OFFRAMP: The transaction is an off-ramping of blockchain asset to fiat currency,\n  - ONRAMP: The transaction is an on-ramping of fiat currency to blockchain asset.\n","enum":["OFFRAMP","ONRAMP"]},"fiatFeGroup":{"type":"string","description":"The fiat fee group of the transaction path. See [the list of supported](https://docs.rialtobridge.xyz/concepts) fiat fee groups."},"blockchainFeeGroup":{"type":"string","description":"The blockchain fee group of the transaction path. See [the list of supported](https://docs.rialtobridge.xyz/concepts) blockchain fee groups."},"currentMonth":{"type":"object","properties":{"idle":{"type":"number","format":"float","description":"The volume consumed by the user in **IDLE** transactions for this path for the current month.<br /> The value is in US dollars. Only two decimal places are allowed.\n"},"initiated":{"type":"number","format":"float","description":"The volume consumed by the user in **INITIATED** transactions for this path for the current month.<br /> The value is in US dollars. Only two decimal places are allowed.\n"},"completed":{"type":"number","format":"float","description":"The volume consumed by the user in **COMPLETED** transactions for this path for the current month.<br /> The value is in US dollars. Only two decimal places are allowed.\n"},"total":{"type":"number","format":"float","description":"The total volume consumed by the user for this path for the current month.<br /> The value is in US dollars. Only two decimal places are allowed.\n"}}},"currentDay":{"type":"object","properties":{"idle":{"type":"number","format":"float","description":"The volume consumed by the user in **IDLE** transactions for this path for the current day.<br /> The value is in US dollars. Only two decimal places are allowed.\n"},"initiated":{"type":"number","format":"float","description":"The volume consumed by the user in **INITIATED** transactions for this path for the current day.<br /> The value is in US dollars. Only two decimal places are allowed.\n"},"completed":{"type":"number","format":"float","description":"The volume consumed by the user in **COMPLETED** transactions for this path for the current day.<br /> The value is in US dollars. Only two decimal places are allowed.\n"},"total":{"type":"number","format":"float","description":"The total volume consumed by the user for this path for the current day.<br />\nThe value is in US dollars. Only two decimal places are allowed.\n"}}}}}}}}}}}
```

## The Webhook object

```json
{"openapi":"3.1.0","info":{"title":"Rialto Manager API","version":"1.0.0"},"components":{"schemas":{"Webhook":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the webhook."},"url":{"type":"string","format":"uri","description":"The URL of the webhook."},"createdAt":{"type":"string","format":"date-time","description":"The creation date of the webhook."},"updatedAt":{"type":"string","format":"date-time","description":"The last update date of the webhook."}}}}}}
```

## The SimulateFlatPresetFeeCreate object

```json
{"openapi":"3.1.0","info":{"title":"Rialto Manager API","version":"1.0.0"},"components":{"schemas":{"SimulateFlatPresetFeeCreate":{"type":"object","properties":{"feeDirection":{"type":"string","description":"The type of the fee. Possible values are:\n  - OFFRAMP: The fee only concerns off-ramping of blockchain asset to fiat currency,\n  - ONRAMP: The fee only concerns on-ramping of fiat currency to blockchain asset.\n  - ONOFFRAMP: The fee concerns both on-ramping and off-ramping.\n","enum":["OFFRAMP","ONRAMP","ONOFFRAMP]"]},"type":{"type":"string","description":"The type of the fee. Possible values are:\n  - FLAT: Flat fee % for each trade.\n","enum":["FLAT"]},"fiatFeeGroup":{"type":"string","description":"The fiat fee group of the preset fee. See [the list of supported](https://docs.rialtobridge.xyz/concepts) fiat fee groups."},"blockchainFeeGroup":{"type":"string","description":"The blockchain fee group of the preset fee. See [the list of supported](https://docs.rialtobridge.xyz/concepts) blockchain fee groups."},"fee":{"type":"number","format":"uint32","description":"The fee in BPS (basis points) applied in this range.<br /> The value is always positive.\n"}}}}}}
```

## The SimulateVolumePresetFeeCreate object

```json
{"openapi":"3.1.0","info":{"title":"Rialto Manager API","version":"1.0.0"},"components":{"schemas":{"SimulateVolumePresetFeeCreate":{"type":"object","properties":{"transactionType":{"type":"string","description":"The type of the transaction. Possible values are:\n  - OFFRAMP: The transaction is an off-ramping of blockchain asset to fiat currency,\n  - ONRAMP: The transaction is an on-ramping of fiat currency to blockchain asset.\n","enum":["OFFRAMP","ONRAMP"]},"type":{"type":"string","description":"The type of the fee. Possible values are:\n  - DAILY_VOLUME: Volume fee based on the daily volume of the client,\n  - MONTHLY_VOLUME: Volume fee based on the monthly volume of the client.\n","enum":["DAILY_VOLUME","MONTHLY_VOLUME"]},"fiatFeeGroup":{"type":"string","description":"The fiat fee group of the preset fee. See [the list of supported](https://docs.rialtobridge.xyz/concepts) fiat fee groups."},"blockchainFeeGroup":{"type":"string","description":"The blockchain fee group of the preset fee. See [the list of supported](https://docs.rialtobridge.xyz/concepts) blockchain fee groups."},"limits":{"type":"array","items":{"type":"object","properties":{"to":{"type":"number","format":"float","description":"The upper limit for this range of daily or monthly volume.<br /> The value is always positive. Only two decimal places are allowed.\n"},"fee":{"type":"number","format":"uint32","description":"The fee in BPS (basis points) applied in this range.<br /> The value is always positive.\n"}}}},"upperLimitFee":{"type":"number","format":"uint32","description":"The fee in BPS (basis points) applied to any transaction for this path above the last range.<br /> The value is always positive.\n"}}}}}}
```