fireblocks_sdk::apis::compliance_api

Trait ComplianceApi

Source 
pub trait ComplianceApi: Send + Sync {

Show 18 methods    // Required methods
    fn get_aml_post_screening_policy<'life0, 'async_trait>(
        &'life0 self,
    ) -> Pin<Box<dyn Future<Output = Result<ScreeningPolicyResponse, Error<GetAmlPostScreeningPolicyError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn get_aml_screening_configuration<'life0, 'async_trait>(
        &'life0 self,
    ) -> Pin<Box<dyn Future<Output = Result<ScreeningConfigurationsRequest, Error<GetAmlScreeningConfigurationError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn get_aml_screening_policy<'life0, 'async_trait>(
        &'life0 self,
    ) -> Pin<Box<dyn Future<Output = Result<ScreeningProviderRulesConfigurationResponse, Error<GetAmlScreeningPolicyError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn get_post_screening_policy<'life0, 'async_trait>(
        &'life0 self,
    ) -> Pin<Box<dyn Future<Output = Result<ScreeningPolicyResponse, Error<GetPostScreeningPolicyError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn get_screening_configuration<'life0, 'async_trait>(
        &'life0 self,
    ) -> Pin<Box<dyn Future<Output = Result<ScreeningConfigurationsRequest, Error<GetScreeningConfigurationError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn get_screening_full_details<'life0, 'async_trait>(
        &'life0 self,
        params: GetScreeningFullDetailsParams,
    ) -> Pin<Box<dyn Future<Output = Result<ComplianceResultFullPayload, Error<GetScreeningFullDetailsError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn get_screening_policy<'life0, 'async_trait>(
        &'life0 self,
    ) -> Pin<Box<dyn Future<Output = Result<ScreeningProviderRulesConfigurationResponse, Error<GetScreeningPolicyError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn get_vasp_for_vault<'life0, 'async_trait>(
        &'life0 self,
        params: GetVaspForVaultParams,
    ) -> Pin<Box<dyn Future<Output = Result<TravelRuleVaspForVault, Error<GetVaspForVaultError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn get_vaspby_did<'life0, 'async_trait>(
        &'life0 self,
        params: GetVaspbyDidParams,
    ) -> Pin<Box<dyn Future<Output = Result<TravelRuleVasp, Error<GetVaspbyDidError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn get_vasps<'life0, 'async_trait>(
        &'life0 self,
        params: GetVaspsParams,
    ) -> Pin<Box<dyn Future<Output = Result<TravelRuleGetAllVaspsResponse, Error<GetVaspsError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn retry_rejected_transaction_bypass_screening_checks<'life0, 'async_trait>(
        &'life0 self,
        params: RetryRejectedTransactionBypassScreeningChecksParams,
    ) -> Pin<Box<dyn Future<Output = Result<CreateTransactionResponse, Error<RetryRejectedTransactionBypassScreeningChecksError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn set_vasp_for_vault<'life0, 'async_trait>(
        &'life0 self,
        params: SetVaspForVaultParams,
    ) -> Pin<Box<dyn Future<Output = Result<TravelRuleVaspForVault, Error<SetVaspForVaultError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn update_aml_screening_configuration<'life0, 'async_trait>(
        &'life0 self,
        params: UpdateAmlScreeningConfigurationParams,
    ) -> Pin<Box<dyn Future<Output = Result<ScreeningConfigurationsRequest, Error<UpdateAmlScreeningConfigurationError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn update_screening_configuration<'life0, 'async_trait>(
        &'life0 self,
        params: UpdateScreeningConfigurationParams,
    ) -> Pin<Box<dyn Future<Output = Result<ScreeningUpdateConfigurations, Error<UpdateScreeningConfigurationError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn update_travel_rule_config<'life0, 'async_trait>(
        &'life0 self,
        params: UpdateTravelRuleConfigParams,
    ) -> Pin<Box<dyn Future<Output = Result<ScreeningConfigurationsRequest, Error<UpdateTravelRuleConfigError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn update_vasp<'life0, 'async_trait>(
        &'life0 self,
        params: UpdateVaspParams,
    ) -> Pin<Box<dyn Future<Output = Result<TravelRuleUpdateVaspDetails, Error<UpdateVaspError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn validate_full_travel_rule_transaction<'life0, 'async_trait>(
        &'life0 self,
        params: ValidateFullTravelRuleTransactionParams,
    ) -> Pin<Box<dyn Future<Output = Result<TravelRuleValidateTransactionResponse, Error<ValidateFullTravelRuleTransactionError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn validate_travel_rule_transaction<'life0, 'async_trait>(
        &'life0 self,
        params: ValidateTravelRuleTransactionParams,
    ) -> Pin<Box<dyn Future<Output = Result<TravelRuleValidateTransactionResponse, Error<ValidateTravelRuleTransactionError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;

}

