TravelRuleApi

All URIs are relative to https://developers.fireblocks.com/reference/

Method	HTTP request	Description
createTrustProofOfAddress	POST /screening/travel_rule/providers/trust/proof_of_address	Create Trust Network Proof of Address
getTrustProofOfAddress	GET /screening/travel_rule/providers/trust/proof_of_address/{transactionId}	Retrieve Trust Network Proof of Address Signature
getVASPByDID	GET /screening/travel_rule/vasp/{did}	Get VASP details
getVASPs	GET /screening/travel_rule/vasp	Get All VASPs
getVaspForVault	GET /screening/travel_rule/vault/{vaultAccountId}/vasp	Get assigned VASP to vault
setVaspForVault	POST /screening/travel_rule/vault/{vaultAccountId}/vasp	Assign VASP to vault
updateVasp	PUT /screening/travel_rule/vasp/update	Add jsonDidKey to VASP details
validateFullTravelRuleTransaction	POST /screening/travel_rule/transaction/validate/full	Validate Full Travel Rule Transaction

createTrustProofOfAddress

CompletableFuture<ApiResponse> createTrustProofOfAddress createTrustProofOfAddress(trustProofOfAddressRequest, idempotencyKey)

Create Trust Network Proof of Address

Creates a cryptographic proof of address ownership for TRUST network.

Example

// Import classes:
import com.fireblocks.sdk.ApiClient;
import com.fireblocks.sdk.ApiException;
import com.fireblocks.sdk.ApiResponse;
import com.fireblocks.sdk.BasePath;
import com.fireblocks.sdk.Fireblocks;
import com.fireblocks.sdk.ConfigurationOptions;
import com.fireblocks.sdk.model.*;
import com.fireblocks.sdk.api.TravelRuleApi;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;

