@cobo/cobo-waas2 1.8.0 → 1.9.0

package/docs/TransactionsApi.md

@@ -12,10 +12,11 @@ Method | HTTP request | Description
 [**createTransferTransaction**](TransactionsApi.md#createTransferTransaction) | **POST** /transactions/transfer | Transfer token
 [**dropTransactionById**](TransactionsApi.md#dropTransactionById) | **POST** /transactions/{transaction_id}/drop | Drop transaction
 [**estimateFee**](TransactionsApi.md#estimateFee) | **POST** /transactions/estimate_fee | Estimate transaction fee
-[**getTransactionApprovalDetail**](TransactionsApi.md#getTransactionApprovalDetail) | **GET** /transactions/{transaction_id}/approval_detail | Get transaction approval information
+[**getTransactionApprovalDetail**](TransactionsApi.md#getTransactionApprovalDetail) | **GET** /transactions/{transaction_id}/approval_detail | Get transaction approval details
 [**getTransactionById**](TransactionsApi.md#getTransactionById) | **GET** /transactions/{transaction_id} | Get transaction information
 [**listTransactions**](TransactionsApi.md#listTransactions) | **GET** /transactions | List all transactions
 [**resendTransactionById**](TransactionsApi.md#resendTransactionById) | **POST** /transactions/{transaction_id}/resend | Resend transaction
+[**signAndBroadcastTransactionById**](TransactionsApi.md#signAndBroadcastTransactionById) | **POST** /transactions/{transaction_id}/sign_and_broadcast | Sign and broadcast transaction
 [**speedupTransactionById**](TransactionsApi.md#speedupTransactionById) | **POST** /transactions/{transaction_id}/speedup | Speed up transaction
 
 
@@ -64,7 +65,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[CoboAuth](../README.md#CoboAuth)
+[OAuth2](../README.md#OAuth2)
 
 ### HTTP request headers
 
@@ -114,7 +115,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[CoboAuth](../README.md#CoboAuth)
+[OAuth2](../README.md#OAuth2)
 
 ### HTTP request headers
 
@@ -168,7 +169,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[CoboAuth](../README.md#CoboAuth)
+[OAuth2](../README.md#OAuth2)
 
 ### HTTP request headers
 
@@ -220,7 +221,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
+[OAuth2](../README.md#OAuth2)
 
 ### HTTP request headers
 
@@ -272,7 +273,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
+[OAuth2](../README.md#OAuth2)
 
 ### HTTP request headers
 
@@ -286,7 +287,7 @@ Name | Type | Description  | Notes
 
 Transfer token
 
-The operation transfers your assets from a wallet created on Cobo Portal to another address.  You need to specify details such as the sender address and recipient address, token ID, and the amount to transfer. You can specify the fee-related properties to limit the transaction fee. A transaction request for tracking is returned upon successful operation.  <Note>If you make transfers from Custodial Wallets, do not set the fee-related properties. Otherwise, the transaction will fail.</Note>  <Note>You can transfer tokens to multiple addresses only if you use MPC Wallets as the transaction source. You should use the <code>utxo_outputs</code> property to specify the destination addresses.</Note>  <Info>If you initiate a transaction from a Smart Contract Wallet, a relevant transaction will be triggered from the Delegate to the Cobo Safe's address of the Smart Contract Wallet, with a transfer amount of <code>0</code>.</Info> 
+The operation transfers your assets from a wallet created on Cobo Portal to another address.  You need to specify details such as the sender address and recipient address, token ID, and the amount to transfer. You can specify the fee-related properties to limit the transaction fee. A transaction request for tracking is returned upon successful operation.  <Note>If you make transfers from Custodial Wallets (Asset Wallets) and Exchange Wallets, do not set the fee-related properties, as they will not take effects.</Note>  <Note>You can transfer tokens to multiple addresses only if you use MPC Wallets as the transaction source. You should use the <code>utxo_outputs</code> property to specify the destination addresses.</Note>  <Info>If you initiate a transaction from a Smart Contract Wallet, a relevant transaction will be triggered from the Delegate to the Cobo Safe's address of the Smart Contract Wallet, with a transfer amount of <code>0</code>.</Info> 
 
 ### Example
 
@@ -324,7 +325,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
+[OAuth2](../README.md#OAuth2)
 
 ### HTTP request headers
 
@@ -378,7 +379,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[CoboAuth](../README.md#CoboAuth)
+[OAuth2](../README.md#OAuth2)
 
 ### HTTP request headers
 
@@ -430,7 +431,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[CoboAuth](../README.md#CoboAuth)
+[OAuth2](../README.md#OAuth2)
 
 ### HTTP request headers
 
@@ -442,7 +443,7 @@ Name | Type | Description  | Notes
 
 > TransactionApprovalDetail getTransactionApprovalDetail(transaction_id)
 
-Get transaction approval information
+Get transaction approval details
 
 This operation retrieves approval detailed information about a specified transaction. 
 
@@ -530,7 +531,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[CoboAuth](../README.md#CoboAuth)
+[OAuth2](../README.md#OAuth2)
 
 ### HTTP request headers
 
@@ -614,7 +615,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[CoboAuth](../README.md#CoboAuth)
+[OAuth2](../README.md#OAuth2)
 
 ### HTTP request headers
 
@@ -668,7 +669,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[CoboAuth](../README.md#CoboAuth)
+[OAuth2](../README.md#OAuth2)
 
 ### HTTP request headers
 
@@ -676,6 +677,56 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## signAndBroadcastTransactionById
+
+> CreateTransferTransaction201Response signAndBroadcastTransactionById(transaction_id)
+
+Sign and broadcast transaction
+
+This operation signs and broadcasts a specified transaction.  To call this operation, the following conditions must be met: - The `transaction_process_type` of the transaction must be set to `BuildOnly` when you call the [Transfer token](https://www.cobo.com/developers/v2/api-references/transactions/transfer-token) or [Call smart contract](https://www.cobo.com/developers/v2/api-references/transactions/call-smart-contract) operation.   - The transaction status must be `Built`. 
+
+### Example
+
+```javascript
+const CoboWaas2 = require('@cobo/cobo-waas2');
+// Initialize the API client
+const apiClient = CoboWaas2.ApiClient.instance
+// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
+apiClient.setEnv(CoboWaas2.Env.DEV);
+// Replace `<YOUR_PRIVATE_KEY>` with your private key
+apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
+// Call the API
+const apiInstance = new CoboWaas2.TransactionsApi();
+const transaction_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479";
+apiInstance.signAndBroadcastTransactionById(transaction_id).then((data) => {
+  console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **transaction_id** | **String**| The transaction ID. | 
+
+### Return type
+
+[**CreateTransferTransaction201Response**](CreateTransferTransaction201Response.md)
+
+### Authorization
+
+[CoboAuth](../README.md#CoboAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## speedupTransactionById
 
 > CreateTransferTransaction201Response speedupTransactionById(transaction_id, opts)
@@ -722,7 +773,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[CoboAuth](../README.md#CoboAuth)
+[OAuth2](../README.md#OAuth2)
 
 ### HTTP request headers
 

package/docs/TransferDestination.md

@@ -8,6 +8,7 @@ Name | Type | Description | Notes
 **account_output** | [**AddressTransferDestinationAccountOutput**](AddressTransferDestinationAccountOutput.md) |  | [optional] 
 **utxo_outputs** | [**[AddressTransferDestinationUtxoOutputsInner]**](AddressTransferDestinationUtxoOutputsInner.md) |  | [optional] 
 **change_address** | **String** | The address used to receive the remaining funds or change from the transaction. | [optional] 
+**change_output_type** | **String** | The position of the change output in the transaction's outputs. Possible values are: - `Last`: The change output is placed at the end of the transaction's outputs.   - `First`: The change output is placed at the beginning of the transaction's outputs.  | [optional] 
 **force_internal** | **Boolean** | Whether the transaction request must be executed as a [Cobo Loop](https://manuals.cobo.com/en/portal/custodial-wallets/cobo-loop) transfer.   - `true`: The transaction request must be executed as a Cobo Loop transfer.   - `false`: The transaction request may not be executed as a Cobo Loop transfer.    Please do not set both `force_internal` and `force_external` as `true`.  | [optional] 
 **force_external** | **Boolean** | Whether the transaction request must not be executed as a [Cobo Loop](https://manuals.cobo.com/en/portal/custodial-wallets/cobo-loop) transfer.   - `true`: The transaction request must not be executed as a Cobo Loop transfer.   - `false`: The transaction request can be executed as a Cobo Loop transfer.  Please do not set both `force_internal` and `force_external` as `true`.  | [optional] 
 **wallet_id** | **String** | The wallet ID. | 
@@ -15,3 +16,16 @@ Name | Type | Description | Notes
 **amount** | **String** | The transfer amount. For example, if you trade 1.5 BTC, then the value is `1.5`.  | 
 
 
+
+## Enum: ChangeOutputTypeEnum
+
+
+* `Last` (value: `"Last"`)
+
+* `First` (value: `"First"`)
+
+* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
+
+
+
+

package/docs/TransferParams.md

@@ -11,6 +11,20 @@ Name | Type | Description | Notes
 **category_names** | **[String]** | The custom category for you to identify your transactions. | [optional] 
 **description** | **String** | The description of the transfer. | [optional] 
 **fee** | [**TransactionRequestFee**](TransactionRequestFee.md) |  | [optional] 
+**transaction_process_type** | **String** | Transaction processing type. Possible values are: - `AutoProcess` (default): After the transaction is constructed, it will be automatically signed and broadcast.   - `BuildOnly`: Set to this value if you want to build the transaction first without automatically signing and broadcasting it. You can manually call the [Sign and broadcast transaction](https://www.cobo.com/developers/v2/api-references/transactions/sign-and-broadcast-transaction) operation to complete the signing and broadcasting process.  | [optional] 
 **auto_fuel** | [**AutoFuelType**](AutoFuelType.md) |  | [optional] 
 
 
+
+## Enum: TransactionProcessTypeEnum
+
+
+* `AutoProcess` (value: `"AutoProcess"`)
+
+* `BuildOnly` (value: `"BuildOnly"`)
+
+* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
+
+
+
+

package/docs/TravelRuleApi.md

@@ -6,8 +6,8 @@ Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**getTransactionLimitation**](TravelRuleApi.md#getTransactionLimitation) | **GET** /travel_rule/transaction/limitation | Retrieve transaction limitations
 [**listSupportedCountries**](TravelRuleApi.md#listSupportedCountries) | **GET** /travel_rule/transaction/countries | List supported countries
-[**submitDepositTravelRuleInfo**](TravelRuleApi.md#submitDepositTravelRuleInfo) | **POST** /travel_rule/transaction/deposit/travel_rule_info | Submit Deposit Transaction Travel Rule information
-[**submitWithdrawTravelRuleInfo**](TravelRuleApi.md#submitWithdrawTravelRuleInfo) | **POST** /travel_rule/transaction/withdraw/travel_rule_info | Submit Withdraw Transaction Travel Rule information
+[**submitDepositTravelRuleInfo**](TravelRuleApi.md#submitDepositTravelRuleInfo) | **POST** /travel_rule/transaction/deposit/travel_rule_info | Submit Travel Rule information for deposits
+[**submitWithdrawTravelRuleInfo**](TravelRuleApi.md#submitWithdrawTravelRuleInfo) | **POST** /travel_rule/transaction/withdraw/travel_rule_info | Submit Travel Rule information for withdrawals
 
 
 
@@ -17,7 +17,7 @@ Method | HTTP request | Description
 
 Retrieve transaction limitations
 
-This endpoint retrieves transaction-related limitations based on the provided `transaction_type` and `transaction_id`.  The response includes the following information: - **`vasp_list`**: A list of Virtual Asset Service Providers (VASPs) associated with the transaction token. - **`is_threshold_reached`**: Indicates whether the transaction amount has exceeded the predefined threshold.    - If `true`: Additional Travel Rule information may be required for processing. - **`self_custody_wallet_challenge`**: A challenge string for verifying ownership of self-custody wallets. - **`connect_wallet_list`**: A list of supported wallet integrations for the transaction, such as MetaMask or WalletConnect.  Use this endpoint to ensure compliance with Travel Rule requirements and to retrieve supported options for completing the transaction. 
+This operation retrieves Travel Rule requirements and available options for a transaction based on its transaction type and ID.  Use this endpoint before submitting Travel Rule information to understand the requirements and available options for your transaction. 
 
 ### Example
 
@@ -47,7 +47,7 @@ apiInstance.getTransactionLimitation(transaction_type, transaction_id).then((dat
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **transaction_type** | **String**| The transaction type. Possible values include:    - `DEPOSIT`: A deposit transaction.   - `WITHDRAW`: A withdrawal transaction.  | 
- **transaction_id** | **String**| The transaction ID | 
+ **transaction_id** | **String**| The transaction ID. | 
 
 ### Return type
 
@@ -55,7 +55,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
+[OAuth2](../README.md#OAuth2)
 
 ### HTTP request headers
 
@@ -69,7 +69,7 @@ Name | Type | Description  | Notes
 
 List supported countries
 
-This operation retrieves all countries supported.
+This operation retrieves a list of supported countries that can be used when submitting Travel Rule information.  Use this endpoint to obtain valid country values for:   - Place of incorporation of a legal entity   - Place of birth of a natural person 
 
 ### Example
 
@@ -101,7 +101,7 @@ This endpoint does not need any parameter.
 
 ### Authorization
 
-[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
+[OAuth2](../README.md#OAuth2)
 
 ### HTTP request headers
 
@@ -113,9 +113,9 @@ This endpoint does not need any parameter.
 
 > SubmitDepositTravelRuleInfo201Response submitDepositTravelRuleInfo(opts)
 
-Submit Deposit Transaction Travel Rule information
+Submit Travel Rule information for deposits
 
-This operation allows you to submit the required Travel Rule information based on the transaction details. It supports both self-custody wallets and exchanges/VASPs, ensuring compliance with Travel Rule requirements.   - **Destination Wallet Type (`destination_wallet_type`)**:   - `SELF_CUSTODY_WALLET`: A self-custodial wallet (e.g., plugin wallet). Requires `self_custody_wallet_sign`, `self_custody_wallet_address`, and `self_custody_wallet_challenge`.   - `EXCHANGES_OR_VASP`: A wallet associated with an exchange or VASP. Requires `vendor_vasp_id` and information depending on `selected_entity_type`.  - **Entity Types (`selected_entity_type`)**:   - `LEGAL`: For legal entities, provide `legal_name`, `date_of_incorporation`, and `place_of_incorporation`.   - `NATURAL`: For natural persons, provide `date_of_birth`, `place_of_birth`, `first_name`, and `last_name`. 
+This operation submits Travel Rule information for a deposit transaction. 
 
 ### Example
 
@@ -153,7 +153,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
+[OAuth2](../README.md#OAuth2)
 
 ### HTTP request headers
 
@@ -165,9 +165,9 @@ Name | Type | Description  | Notes
 
 > SubmitDepositTravelRuleInfo201Response submitWithdrawTravelRuleInfo(opts)
 
-Submit Withdraw Transaction Travel Rule information
+Submit Travel Rule information for withdrawals
 
-This operation allows you to submit the required Travel Rule information based on the transaction details. It supports both self-custody wallets and exchanges/VASPs, ensuring compliance with Travel Rule requirements.   - **Destination Wallet Type (`destination_wallet_type`)**:   - `SELF_CUSTODY_WALLET`: A self-custodial wallet (e.g., plugin wallet). Requires `self_custody_wallet_sign`, `self_custody_wallet_address`, and `self_custody_wallet_challenge`.   - `EXCHANGES_OR_VASP`: A wallet associated with an exchange or VASP. Requires `vendor_vasp_id` and information depending on `selected_entity_type`.  - **Entity Types (`selected_entity_type`)**:   - `LEGAL`: For legal entities, provide `legal_name`.   - `NATURAL`: For natural persons, provide `date_of_birth`, `place_of_birth`, `first_name`, and `last_name`. 
+This operation submits Travel Rule information for a withdrawal transaction. 
 
 ### Example
 
@@ -205,7 +205,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
+[OAuth2](../README.md#OAuth2)
 
 ### HTTP request headers
 

package/docs/TravelRuleDepositExchangesOrVASP.md

@@ -5,9 +5,9 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **destination_wallet_type** | [**DestinationWalletType**](DestinationWalletType.md) |  | 
-**vendor_code** | **String** | The vendor code for exchanges or VASPs. | 
+**vendor_code** | **String** | The vendor code of the VASP. | 
 **vendor_vasp_id** | **String** | The unique identifier of the VASP. | 
-**vendor_vasp_name** | **String** | The vendor name to be provided when selecting \"Others\" as the VASP case. This field allows customers to specify the name of a vendor not listed. | [optional] 
+**vendor_vasp_name** | **String** | The vendor name. Use this field to specify the name of a vendor not listed. | [optional] 
 **entity_info** | [**TravelRuleDepositExchangesOrVASPEntityInfo**](TravelRuleDepositExchangesOrVASPEntityInfo.md) |  | 
 
 

package/docs/TravelRuleDepositExchangesOrVASPEntityInfo.md

@@ -4,14 +4,14 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**selected_entity_type** | **String** | Specifies the type of entity associated with the transaction. | 
+**selected_entity_type** | **String** | Specifies the type of entity associated with the transaction. - `LEGAL`: Legal entity. - `NATURAL`: Natural person.  | 
 **legal_name** | **String** | The legal name of the entity. | 
-**date_of_incorporation** | **Date** | The incorporation date of the entity. This field is required when: - **Calling**: `travel_rule/transaction/limitation` API returns `is_threshold_reached = true`. - **Entity Type**: LEGAL. Otherwise, this field can be omitted.  | [optional] 
-**place_of_incorporation** | **String** | The place of incorporation of the entity. This field is required when: - **Calling**: `travel_rule/transaction/limitation` API returns `is_threshold_reached = true`. - **Entity Type**: LEGAL. Otherwise, this field can be omitted.  | [optional] 
-**first_name** | **String** | The first name of the user. | 
-**last_name** | **String** | The last name of the user. | 
-**date_of_birth** | **Date** | The date of birth of the user. This field is required when: - **Calling**: `travel_rule/transaction/limitation` API returns `is_threshold_reached = true`. - **Entity Type**: NATURAL. Otherwise, this field can be omitted.  | [optional] 
-**place_of_birth** | **String** | The place of birth of the user. This field is required when: - **Calling**: `travel_rule/transaction/limitation` API returns `is_threshold_reached = true`. - **Entity Type**: NATURAL. Otherwise, this field can be omitted.  | [optional] 
+**date_of_incorporation** | **Date** | The date of incorporation of the entity. This field is required when either of the following conditions is met: - `is_threshold_reached` is `true` in the response of the [Retrieve transaction limitations](https://www.cobo.com/developers/v2/api-references/travelrule/retrieve-transaction-limitations) operation. - `selected_entity_type` is `LEGAL`.  | [optional] 
+**place_of_incorporation** | **String** | The place of incorporation of the entity. This field is required when either of the following conditions is met: - `is_threshold_reached` is `true` in the response of the [Retrieve transaction limitations](https://www.cobo.com/developers/v2/api-references/travelrule/retrieve-transaction-limitations) operation. - `selected_entity_type` is `LEGAL`.  | [optional] 
+**first_name** | **String** | The first name of the natural person. | 
+**last_name** | **String** | The last name of the natural person. | 
+**date_of_birth** | **Date** | The date of birth of the natural person. This field is required when either of the following conditions is met: - `is_threshold_reached` is `true` in the response of the [Retrieve transaction limitations](https://www.cobo.com/developers/v2/api-references/travelrule/retrieve-transaction-limitations) operation. - `selected_entity_type` is `NATURAL`.  | [optional] 
+**place_of_birth** | **String** | The place of birth of the natural person. This field is required when either of the following conditions is met: - `is_threshold_reached` is `true` in the response of the [Retrieve transaction limitations](https://www.cobo.com/developers/v2/api-references/travelrule/retrieve-transaction-limitations) operation. - `selected_entity_type` is `NATURAL`.  | [optional] 
 
 
 

package/docs/TravelRuleDepositLegalEntity.md

@@ -4,10 +4,10 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**selected_entity_type** | **String** | Specifies the type of entity associated with the transaction. | 
+**selected_entity_type** | **String** | The entity type. Possible values include: - `LEGAL`: Legal entity. - `NATURAL`: Natural person.  | 
 **legal_name** | **String** | The legal name of the entity. | 
-**date_of_incorporation** | **Date** | The incorporation date of the entity. This field is required when: - **Calling**: `travel_rule/transaction/limitation` API returns `is_threshold_reached = true`. - **Entity Type**: LEGAL. Otherwise, this field can be omitted.  | [optional] 
-**place_of_incorporation** | **String** | The place of incorporation of the entity. This field is required when: - **Calling**: `travel_rule/transaction/limitation` API returns `is_threshold_reached = true`. - **Entity Type**: LEGAL. Otherwise, this field can be omitted.  | [optional] 
+**date_of_incorporation** | **Date** | The date of incorporation of the entity. This field is required when either of the following conditions is met: - `is_threshold_reached` is `true` in the response of the [Retrieve transaction limitations](https://www.cobo.com/developers/v2/api-references/travelrule/retrieve-transaction-limitations) operation. - `selected_entity_type` is `LEGAL`.  | [optional] 
+**place_of_incorporation** | **String** | The place of incorporation of the entity. This field is required when either of the following conditions is met: - `is_threshold_reached` is `true` in the response of the [Retrieve transaction limitations](https://www.cobo.com/developers/v2/api-references/travelrule/retrieve-transaction-limitations) operation. - `selected_entity_type` is `LEGAL`.  | [optional] 
 
 
 

package/docs/TravelRuleDepositNaturalEntity.md

@@ -4,11 +4,11 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**selected_entity_type** | **String** | Specifies the type of entity associated with the transaction. | 
-**first_name** | **String** | The first name of the user. | 
-**last_name** | **String** | The last name of the user. | 
-**date_of_birth** | **Date** | The date of birth of the user. This field is required when: - **Calling**: `travel_rule/transaction/limitation` API returns `is_threshold_reached = true`. - **Entity Type**: NATURAL. Otherwise, this field can be omitted.  | [optional] 
-**place_of_birth** | **String** | The place of birth of the user. This field is required when: - **Calling**: `travel_rule/transaction/limitation` API returns `is_threshold_reached = true`. - **Entity Type**: NATURAL. Otherwise, this field can be omitted.  | [optional] 
+**selected_entity_type** | **String** | Specifies the type of entity associated with the transaction. - `LEGAL`: Legal entity. - `NATURAL`: Natural person.  | 
+**first_name** | **String** | The first name of the natural person. | 
+**last_name** | **String** | The last name of the natural person. | 
+**date_of_birth** | **Date** | The date of birth of the natural person. This field is required when either of the following conditions is met: - `is_threshold_reached` is `true` in the response of the [Retrieve transaction limitations](https://www.cobo.com/developers/v2/api-references/travelrule/retrieve-transaction-limitations) operation. - `selected_entity_type` is `NATURAL`.  | [optional] 
+**place_of_birth** | **String** | The place of birth of the natural person. This field is required when either of the following conditions is met: - `is_threshold_reached` is `true` in the response of the [Retrieve transaction limitations](https://www.cobo.com/developers/v2/api-references/travelrule/retrieve-transaction-limitations) operation. - `selected_entity_type` is `NATURAL`.  | [optional] 
 
 
 

package/docs/TravelRuleDepositRequestTravelRuleInfo.md

@@ -5,12 +5,12 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **destination_wallet_type** | [**DestinationWalletType**](DestinationWalletType.md) |  | 
-**vendor_code** | **String** | The vendor code for exchanges or VASPs. | 
+**vendor_code** | **String** | The vendor code of the VASP. | 
 **vendor_vasp_id** | **String** | The unique identifier of the VASP. | 
-**vendor_vasp_name** | **String** | The vendor name to be provided when selecting \"Others\" as the VASP case. This field allows customers to specify the name of a vendor not listed. | [optional] 
+**vendor_vasp_name** | **String** | The vendor name. Use this field to specify the name of a vendor not listed. | [optional] 
 **entity_info** | [**TravelRuleDepositExchangesOrVASPEntityInfo**](TravelRuleDepositExchangesOrVASPEntityInfo.md) |  | 
-**self_custody_wallet_challenge** | **String** | The challenge obtained from a previous operation. | 
-**self_custody_wallet_address** | **String** | The address of the self-custodial wallet. | 
-**self_custody_wallet_sign** | **String** | The signed message from the self-custodial wallet. | 
+**self_custody_wallet_challenge** | **String** | The message obtained from the `Retrieve transaction limitations` operation. This message is used to verify wallet ownership through signing. | 
+**self_custody_wallet_address** | **String** | The address of the self-custody wallet. | 
+**self_custody_wallet_sign** | **String** | The signature created by signing the challenge message with the wallet's private key. | 
 
 

package/docs/TravelRuleWithdrawExchangesOrVASP.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **destination_wallet_type** | [**DestinationWalletType**](DestinationWalletType.md) |  | 
-**vendor_code** | **String** | The vendor code for exchanges or VASPs. | 
+**vendor_code** | **String** | The vendor code of the exchange or virtual asset service provider (VASP). | 
 **vendor_vasp_id** | **String** | The unique identifier of the VASP. | 
 **entity_info** | [**TravelRuleWithdrawExchangesOrVASPEntityInfo**](TravelRuleWithdrawExchangesOrVASPEntityInfo.md) |  | 
 

package/docs/TravelRuleWithdrawExchangesOrVASPEntityInfo.md

@@ -6,11 +6,11 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **selected_entity_type** | [**SelectedEntityType**](SelectedEntityType.md) |  | 
 **legal_name** | **String** | The legal name of the entity. | 
-**date_of_incorporation** | **Date** | The incorporation date of the entity. | [optional] 
+**date_of_incorporation** | **Date** | The date of incorporation of the entity. | [optional] 
 **place_of_incorporation** | **String** | The place of incorporation of the entity. | [optional] 
-**first_name** | **String** | The first name of the user. | 
-**last_name** | **String** | The last name of the user. | 
-**date_of_birth** | **Date** | The date of birth of the user. | [optional] 
-**place_of_birth** | **String** | The place of birth of the user. | [optional] 
+**first_name** | **String** | The first name of the natural person. | 
+**last_name** | **String** | The last name of the natural person. | 
+**date_of_birth** | **Date** | The date of birth of the natural person. | [optional] 
+**place_of_birth** | **String** | The place of birth of the natural person. | [optional] 
 
 

package/docs/TravelRuleWithdrawLegalEntity.md

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **selected_entity_type** | [**SelectedEntityType**](SelectedEntityType.md) |  | 
 **legal_name** | **String** | The legal name of the entity. | 
-**date_of_incorporation** | **Date** | The incorporation date of the entity. | [optional] 
+**date_of_incorporation** | **Date** | The date of incorporation of the entity. | [optional] 
 **place_of_incorporation** | **String** | The place of incorporation of the entity. | [optional] 
 
 

package/docs/TravelRuleWithdrawNaturalEntity.md

@@ -5,9 +5,9 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **selected_entity_type** | [**SelectedEntityType**](SelectedEntityType.md) |  | 
-**first_name** | **String** | The first name of the user. | 
-**last_name** | **String** | The last name of the user. | 
-**date_of_birth** | **Date** | The date of birth of the user. | [optional] 
-**place_of_birth** | **String** | The place of birth of the user. | [optional] 
+**first_name** | **String** | The first name of the natural person. | 
+**last_name** | **String** | The last name of the natural person. | 
+**date_of_birth** | **Date** | The date of birth of the natural person. | [optional] 
+**place_of_birth** | **String** | The place of birth of the natural person. | [optional] 
 
 

package/docs/TravelRuleWithdrawRequestTravelRuleInfo.md

@@ -5,10 +5,10 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **destination_wallet_type** | [**DestinationWalletType**](DestinationWalletType.md) |  | 
-**self_custody_wallet_challenge** | **String** | The challenge obtained from a previous operation. | 
-**self_custody_wallet_address** | **String** | The address of the self-custodial wallet. | 
-**self_custody_wallet_sign** | **String** | The signed message from the self-custodial wallet. | 
-**vendor_code** | **String** | The vendor code for exchanges or VASPs. | 
+**self_custody_wallet_challenge** | **String** | The message obtained from the `Retrieve transaction limitations` operation. This message is used to verify wallet ownership through signing. | 
+**self_custody_wallet_address** | **String** | The address of the self-custody wallet. | 
+**self_custody_wallet_sign** | **String** | The signature created by signing the challenge message with the wallet's private key. | 
+**vendor_code** | **String** | The vendor code of the exchange or virtual asset service provider (VASP). | 
 **vendor_vasp_id** | **String** | The unique identifier of the VASP. | 
 **entity_info** | [**TravelRuleWithdrawExchangesOrVASPEntityInfo**](TravelRuleWithdrawExchangesOrVASPEntityInfo.md) |  | 
 

package/docs/Vasp.md

@@ -4,8 +4,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**name** | **String** | The name of the vasp. | 
-**vendor_code** | **String** | The symbol. | 
-**vendor_vasp_id** | **String** | The vasp str id. | 
+**name** | **String** | The VASP name. | 
+**vendor_code** | **String** | The vendor code of the VASP. | 
+**vendor_vasp_id** | **String** | The VASP ID. |