Required Methods§

Source

fn get_aml_post_screening_policy<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<ScreeningPolicyResponse, Error<GetAmlPostScreeningPolicyError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

GET /screening/aml/post_screening_policy

Get the post-screening policy for AML.
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.

Source

fn get_aml_screening_configuration<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<ScreeningConfigurationsRequest, Error<GetAmlScreeningConfigurationError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

GET /screening/aml/policy_configuration

Retrieves the configuration for Travel Rule screening policy.
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.

Source

fn get_aml_screening_policy<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<ScreeningProviderRulesConfigurationResponse, Error<GetAmlScreeningPolicyError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

GET /screening/aml/screening_policy

Get the screening policy for AML.
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.

Source

fn get_post_screening_policy<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<ScreeningPolicyResponse, Error<GetPostScreeningPolicyError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

GET /screening/travel_rule/post_screening_policy

Get the post-screening policy for Travel Rule.
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.

Source

fn get_screening_configuration<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<ScreeningConfigurationsRequest, Error<GetScreeningConfigurationError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

GET /screening/travel_rule/policy_configuration

Retrieves the configuration for Travel Rule screening policy.
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.

Source

fn get_screening_full_details<'life0, 'async_trait>( &'life0 self, params: GetScreeningFullDetailsParams, ) -> Pin<Box<dyn Future<Output = Result<ComplianceResultFullPayload, Error<GetScreeningFullDetailsError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

GET /screening/transaction/{txId}

Provides all the compliance details for the given screened transaction.
Endpoint Permission: All users.

Source

fn get_screening_policy<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<ScreeningProviderRulesConfigurationResponse, Error<GetScreeningPolicyError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

GET /screening/travel_rule/screening_policy

Get the screening policy for Travel Rule.
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.

Source

fn get_vasp_for_vault<'life0, 'async_trait>( &'life0 self, params: GetVaspForVaultParams, ) -> Pin<Box<dyn Future<Output = Result<TravelRuleVaspForVault, Error<GetVaspForVaultError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

GET /screening/travel_rule/vault/{vaultAccountId}/vasp

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

Source

fn get_vaspby_did<'life0, 'async_trait>( &'life0 self, params: GetVaspbyDidParams, ) -> Pin<Box<dyn Future<Output = Result<TravelRuleVasp, Error<GetVaspbyDidError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

GET /screening/travel_rule/vasp/{did}

Get VASP Details. Returns information about a VASP that has the specified DID.
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.

Source

fn get_vasps<'life0, 'async_trait>( &'life0 self, params: GetVaspsParams, ) -> Pin<Box<dyn Future<Output = Result<TravelRuleGetAllVaspsResponse, Error<GetVaspsError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

GET /screening/travel_rule/vasp

Get All VASPs. Returns a list of VASPs. VASPs can be searched and sorted and results are paginated.
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.

Source

fn retry_rejected_transaction_bypass_screening_checks<'life0, 'async_trait>( &'life0 self, params: RetryRejectedTransactionBypassScreeningChecksParams, ) -> Pin<Box<dyn Future<Output = Result<CreateTransactionResponse, Error<RetryRejectedTransactionBypassScreeningChecksError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

POST /screening/transaction/{txId}/bypass_screening_policy

This endpoint is restricted to Admin API users and is only applicable to outgoing transactions. Calling the "Bypass Screening Policy" API endpoint triggers a new transaction, with the API user as the initiator, bypassing the screening policy check
Endpoint Permission: Admin and Non-Signing Admin.

Source

fn set_vasp_for_vault<'life0, 'async_trait>( &'life0 self, params: SetVaspForVaultParams, ) -> Pin<Box<dyn Future<Output = Result<TravelRuleVaspForVault, Error<SetVaspForVaultError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

POST /screening/travel_rule/vault/{vaultAccountId}/vasp

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

Source

fn update_aml_screening_configuration<'life0, 'async_trait>( &'life0 self, params: UpdateAmlScreeningConfigurationParams, ) -> Pin<Box<dyn Future<Output = Result<ScreeningConfigurationsRequest, Error<UpdateAmlScreeningConfigurationError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

PUT /screening/aml/policy_configuration

Updates bypass screening, inbound delay, or outbound delay configurations for AML.
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.

Source

fn update_screening_configuration<'life0, 'async_trait>( &'life0 self, params: UpdateScreeningConfigurationParams, ) -> Pin<Box<dyn Future<Output = Result<ScreeningUpdateConfigurations, Error<UpdateScreeningConfigurationError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

PUT /screening/configurations

Update Tenant screening configuration. Learn more about Fireblocks AML management in the following guide.
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.

Source

fn update_travel_rule_config<'life0, 'async_trait>( &'life0 self, params: UpdateTravelRuleConfigParams, ) -> Pin<Box<dyn Future<Output = Result<ScreeningConfigurationsRequest, Error<UpdateTravelRuleConfigError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

PUT /screening/travel_rule/policy_configuration

Updates bypass screening, inbound delay, or outbound delay configurations for Travel Rule.
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.

Source

fn update_vasp<'life0, 'async_trait>( &'life0 self, params: UpdateVaspParams, ) -> Pin<Box<dyn Future<Output = Result<TravelRuleUpdateVaspDetails, Error<UpdateVaspError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

PUT /screening/travel_rule/vasp/update

Updates a VASP with the provided parameters. Use this endpoint to add your public jsonDIDkey generated by Notabene.
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.

Source

fn validate_full_travel_rule_transaction<'life0, 'async_trait>( &'life0 self, params: ValidateFullTravelRuleTransactionParams, ) -> Pin<Box<dyn Future<Output = Result<TravelRuleValidateTransactionResponse, Error<ValidateFullTravelRuleTransactionError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

POST /screening/travel_rule/transaction/validate/full

Validate Full Travel Rule transaction. Checks for all required information on the originator and beneficiary VASPs. Learn more about Fireblocks Travel Rule management in the following guide.
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.

Source

fn validate_travel_rule_transaction<'life0, 'async_trait>( &'life0 self, params: ValidateTravelRuleTransactionParams, ) -> Pin<Box<dyn Future<Output = Result<TravelRuleValidateTransactionResponse, Error<ValidateTravelRuleTransactionError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

POST /screening/travel_rule/transaction/validate

Validate Travel Rule transactions. Checks what beneficiary VASP details are required by your jurisdiction and the beneficiary’s jurisdiction. Deprecation Notice This endpoint will be deprecated soon in favor of the validate full endpoint. Please update your integrations to use the validate full endpoint to ensure compatibility with future releases. Checks what beneficiary VASP details are required by your jurisdiction and the beneficiary’s jurisdiction. Learn more about Fireblocks Travel Rule management in the following guide.
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.

Implementors§