public class Example {
    public static void main(String[] args) {
        ConfigurationOptions configurationOptions = new ConfigurationOptions()
            .basePath(BasePath.Sandbox)
            .apiKey("my-api-key")
            .secretKey("my-secret-key");
        Fireblocks fireblocks = new Fireblocks(configurationOptions);

        TrustProofOfAddressRequest trustProofOfAddressRequest = new TrustProofOfAddressRequest(); // TrustProofOfAddressRequest | 
        String idempotencyKey = "idempotencyKey_example"; // String | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.
        try {
            CompletableFuture<ApiResponse<TrustProofOfAddressCreateResponse>> response = fireblocks.travelRule().createTrustProofOfAddress(trustProofOfAddressRequest, idempotencyKey);
            System.out.println("Status code: " + response.get().getStatusCode());
            System.out.println("Response headers: " + response.get().getHeaders());
            System.out.println("Response body: " + response.get().getData());
        } catch (InterruptedException | ExecutionException e) {
            ApiException apiException = (ApiException)e.getCause();
            System.err.println("Exception when calling TravelRuleApi#createTrustProofOfAddress");
            System.err.println("Status code: " + apiException.getCode());
            System.err.println("Response headers: " + apiException.getResponseHeaders());
            System.err.println("Reason: " + apiException.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
trustProofOfAddressRequest	TrustProofOfAddressRequest
idempotencyKey	String	A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.	[optional]

Return type

CompletableFuture<ApiResponse<TrustProofOfAddressCreateResponse>>

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Proof of address transaction created successfully	* X-Request-ID -
0	Error Response	* X-Request-ID -

getTrustProofOfAddress

CompletableFuture<ApiResponse> getTrustProofOfAddress getTrustProofOfAddress(transactionId)

Retrieve Trust Network Proof of Address Signature

Retrieves the TRUST-compatible encoded signature for a proof of address transaction. Send this signature directly to TRUST for verification.

Example

// Import classes:
import com.fireblocks.sdk.ApiClient;
import com.fireblocks.sdk.ApiException;
import com.fireblocks.sdk.ApiResponse;
import com.fireblocks.sdk.BasePath;
import com.fireblocks.sdk.Fireblocks;
import com.fireblocks.sdk.ConfigurationOptions;
import com.fireblocks.sdk.model.*;
import com.fireblocks.sdk.api.TravelRuleApi;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;

public class Example {
    public static void main(String[] args) {
        ConfigurationOptions configurationOptions = new ConfigurationOptions()
            .basePath(BasePath.Sandbox)
            .apiKey("my-api-key")
            .secretKey("my-secret-key");
        Fireblocks fireblocks = new Fireblocks(configurationOptions);

        UUID transactionId = UUID.fromString("550e8400-e29b-41d4-a716-446655440000"); // UUID | Fireblocks transaction ID (UUID format)
        try {
            CompletableFuture<ApiResponse<TrustProofOfAddressResponse>> response = fireblocks.travelRule().getTrustProofOfAddress(transactionId);
            System.out.println("Status code: " + response.get().getStatusCode());
            System.out.println("Response headers: " + response.get().getHeaders());
            System.out.println("Response body: " + response.get().getData());
        } catch (InterruptedException | ExecutionException e) {
            ApiException apiException = (ApiException)e.getCause();
            System.err.println("Exception when calling TravelRuleApi#getTrustProofOfAddress");
            System.err.println("Status code: " + apiException.getCode());
            System.err.println("Response headers: " + apiException.getResponseHeaders());
            System.err.println("Reason: " + apiException.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
transactionId	UUID	Fireblocks transaction ID (UUID format)

Return type

CompletableFuture<ApiResponse<TrustProofOfAddressResponse>>

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Encoded signature retrieved successfully	* X-Request-ID -
0	Error Response	* X-Request-ID -

getVASPByDID

CompletableFuture<ApiResponse> getVASPByDID getVASPByDID(did, fields)

Get VASP details

Get VASP Details. Returns information about a VASP that has the specified DID. The response may contain fields that are not documented in the schema below. Clients must ignore unrecognised fields rather than failing to deserialize.

Example

// Import classes:
import com.fireblocks.sdk.ApiClient;
import com.fireblocks.sdk.ApiException;
import com.fireblocks.sdk.ApiResponse;
import com.fireblocks.sdk.BasePath;
import com.fireblocks.sdk.Fireblocks;
import com.fireblocks.sdk.ConfigurationOptions;
import com.fireblocks.sdk.model.*;
import com.fireblocks.sdk.api.TravelRuleApi;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;

public class Example {
    public static void main(String[] args) {
        ConfigurationOptions configurationOptions = new ConfigurationOptions()
            .basePath(BasePath.Sandbox)
            .apiKey("my-api-key")
            .secretKey("my-secret-key");
        Fireblocks fireblocks = new Fireblocks(configurationOptions);

        String did = "did:ethr:0x17fe2dd11a2daa7f6c1fdf22532a4763f963aea6"; // String | The Decentralized Identifier (DID) of the VASP.
        List<String> fields = Arrays.asList(); // List<String> | The VASP fields to return.  Optional. If omitted, or supplied with an empty value, the complete VASP record is returned, which is the same as passing `all`.  Most field names return exactly the requested field. A few behave differently: `documents` and `ddq` return a small default set of identifying fields instead of the requested one, and `travelRule_EMAIL` returns an empty object. An unrecognised field name causes an error.
        try {
            CompletableFuture<ApiResponse<TravelRuleVASP>> response = fireblocks.travelRule().getVASPByDID(did, fields);
            System.out.println("Status code: " + response.get().getStatusCode());
            System.out.println("Response headers: " + response.get().getHeaders());
            System.out.println("Response body: " + response.get().getData());
        } catch (InterruptedException | ExecutionException e) {
            ApiException apiException = (ApiException)e.getCause();
            System.err.println("Exception when calling TravelRuleApi#getVASPByDID");
            System.err.println("Status code: " + apiException.getCode());
            System.err.println("Response headers: " + apiException.getResponseHeaders());
            System.err.println("Reason: " + apiException.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
did	String	The Decentralized Identifier (DID) of the VASP.
fields	List<String>	The VASP fields to return. Optional. If omitted, or supplied with an empty value, the complete VASP record is returned, which is the same as passing `all`. Most field names return exactly the requested field. A few behave differently: `documents` and `ddq` return a small default set of identifying fields instead of the requested one, and `travelRule_EMAIL` returns an empty object. An unrecognised field name causes an error.	[optional] [enum: all, did, name, verificationStatus, addressLine1, addressLine2, city, country, emailDomains, website, logo, legalStructure, legalName, yearFounded, incorporationCountry, isRegulated, otherNames, identificationType, identificationCountry, businessNumber, regulatoryAuthorities, jurisdictions, division, street, number, unit, postCode, state, otherLegalName, gleifUpdatedAt, leiNumber, legalForm, entityCategory, entityStatus, externalEntityConfig, hqStreet, hqNumber, hqPostcode, hqRegion, hqCity, hqCountry, certificates, description, travelRule_OPENVASP, travelRule_SYGNA, travelRule_TRISA, travelRule_TRLIGHT, travelRule_EMAIL, travelRule_TRP, travelRule_SHYFT, travelRule_USTRAVELRULEWG, createdAt, createdBy, updatedAt, updatedBy, lastSentDate, lastReceivedDate, documents, hasAdmin, isNotifiable, issuers, regulatoryStatus, supervisoryAuthority, registrationLicenseId, statusStartDate, statusExpirationDate, lastChecked, additionalInformation, subsidiaryOf, pii_didkey, compliancePhase, compliancePhaseData, vaspnetId, vaspnetUpdatedAt, vaspnetImmutableFields, node_didkey, ddq, targetProtocol, parentGateway, isActiveSender, isActiveReceiver, subsidiaries]

Return type

CompletableFuture<ApiResponse<TravelRuleVASP>>

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	VASP details	-
400	Invalid request body	-
500	Internal server error	-

getVASPs

CompletableFuture<ApiResponse> getVASPs getVASPs(order, pageSize, fields, search, reviewValue, pageCursor)

Get All VASPs

Get All VASPs. Returns a list of VASPs. VASPs can be searched and sorted. Each VASP in the response may contain fields that are not documented in the schema below. Clients must ignore unrecognised fields rather than failing to deserialize.

Example

// Import classes:
import com.fireblocks.sdk.ApiClient;
import com.fireblocks.sdk.ApiException;
import com.fireblocks.sdk.ApiResponse;
import com.fireblocks.sdk.BasePath;
import com.fireblocks.sdk.Fireblocks;
import com.fireblocks.sdk.ConfigurationOptions;
import com.fireblocks.sdk.model.*;
import com.fireblocks.sdk.api.TravelRuleApi;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;

public class Example {
    public static void main(String[] args) {
        ConfigurationOptions configurationOptions = new ConfigurationOptions()
            .basePath(BasePath.Sandbox)
            .apiKey("my-api-key")
            .secretKey("my-secret-key");
        Fireblocks fireblocks = new Fireblocks(configurationOptions);

        String order = "ASC"; // String | Field to order by
        BigDecimal pageSize = new BigDecimal("500"); // BigDecimal | Records per page
        List<String> fields = Arrays.asList(); // List<String> | The VASP fields to return.  Optional. If omitted, each VASP is returned with a default subset of six fields: `did`, `name`, `website`, `logo`, `incorporationCountry` and `jurisdictions`. Pass `all` to return the complete record for each VASP.  Most field names return exactly the requested field. A few behave differently: `documents` and `ddq` return a small default set of identifying fields instead of the requested one, and `travelRule_EMAIL` returns an empty object. An unrecognised field name causes an error.
        String search = "Fireblocks"; // String | Search query
        String reviewValue = "TRUSTED"; // String | Filter by the VASP's review status. Possible values include: \"TRUSTED\", \"BLOCKED\", \"MANUAL\", or \"NULL\". When provided, only VASPs that match the specified reviewValue will be returned (i.e., VASPs that have already been reviewed to this status).
        String pageCursor = "100"; // String | Cursor for pagination. When provided, the response will include the next page of results.
        try {
            CompletableFuture<ApiResponse<TravelRuleGetAllVASPsResponse>> response = fireblocks.travelRule().getVASPs(order, pageSize, fields, search, reviewValue, pageCursor);
            System.out.println("Status code: " + response.get().getStatusCode());
            System.out.println("Response headers: " + response.get().getHeaders());
            System.out.println("Response body: " + response.get().getData());
        } catch (InterruptedException | ExecutionException e) {
            ApiException apiException = (ApiException)e.getCause();
            System.err.println("Exception when calling TravelRuleApi#getVASPs");
            System.err.println("Status code: " + apiException.getCode());
            System.err.println("Response headers: " + apiException.getResponseHeaders());
            System.err.println("Reason: " + apiException.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
order	String	Field to order by	[optional] [enum: ASC, DESC]
pageSize	BigDecimal	Records per page	[optional] [default to 500]
fields	List<String>	The VASP fields to return. Optional. If omitted, each VASP is returned with a default subset of six fields: `did`, `name`, `website`, `logo`, `incorporationCountry` and `jurisdictions`. Pass `all` to return the complete record for each VASP. Most field names return exactly the requested field. A few behave differently: `documents` and `ddq` return a small default set of identifying fields instead of the requested one, and `travelRule_EMAIL` returns an empty object. An unrecognised field name causes an error.	[optional] [enum: all, did, name, verificationStatus, addressLine1, addressLine2, city, country, emailDomains, website, logo, legalStructure, legalName, yearFounded, incorporationCountry, isRegulated, otherNames, identificationType, identificationCountry, businessNumber, regulatoryAuthorities, jurisdictions, division, street, number, unit, postCode, state, otherLegalName, gleifUpdatedAt, leiNumber, legalForm, entityCategory, entityStatus, externalEntityConfig, hqStreet, hqNumber, hqPostcode, hqRegion, hqCity, hqCountry, certificates, description, travelRule_OPENVASP, travelRule_SYGNA, travelRule_TRISA, travelRule_TRLIGHT, travelRule_EMAIL, travelRule_TRP, travelRule_SHYFT, travelRule_USTRAVELRULEWG, createdAt, createdBy, updatedAt, updatedBy, lastSentDate, lastReceivedDate, documents, hasAdmin, isNotifiable, issuers, regulatoryStatus, supervisoryAuthority, registrationLicenseId, statusStartDate, statusExpirationDate, lastChecked, additionalInformation, subsidiaryOf, pii_didkey, compliancePhase, compliancePhaseData, vaspnetId, vaspnetUpdatedAt, vaspnetImmutableFields, node_didkey, ddq, targetProtocol, parentGateway, isActiveSender, isActiveReceiver, subsidiaries]
search	String	Search query	[optional]
reviewValue	String	Filter by the VASP's review status. Possible values include: "TRUSTED", "BLOCKED", "MANUAL", or "NULL". When provided, only VASPs that match the specified reviewValue will be returned (i.e., VASPs that have already been reviewed to this status).	[optional] [enum: TRUSTED, BLOCKED, MANUAL, ]
pageCursor	String	Cursor for pagination. When provided, the response will include the next page of results.	[optional]

Return type

CompletableFuture<ApiResponse<TravelRuleGetAllVASPsResponse>>

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Get all VASPs	-
0	Error Response	* X-Request-ID -

getVaspForVault

CompletableFuture<ApiResponse> getVaspForVault getVaspForVault(vaultAccountId)

Get assigned VASP to vault

Get assigned VASP Did for a specific vault. Returns empty string vaspDid value in response if none assigned.

Example

// Import classes:
import com.fireblocks.sdk.ApiClient;
import com.fireblocks.sdk.ApiException;
import com.fireblocks.sdk.ApiResponse;
import com.fireblocks.sdk.BasePath;
import com.fireblocks.sdk.Fireblocks;
import com.fireblocks.sdk.ConfigurationOptions;
import com.fireblocks.sdk.model.*;
import com.fireblocks.sdk.api.TravelRuleApi;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;

public class Example {
    public static void main(String[] args) {
        ConfigurationOptions configurationOptions = new ConfigurationOptions()
            .basePath(BasePath.Sandbox)
            .apiKey("my-api-key")
            .secretKey("my-secret-key");
        Fireblocks fireblocks = new Fireblocks(configurationOptions);

        String vaultAccountId = "1"; // String | The ID of the vault account
        try {
            CompletableFuture<ApiResponse<TravelRuleVaspForVault>> response = fireblocks.travelRule().getVaspForVault(vaultAccountId);
            System.out.println("Status code: " + response.get().getStatusCode());
            System.out.println("Response headers: " + response.get().getHeaders());
            System.out.println("Response body: " + response.get().getData());
        } catch (InterruptedException | ExecutionException e) {
            ApiException apiException = (ApiException)e.getCause();
            System.err.println("Exception when calling TravelRuleApi#getVaspForVault");
            System.err.println("Status code: " + apiException.getCode());
            System.err.println("Response headers: " + apiException.getResponseHeaders());
            System.err.println("Reason: " + apiException.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
vaultAccountId	String	The ID of the vault account

Return type

CompletableFuture<ApiResponse<TravelRuleVaspForVault>>

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	* X-Request-ID -
0	Error Response	* X-Request-ID -

setVaspForVault

CompletableFuture<ApiResponse> setVaspForVault setVaspForVault(travelRuleVaspForVault, vaultAccountId, idempotencyKey)

Assign VASP to vault

Sets the VASP Did for a specific vault. Pass empty string to remove existing one.

Example

// Import classes:
import com.fireblocks.sdk.ApiClient;
import com.fireblocks.sdk.ApiException;
import com.fireblocks.sdk.ApiResponse;
import com.fireblocks.sdk.BasePath;
import com.fireblocks.sdk.Fireblocks;
import com.fireblocks.sdk.ConfigurationOptions;
import com.fireblocks.sdk.model.*;
import com.fireblocks.sdk.api.TravelRuleApi;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;

public class Example {
    public static void main(String[] args) {
        ConfigurationOptions configurationOptions = new ConfigurationOptions()
            .basePath(BasePath.Sandbox)
            .apiKey("my-api-key")
            .secretKey("my-secret-key");
        Fireblocks fireblocks = new Fireblocks(configurationOptions);

        TravelRuleVaspForVault travelRuleVaspForVault = new TravelRuleVaspForVault(); // TravelRuleVaspForVault | 
        String vaultAccountId = "vaultAccountId_example"; // String | The ID of the vault account
        String idempotencyKey = "idempotencyKey_example"; // String | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.
        try {
            CompletableFuture<ApiResponse<TravelRuleVaspForVault>> response = fireblocks.travelRule().setVaspForVault(travelRuleVaspForVault, vaultAccountId, idempotencyKey);
            System.out.println("Status code: " + response.get().getStatusCode());
            System.out.println("Response headers: " + response.get().getHeaders());
            System.out.println("Response body: " + response.get().getData());
        } catch (InterruptedException | ExecutionException e) {
            ApiException apiException = (ApiException)e.getCause();
            System.err.println("Exception when calling TravelRuleApi#setVaspForVault");
            System.err.println("Status code: " + apiException.getCode());
            System.err.println("Response headers: " + apiException.getResponseHeaders());
            System.err.println("Reason: " + apiException.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
travelRuleVaspForVault	TravelRuleVaspForVault
vaultAccountId	String	The ID of the vault account
idempotencyKey	String	A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.	[optional]

Return type

CompletableFuture<ApiResponse<TravelRuleVaspForVault>>

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	OK	* X-Request-ID -
0	Error Response	* X-Request-ID -

updateVasp

CompletableFuture<ApiResponse> updateVasp updateVasp(travelRuleUpdateVASPDetails, idempotencyKey)

Add jsonDidKey to VASP details

Update VASP Details. Updates a VASP with the provided parameters. Use this endpoint to add your public jsonDIDkey generated by Notabene.

Example

// Import classes:
import com.fireblocks.sdk.ApiClient;
import com.fireblocks.sdk.ApiException;
import com.fireblocks.sdk.ApiResponse;
import com.fireblocks.sdk.BasePath;
import com.fireblocks.sdk.Fireblocks;
import com.fireblocks.sdk.ConfigurationOptions;
import com.fireblocks.sdk.model.*;
import com.fireblocks.sdk.api.TravelRuleApi;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;

public class Example {
    public static void main(String[] args) {
        ConfigurationOptions configurationOptions = new ConfigurationOptions()
            .basePath(BasePath.Sandbox)
            .apiKey("my-api-key")
            .secretKey("my-secret-key");
        Fireblocks fireblocks = new Fireblocks(configurationOptions);

        TravelRuleUpdateVASPDetails travelRuleUpdateVASPDetails = new TravelRuleUpdateVASPDetails(); // TravelRuleUpdateVASPDetails | 
        String idempotencyKey = "idempotencyKey_example"; // String | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.
        try {
            CompletableFuture<ApiResponse<TravelRuleUpdateVASPDetails>> response = fireblocks.travelRule().updateVasp(travelRuleUpdateVASPDetails, idempotencyKey);
            System.out.println("Status code: " + response.get().getStatusCode());
            System.out.println("Response headers: " + response.get().getHeaders());
            System.out.println("Response body: " + response.get().getData());
        } catch (InterruptedException | ExecutionException e) {
            ApiException apiException = (ApiException)e.getCause();
            System.err.println("Exception when calling TravelRuleApi#updateVasp");
            System.err.println("Status code: " + apiException.getCode());
            System.err.println("Response headers: " + apiException.getResponseHeaders());
            System.err.println("Reason: " + apiException.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
travelRuleUpdateVASPDetails	TravelRuleUpdateVASPDetails
idempotencyKey	String	A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.	[optional]

Return type

CompletableFuture<ApiResponse<TravelRuleUpdateVASPDetails>>

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	VASP updated successfully	-
400	Invalid request body	-
500	Internal server error	-

validateFullTravelRuleTransaction

CompletableFuture<ApiResponse> validateFullTravelRuleTransaction validateFullTravelRuleTransaction(travelRuleValidateFullTransactionRequest, notation, idempotencyKey)

Validate Full Travel Rule Transaction

Validate Full Travel Rule transactions. Checks for all required information on the originator and beneficiary VASPs.

Example

// Import classes:
import com.fireblocks.sdk.ApiClient;
import com.fireblocks.sdk.ApiException;
import com.fireblocks.sdk.ApiResponse;
import com.fireblocks.sdk.BasePath;
import com.fireblocks.sdk.Fireblocks;
import com.fireblocks.sdk.ConfigurationOptions;
import com.fireblocks.sdk.model.*;
import com.fireblocks.sdk.api.TravelRuleApi;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;

public class Example {
    public static void main(String[] args) {
        ConfigurationOptions configurationOptions = new ConfigurationOptions()
            .basePath(BasePath.Sandbox)
            .apiKey("my-api-key")
            .secretKey("my-secret-key");
        Fireblocks fireblocks = new Fireblocks(configurationOptions);

        TravelRuleValidateFullTransactionRequest travelRuleValidateFullTransactionRequest = new TravelRuleValidateFullTransactionRequest(); // TravelRuleValidateFullTransactionRequest | 
        List<String> notation = Arrays.asList(); // List<String> | Specifies the notation of the transaction. Possible values are: - `notabene`: Uses Notabene notation (default behavior). - `fireblocks`: Uses Fireblocks notation, with automatic translation of asset tickers and amounts. - `<none>`: Defaults to `notabene` for backward compatibility. **Note:** The default value for the `notation` parameter will change from `notabene` to `fireblocks` Update your integrations accordingly.
        String idempotencyKey = "idempotencyKey_example"; // String | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.
        try {
            CompletableFuture<ApiResponse<TravelRuleValidateTransactionResponse>> response = fireblocks.travelRule().validateFullTravelRuleTransaction(travelRuleValidateFullTransactionRequest, notation, idempotencyKey);
            System.out.println("Status code: " + response.get().getStatusCode());
            System.out.println("Response headers: " + response.get().getHeaders());
            System.out.println("Response body: " + response.get().getData());
        } catch (InterruptedException | ExecutionException e) {
            ApiException apiException = (ApiException)e.getCause();
            System.err.println("Exception when calling TravelRuleApi#validateFullTravelRuleTransaction");
            System.err.println("Status code: " + apiException.getCode());
            System.err.println("Response headers: " + apiException.getResponseHeaders());
            System.err.println("Reason: " + apiException.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
travelRuleValidateFullTransactionRequest	TravelRuleValidateFullTransactionRequest
notation	List<String>	Specifies the notation of the transaction. Possible values are: - `notabene`: Uses Notabene notation (default behavior). - `fireblocks`: Uses Fireblocks notation, with automatic translation of asset tickers and amounts. - `<none>`: Defaults to `notabene` for backward compatibility. Note: The default value for the `notation` parameter will change from `notabene` to `fireblocks` Update your integrations accordingly.	[optional] [enum: fireblocks, notabene]
idempotencyKey	String	A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.	[optional]

Return type

CompletableFuture<ApiResponse<TravelRuleValidateTransactionResponse>>

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Transaction validated successfully	-
0	Error Response	* X-Request-ID -

Uh oh!

FilesExpand file tree

TravelRuleApi.md

Latest commit

History

TravelRuleApi.md

File metadata and controls

TravelRuleApi

createTrustProofOfAddress

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getTrustProofOfAddress

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getVASPByDID

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getVASPs

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getVaspForVault

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

setVaspForVault

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

updateVasp

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

validateFullTravelRuleTransaction

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details