# CoboWaas2.TravelRuleApi All URIs are relative to *https://api.dev.cobo.com/v2* Method | HTTP request | Description ------------- | ------------- | ------------- [**cancelSatoshiTestChallenge**](TravelRuleApi.md#cancelSatoshiTestChallenge) | **POST** /travel_rule/satoshi_test/challenge/cancel | Cancel Satoshi Test challenge [**createSatoshiTestChallenge**](TravelRuleApi.md#createSatoshiTestChallenge) | **POST** /travel_rule/satoshi_test/challenge | Create Satoshi Test challenge [**getAddressVerification**](TravelRuleApi.md#getAddressVerification) | **GET** /travel_rule/address_verifications/{verification_id} | Get address verification [**getSatoshiTestChallenge**](TravelRuleApi.md#getSatoshiTestChallenge) | **GET** /travel_rule/satoshi_test/challenge/status | Get Satoshi Test challenge [**getSignatureChallenge**](TravelRuleApi.md#getSignatureChallenge) | **GET** /travel_rule/signature_challenge | Get self-custody signature challenge [**getTransactionLimitation**](TravelRuleApi.md#getTransactionLimitation) | **GET** /travel_rule/transaction/limitation | Retrieve transaction limitations [**listAddressVerifications**](TravelRuleApi.md#listAddressVerifications) | **GET** /travel_rule/address_verifications | List address verifications [**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 Travel Rule information for deposits [**submitWithdrawTravelRuleInfo**](TravelRuleApi.md#submitWithdrawTravelRuleInfo) | **POST** /travel_rule/transaction/withdraw/travel_rule_info | Submit Travel Rule information for withdrawals ## cancelSatoshiTestChallenge > SatoshiTestCancelResult cancelSatoshiTestChallenge(opts) Cancel Satoshi Test challenge This operation cancels a Satoshi Test challenge that is currently in `PREPARE` or `PENDING` status. Typical use case: the counterparty decides to switch verification methods before transferring. Once cancelled, the challenge status becomes `DELETED` and the on-chain match will no longer be observed. Challenges already in `MATCHED`, `VERIFIED`, `EXPIRED`, or `DELETED` state cannot be cancelled. ### 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 `` with your private key apiClient.setPrivateKey(""); // Call the API const apiInstance = new CoboWaas2.TravelRuleApi(); const opts = { 'CancelSatoshiTestChallengeRequest': new CoboWaas2.CancelSatoshiTestChallengeRequest() }; apiInstance.cancelSatoshiTestChallenge(opts).then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { console.error(error); }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **CancelSatoshiTestChallengeRequest** | [**CancelSatoshiTestChallengeRequest**](CancelSatoshiTestChallengeRequest.md)| | [optional] ### Return type [**SatoshiTestCancelResult**](SatoshiTestCancelResult.md) ### Authorization [OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## createSatoshiTestChallenge > SatoshiTestChallenge createSatoshiTestChallenge(opts) Create Satoshi Test challenge This operation creates a Satoshi Test challenge for self-custody address verification. Satoshi Test verifies address ownership by having the counterparty transfer a small, uniquely-generated amount from their wallet to a Cobo-controlled verification address. A single endpoint covers both flows via the `action` parameter: - **Two-step flow** (`action=PREPARE` then `action=SUBMIT`): Preview the verification details first, then activate. The 180-minute countdown only starts on `SUBMIT`. The server uses `(chain_id, from_address)` as the idempotency key, so the second call automatically targets the prepared challenge. For extra safety, pass the `challenge_id` returned by `PREPARE` in the subsequent `SUBMIT` call — it pins the activation to that specific challenge. - **One-shot flow** (`action=SUBMIT` directly, without `challenge_id`): Prepare and submit in a single call. The challenge is created directly in `PENDING` state with the countdown started. If the counterparty address has already been verified, the operation returns HTTP 400 `ADDRESS_ALREADY_VERIFIED`. Call [List address verifications](#operation/list_address_verifications) with `chain_id`, `address`, and `status=VERIFIED` first to pre-check. Supported chains: `BTC`, `ETH`, `BASE_ETH`, `BSC_BNB`, `TRON`. ### 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 `` with your private key apiClient.setPrivateKey(""); // Call the API const apiInstance = new CoboWaas2.TravelRuleApi(); const opts = { 'CreateSatoshiTestChallengeRequest': new CoboWaas2.CreateSatoshiTestChallengeRequest() }; apiInstance.createSatoshiTestChallenge(opts).then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { console.error(error); }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **CreateSatoshiTestChallengeRequest** | [**CreateSatoshiTestChallengeRequest**](CreateSatoshiTestChallengeRequest.md)| | [optional] ### Return type [**SatoshiTestChallenge**](SatoshiTestChallenge.md) ### Authorization [OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## getAddressVerification > AddressVerificationDetail getAddressVerification(verification_id) Get address verification Retrieve a single self-custody address verification record by its `verification_id`, including method-specific provenance: - `verification_method=SIGNATURE` → `signature_detail` is populated. - `verification_method=SATOSHI_TEST` → `satoshi_test_detail` carries the latest challenge state (`status`, `remaining_seconds`, `matched_txid`). Use [List address verifications](#operation/list_address_verifications) to discover `verification_id` values. ### 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 `` with your private key apiClient.setPrivateKey(""); // Call the API const apiInstance = new CoboWaas2.TravelRuleApi(); const verification_id = "fb377ea5-a97a-49b4-955d-23f8fdd5177a"; apiInstance.getAddressVerification(verification_id).then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { console.error(error); }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **verification_id** | **String**| The unique identifier of the address verification record. | ### Return type [**AddressVerificationDetail**](AddressVerificationDetail.md) ### Authorization [OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## getSatoshiTestChallenge > SatoshiTestChallenge getSatoshiTestChallenge(challenge_id) Get Satoshi Test challenge This operation returns the current state of a Satoshi Test challenge — useful for polling after submission. The response contains the challenge `status` and `remaining_seconds`. Recommended polling interval: 10–30 seconds. The challenge will transition through `PENDING` → `MATCHED` → `VERIFIED` once the counterparty's transfer is observed and confirmed on chain. If the challenge is not matched within 180 minutes, the status becomes `EXPIRED`. ### 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 `` with your private key apiClient.setPrivateKey(""); // Call the API const apiInstance = new CoboWaas2.TravelRuleApi(); const challenge_id = "a1b2c3d4-e5f6-7890-abcd-ef1234567890"; apiInstance.getSatoshiTestChallenge(challenge_id).then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { console.error(error); }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **challenge_id** | **String**| The Satoshi Test challenge ID returned by the `prepare` or `submit` operation. | ### Return type [**SatoshiTestChallenge**](SatoshiTestChallenge.md) ### Authorization [OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## getSignatureChallenge > SignatureChallenge getSignatureChallenge(transaction_type, transaction_id) Get self-custody signature challenge This operation issues a one-time, time-bounded message for a self-custody wallet address to sign, in order to prove wallet ownership. The signature is then submitted via [Submit Travel Rule information for deposits](#operation/submit_deposit_travel_rule_info) or [withdrawals](#operation/submit_withdraw_travel_rule_info). Use this endpoint when you want to verify the counterparty's self-custody address via off-chain signature. For address verification via on-chain micro-deposit, use the Satoshi Test endpoints (`/travel_rule/satoshi_test/...`) instead. The challenge is valid for a short window (returned as `expires_in`, currently 30 seconds). Calling this endpoint again for the same transaction rotates the challenge — only the latest issued value will verify. ### 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 `` with your private key apiClient.setPrivateKey(""); // Call the API const apiInstance = new CoboWaas2.TravelRuleApi(); const transaction_type = "DEPOSIT"; const transaction_id = "123e4567-e89b-12d3-a456-426614174000"; apiInstance.getSignatureChallenge(transaction_type, transaction_id).then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { console.error(error); }); ``` ### Parameters 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. | ### Return type [**SignatureChallenge**](SignatureChallenge.md) ### Authorization [OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## getTransactionLimitation > GetTransactionLimitation200Response getTransactionLimitation(transaction_type, transaction_id) Retrieve transaction limitations <Note>The `self_custody_wallet_challenge` field in the response is deprecated. To obtain a signature challenge, call [Get self-custody signature challenge](#operation/get_signature_challenge) instead. This operation itself is not deprecated and continues to return the VASP list, threshold info, connect wallet list, and Satoshi Test support.</Note> 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 ```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 `` with your private key apiClient.setPrivateKey(""); // Call the API const apiInstance = new CoboWaas2.TravelRuleApi(); const transaction_type = "DEPOSIT"; const transaction_id = "123e4567-e89b-12d3-a456-426614174000"; apiInstance.getTransactionLimitation(transaction_type, transaction_id).then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { console.error(error); }); ``` ### Parameters 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. | ### Return type [**GetTransactionLimitation200Response**](GetTransactionLimitation200Response.md) ### Authorization [OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## listAddressVerifications > ListAddressVerifications200Response listAddressVerifications(opts) List address verifications List self-custody address verification records under the current organization with optional filters and cursor-based pagination. Records are sorted by creation time descending (most recent first). Use `limit` plus `before` / `after` cursors from the previous page's `pagination` block to traverse pages. Each record's `status` is one of `PENDING`, `VERIFIED`, or `FAILED`. ### 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 `` with your private key apiClient.setPrivateKey(""); // Call the API const apiInstance = new CoboWaas2.TravelRuleApi(); const opts = { 'status': new CoboWaas2.AddressVerificationStatus(), 'chain_id': "ETH", 'address': "0x1234567890abcdef1234567890abcdef12345678", 'limit': 10, 'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1", 'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk" }; apiInstance.listAddressVerifications(opts).then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { console.error(error); }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **status** | [**AddressVerificationStatus**](.md)| Filter by verification status. Allowed values: - `PENDING`: A Satoshi Test challenge is in progress (countdown active or awaiting confirmation). - `VERIFIED`: The address ownership has been confirmed (by signature or by a matched Satoshi Test transfer). - `FAILED`: The verification attempt did not succeed (Satoshi Test expired without match, or signature verification rejected). Omit this parameter to return records of all three statuses. | [optional] **chain_id** | **String**| Filter by chain ID (e.g. `BTC`, `ETH`, `BASE_ETH`, `BSC_BNB`, `TRON`). | [optional] **address** | **String**| Filter by counterparty (self-custody) wallet address. | [optional] **limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10] **before** | **String**| A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. | [optional] **after** | **String**| A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response. | [optional] ### Return type [**ListAddressVerifications200Response**](ListAddressVerifications200Response.md) ### Authorization [OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## listSupportedCountries > [ListSupportedCountries200ResponseInner] listSupportedCountries() List supported countries 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 ```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 `` with your private key apiClient.setPrivateKey(""); // Call the API const apiInstance = new CoboWaas2.TravelRuleApi(); apiInstance.listSupportedCountries().then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { console.error(error); }); ``` ### Parameters This endpoint does not need any parameter. ### Return type [**[ListSupportedCountries200ResponseInner]**](ListSupportedCountries200ResponseInner.md) ### Authorization [OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## submitDepositTravelRuleInfo > SubmitDepositTravelRuleInfo201Response submitDepositTravelRuleInfo(opts) Submit Travel Rule information for deposits This operation submits Travel Rule information for a deposit transaction. ### 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 `` with your private key apiClient.setPrivateKey(""); // Call the API const apiInstance = new CoboWaas2.TravelRuleApi(); const opts = { 'TravelRuleDepositRequest': new CoboWaas2.TravelRuleDepositRequest() }; apiInstance.submitDepositTravelRuleInfo(opts).then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { console.error(error); }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **TravelRuleDepositRequest** | [**TravelRuleDepositRequest**](TravelRuleDepositRequest.md)| | [optional] ### Return type [**SubmitDepositTravelRuleInfo201Response**](SubmitDepositTravelRuleInfo201Response.md) ### Authorization [OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## submitWithdrawTravelRuleInfo > SubmitDepositTravelRuleInfo201Response submitWithdrawTravelRuleInfo(opts) Submit Travel Rule information for withdrawals This operation submits Travel Rule information for a withdrawal transaction. ### 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 `` with your private key apiClient.setPrivateKey(""); // Call the API const apiInstance = new CoboWaas2.TravelRuleApi(); const opts = { 'TravelRuleWithdrawRequest': new CoboWaas2.TravelRuleWithdrawRequest() }; apiInstance.submitWithdrawTravelRuleInfo(opts).then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { console.error(error); }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **TravelRuleWithdrawRequest** | [**TravelRuleWithdrawRequest**](TravelRuleWithdrawRequest.md)| | [optional] ### Return type [**SubmitDepositTravelRuleInfo201Response**](SubmitDepositTravelRuleInfo201Response.md) ### Authorization [OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json