All URIs are relative to https://api.fireblocks.io/v1
| Method | HTTP request | Description |
|---|---|---|
| activate_byork_config | POST /screening/byork/config/activate | Activate BYORK Light |
| add_address_registry_vault_opt_outs | POST /address_registry/vaults | Add vault accounts to the address registry opt-out list |
| assign_vaults_to_legal_entity | POST /legal_entities/{legalEntityId}/vaults | Assign vault accounts to a legal entity |
| deactivate_byork_config | POST /screening/byork/config/deactivate | Deactivate BYORK Light |
| get_address_registry_tenant_participation_status | GET /address_registry/tenant | Get address registry participation status for the authenticated workspace |
| get_address_registry_vault_opt_out | GET /address_registry/vaults/{vaultAccountId} | Get whether a vault account is opted out of the address registry |
| get_aml_post_screening_policy | GET /screening/aml/post_screening_policy | AML - View Post-Screening Policy |
| get_aml_screening_policy | GET /screening/aml/screening_policy | AML - View Screening Policy |
| get_byork_config | GET /screening/byork/config | Get BYORK Light configuration |
| get_byork_verdict | GET /screening/byork/verdict | Get BYORK Light verdict |
| get_legal_entity | GET /legal_entities/{legalEntityId} | Get a legal entity |
| get_legal_entity_for_address | GET /address_registry/legal_entities/{address} | Look up legal entity by blockchain address |
| get_post_screening_policy | GET /screening/travel_rule/post_screening_policy | Travel Rule - View Post-Screening Policy |
| get_screening_full_details | GET /screening/transaction/{txId} | Provides all the compliance details for the given screened transaction. |
| get_screening_policy | GET /screening/travel_rule/screening_policy | Travel Rule - View Screening Policy |
| list_address_registry_vault_opt_outs | GET /address_registry/vaults | List vault-level address registry opt-outs (paginated) |
| list_legal_entities | GET /legal_entities | List legal entities (Paginated) |
| list_vaults_for_legal_entity | GET /legal_entities/{legalEntityId}/vaults | List vault accounts for a legal entity (Paginated) |
| opt_in_address_registry_tenant | POST /address_registry/tenant | Opt the workspace in to the address registry |
| opt_out_address_registry_tenant | DELETE /address_registry/tenant | Opt the workspace out of the address registry |
| register_legal_entity | POST /legal_entities | Register a new legal entity |
| remove_address_registry_vault_opt_out | DELETE /address_registry/vaults/{vaultAccountId} | Remove a single vault account from the address registry opt-out list |
| remove_all_address_registry_vault_opt_outs | DELETE /address_registry/vaults | Remove all vault-level address registry opt-outs for the workspace |
| retry_rejected_transaction_bypass_screening_checks | POST /screening/transaction/{txId}/bypass_screening_policy | Calling the "Bypass Screening Policy" API endpoint triggers a new transaction, with the API user as the initiator, bypassing the screening policy check |
| set_aml_verdict | POST /screening/aml/verdict/manual | Set AML Verdict (BYORK Super Light) |
| set_byork_timeouts | PUT /screening/byork/config/timeouts | Set BYORK Light timeouts |
| set_byork_verdict | POST /screening/byork/verdict | Set BYORK Light verdict |
| update_aml_screening_configuration | PUT /screening/aml/policy_configuration | Update AML Configuration |
| update_legal_entity | PUT /legal_entities/{legalEntityId} | Update legal entity |
| update_screening_configuration | PUT /screening/configurations | Tenant - Screening Configuration |
| update_travel_rule_config | PUT /screening/travel_rule/policy_configuration | Update Travel Rule Configuration |
ByorkConfigResponse activate_byork_config(idempotency_key=idempotency_key)
Activate BYORK Light
Activates BYORK Light for the authenticated tenant (sets config.active to true). Once activated, BYORK screening applies to matching transactions. Requires BYORK Light to be enabled for the tenant (contact your CSM to enable).
from fireblocks.models.byork_config_response import ByorkConfigResponse
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
from fireblocks.base_path import BasePath
from pprint import pprint
# load the secret key content from a file
with open('your_secret_key_file_path', 'r') as file:
secret_key_value = file.read()
# build the configuration
configuration = ClientConfiguration(
api_key="your_api_key",
secret_key=secret_key_value,
base_path=BasePath.Sandbox, # or set it directly to a string "https://sandbox-api.fireblocks.io/v1"
)
# Enter a context with an instance of the API client
with Fireblocks(configuration) as fireblocks:
idempotency_key = 'idempotency_key_example' # str | 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)
try:
# Activate BYORK Light
api_response = fireblocks.compliance.activate_byork_config(idempotency_key=idempotency_key).result()
print("The response of ComplianceApi->activate_byork_config:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ComplianceApi->activate_byork_config: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| idempotency_key | str | 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] |
No authorization required
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | BYORK configuration activated. | * X-Request-ID - |
| 400 | BYORK Light not enabled for tenant. | * X-Request-ID - |
| 0 | Error Response | * X-Request-ID - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
AddressRegistryAddVaultOptOutsResponse add_address_registry_vault_opt_outs(address_registry_add_vault_opt_outs_request, idempotency_key=idempotency_key)
Add vault accounts to the address registry opt-out list
Adds one or more vault account ids to the workspace opt-out list for the address registry.
from fireblocks.models.address_registry_add_vault_opt_outs_request import AddressRegistryAddVaultOptOutsRequest
from fireblocks.models.address_registry_add_vault_opt_outs_response import AddressRegistryAddVaultOptOutsResponse
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
from fireblocks.base_path import BasePath
from pprint import pprint
# load the secret key content from a file
with open('your_secret_key_file_path', 'r') as file:
secret_key_value = file.read()
# build the configuration
configuration = ClientConfiguration(
api_key="your_api_key",
secret_key=secret_key_value,
base_path=BasePath.Sandbox, # or set it directly to a string "https://sandbox-api.fireblocks.io/v1"
)
# Enter a context with an instance of the API client
with Fireblocks(configuration) as fireblocks:
address_registry_add_vault_opt_outs_request = fireblocks.AddressRegistryAddVaultOptOutsRequest() # AddressRegistryAddVaultOptOutsRequest |
idempotency_key = 'idempotency_key_example' # str | 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)
try:
# Add vault accounts to the address registry opt-out list
api_response = fireblocks.compliance.add_address_registry_vault_opt_outs(address_registry_add_vault_opt_outs_request, idempotency_key=idempotency_key).result()
print("The response of ComplianceApi->add_address_registry_vault_opt_outs:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ComplianceApi->add_address_registry_vault_opt_outs: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| address_registry_add_vault_opt_outs_request | AddressRegistryAddVaultOptOutsRequest | ||
| idempotency_key | str | 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] |
AddressRegistryAddVaultOptOutsResponse
No authorization required
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Opt-outs recorded; response body includes `acceptedCount`. | * X-Request-ID - |
| 400 | Validation error (e.g. empty list or invalid vault ids) | * X-Request-ID - |
| 0 | Error Response | * X-Request-ID - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
AssignVaultsToLegalEntityResponse assign_vaults_to_legal_entity(legal_entity_id, assign_vaults_to_legal_entity_request, idempotency_key=idempotency_key)
Assign vault accounts to a legal entity
Assigns one or more vault accounts to a specific legal entity registration. Explicitly mapped vault accounts take precedence over the workspace default legal entity.
Endpoint Permission: Admin, Non-Signing Admin.
from fireblocks.models.assign_vaults_to_legal_entity_request import AssignVaultsToLegalEntityRequest
from fireblocks.models.assign_vaults_to_legal_entity_response import AssignVaultsToLegalEntityResponse
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
from fireblocks.base_path import BasePath
from pprint import pprint
# load the secret key content from a file
with open('your_secret_key_file_path', 'r') as file:
secret_key_value = file.read()
# build the configuration
configuration = ClientConfiguration(
api_key="your_api_key",
secret_key=secret_key_value,
base_path=BasePath.Sandbox, # or set it directly to a string "https://sandbox-api.fireblocks.io/v1"
)
# Enter a context with an instance of the API client
with Fireblocks(configuration) as fireblocks:
legal_entity_id = 'legal_entity_id_example' # str | The unique ID of the legal entity registration
assign_vaults_to_legal_entity_request = fireblocks.AssignVaultsToLegalEntityRequest() # AssignVaultsToLegalEntityRequest |
idempotency_key = 'idempotency_key_example' # str | 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)
try:
# Assign vault accounts to a legal entity
api_response = fireblocks.compliance.assign_vaults_to_legal_entity(legal_entity_id, assign_vaults_to_legal_entity_request, idempotency_key=idempotency_key).result()
print("The response of ComplianceApi->assign_vaults_to_legal_entity:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ComplianceApi->assign_vaults_to_legal_entity: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| legal_entity_id | str | The unique ID of the legal entity registration | |
| assign_vaults_to_legal_entity_request | AssignVaultsToLegalEntityRequest | ||
| idempotency_key | str | 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] |
AssignVaultsToLegalEntityResponse
No authorization required
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 201 | Vault accounts assigned successfully | * X-Request-ID - |
| 404 | Legal entity registration not found | * X-Request-ID - |
| 0 | Error Response | * X-Request-ID - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ByorkConfigResponse deactivate_byork_config(idempotency_key=idempotency_key)
Deactivate BYORK Light
Deactivates BYORK Light for the authenticated tenant (sets config.active to false). Once deactivated, BYORK screening no longer applies until activated again. Requires BYORK Light to be enabled for the tenant (contact your CSM to enable).
from fireblocks.models.byork_config_response import ByorkConfigResponse
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
from fireblocks.base_path import BasePath
from pprint import pprint
# load the secret key content from a file
with open('your_secret_key_file_path', 'r') as file:
secret_key_value = file.read()
# build the configuration
configuration = ClientConfiguration(
api_key="your_api_key",
secret_key=secret_key_value,
base_path=BasePath.Sandbox, # or set it directly to a string "https://sandbox-api.fireblocks.io/v1"
)
# Enter a context with an instance of the API client
with Fireblocks(configuration) as fireblocks:
idempotency_key = 'idempotency_key_example' # str | 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)
try:
# Deactivate BYORK Light
api_response = fireblocks.compliance.deactivate_byork_config(idempotency_key=idempotency_key).result()
print("The response of ComplianceApi->deactivate_byork_config:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ComplianceApi->deactivate_byork_config: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| idempotency_key | str | 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] |
No authorization required
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | BYORK configuration deactivated. | * X-Request-ID - |
| 400 | BYORK Light not enabled for tenant. | * X-Request-ID - |
| 0 | Error Response | * X-Request-ID - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
AddressRegistryTenantRegistryResponse get_address_registry_tenant_participation_status()
Get address registry participation status for the authenticated workspace
Returns whether the workspace is OPTED_IN or OPTED_OUT of the address registry.
from fireblocks.models.address_registry_tenant_registry_response import AddressRegistryTenantRegistryResponse
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
from fireblocks.base_path import BasePath
from pprint import pprint
# load the secret key content from a file
with open('your_secret_key_file_path', 'r') as file:
secret_key_value = file.read()
# build the configuration
configuration = ClientConfiguration(
api_key="your_api_key",
secret_key=secret_key_value,
base_path=BasePath.Sandbox, # or set it directly to a string "https://sandbox-api.fireblocks.io/v1"
)
# Enter a context with an instance of the API client
with Fireblocks(configuration) as fireblocks:
try:
# Get address registry participation status for the authenticated workspace
api_response = fireblocks.compliance.get_address_registry_tenant_participation_status().result()
print("The response of ComplianceApi->get_address_registry_tenant_participation_status:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ComplianceApi->get_address_registry_tenant_participation_status: %s\n" % e)This endpoint does not need any parameter.
AddressRegistryTenantRegistryResponse
No authorization required
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Participation status in the response body | * X-Request-ID - |
| 0 | Error Response | * X-Request-ID - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
AddressRegistryGetVaultOptOutResponse get_address_registry_vault_opt_out(vault_account_id)
Get whether a vault account is opted out of the address registry
Returns whether this vault account is on the workspace opt-out list (optedOut true or false). List, add, and clear-all are available on /v1/address_registry/vaults; this path reads or removes one vault.
from fireblocks.models.address_registry_get_vault_opt_out_response import AddressRegistryGetVaultOptOutResponse
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
from fireblocks.base_path import BasePath
from pprint import pprint
# load the secret key content from a file
with open('your_secret_key_file_path', 'r') as file:
secret_key_value = file.read()
# build the configuration
configuration = ClientConfiguration(
api_key="your_api_key",
secret_key=secret_key_value,
base_path=BasePath.Sandbox, # or set it directly to a string "https://sandbox-api.fireblocks.io/v1"
)
# Enter a context with an instance of the API client
with Fireblocks(configuration) as fireblocks:
vault_account_id = 10001 # int | Vault account id (non-negative integer).
try:
# Get whether a vault account is opted out of the address registry
api_response = fireblocks.compliance.get_address_registry_vault_opt_out(vault_account_id).result()
print("The response of ComplianceApi->get_address_registry_vault_opt_out:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ComplianceApi->get_address_registry_vault_opt_out: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| vault_account_id | int | Vault account id (non-negative integer). |
AddressRegistryGetVaultOptOutResponse
No authorization required
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Current opt-out flag for the vault | * X-Request-ID - |
| 400 | Invalid path parameter (e.g. negative or out-of-range vault account id) | * X-Request-ID - |
| 0 | Error Response | * X-Request-ID - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ScreeningPolicyResponse get_aml_post_screening_policy()
AML - View Post-Screening Policy
Get the post-screening policy for AML.
from fireblocks.models.screening_policy_response import ScreeningPolicyResponse
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
from fireblocks.base_path import BasePath
from pprint import pprint
# load the secret key content from a file
with open('your_secret_key_file_path', 'r') as file:
secret_key_value = file.read()
# build the configuration
configuration = ClientConfiguration(
api_key="your_api_key",
secret_key=secret_key_value,
base_path=BasePath.Sandbox, # or set it directly to a string "https://sandbox-api.fireblocks.io/v1"
)
# Enter a context with an instance of the API client
with Fireblocks(configuration) as fireblocks:
try:
# AML - View Post-Screening Policy
api_response = fireblocks.compliance.get_aml_post_screening_policy().result()
print("The response of ComplianceApi->get_aml_post_screening_policy:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ComplianceApi->get_aml_post_screening_policy: %s\n" % e)This endpoint does not need any parameter.
No authorization required
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Post-screening policy retrieved successfully. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ScreeningProviderRulesConfigurationResponse get_aml_screening_policy()
AML - View Screening Policy
Get the screening policy for AML.
from fireblocks.models.screening_provider_rules_configuration_response import ScreeningProviderRulesConfigurationResponse
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
from fireblocks.base_path import BasePath
from pprint import pprint
# load the secret key content from a file
with open('your_secret_key_file_path', 'r') as file:
secret_key_value = file.read()
# build the configuration
configuration = ClientConfiguration(
api_key="your_api_key",
secret_key=secret_key_value,
base_path=BasePath.Sandbox, # or set it directly to a string "https://sandbox-api.fireblocks.io/v1"
)
# Enter a context with an instance of the API client
with Fireblocks(configuration) as fireblocks:
try:
# AML - View Screening Policy
api_response = fireblocks.compliance.get_aml_screening_policy().result()
print("The response of ComplianceApi->get_aml_screening_policy:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ComplianceApi->get_aml_screening_policy: %s\n" % e)This endpoint does not need any parameter.
ScreeningProviderRulesConfigurationResponse
No authorization required
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Screening policy retrieved successfully. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ByorkConfigResponse get_byork_config()
Get BYORK Light configuration
Retrieves BYORK Light configuration for the authenticated tenant (timeouts, active flag, allowed timeout ranges). Returns default config when none exists. Requires BYORK Light to be enabled for the tenant.
from fireblocks.models.byork_config_response import ByorkConfigResponse
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
from fireblocks.base_path import BasePath
from pprint import pprint
# load the secret key content from a file
with open('your_secret_key_file_path', 'r') as file:
secret_key_value = file.read()
# build the configuration
configuration = ClientConfiguration(
api_key="your_api_key",
secret_key=secret_key_value,
base_path=BasePath.Sandbox, # or set it directly to a string "https://sandbox-api.fireblocks.io/v1"
)
# Enter a context with an instance of the API client
with Fireblocks(configuration) as fireblocks:
try:
# Get BYORK Light configuration
api_response = fireblocks.compliance.get_byork_config().result()
print("The response of ComplianceApi->get_byork_config:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ComplianceApi->get_byork_config: %s\n" % e)This endpoint does not need any parameter.
No authorization required
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | BYORK configuration (or default). | * X-Request-ID - |
| 400 | BYORK Light not enabled for tenant. | * X-Request-ID - |
| 0 | Error Response | * X-Request-ID - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetByorkVerdictResponse get_byork_verdict(tx_id)
Get BYORK Light verdict
Returns the current BYORK verdict and status for a transaction. Status can be PRE_ACCEPTED, PENDING, RECEIVED (verdict is final but processing not yet complete), or COMPLETED. Requires BYORK Light to be enabled for the tenant. Returns 404 if no BYORK verdict is found for the transaction.
from fireblocks.models.get_byork_verdict_response import GetByorkVerdictResponse
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
from fireblocks.base_path import BasePath
from pprint import pprint
# load the secret key content from a file
with open('your_secret_key_file_path', 'r') as file:
secret_key_value = file.read()
# build the configuration
configuration = ClientConfiguration(
api_key="your_api_key",
secret_key=secret_key_value,
base_path=BasePath.Sandbox, # or set it directly to a string "https://sandbox-api.fireblocks.io/v1"
)
# Enter a context with an instance of the API client
with Fireblocks(configuration) as fireblocks:
tx_id = '550e8400-e29b-41d4-a716-446655440000' # str | Transaction ID
try:
# Get BYORK Light verdict
api_response = fireblocks.compliance.get_byork_verdict(tx_id).result()
print("The response of ComplianceApi->get_byork_verdict:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ComplianceApi->get_byork_verdict: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| tx_id | str | Transaction ID |
No authorization required
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Current verdict and status. | * X-Request-ID - |
| 400 | BYORK Light not enabled for tenant or txId missing. | * X-Request-ID - |
| 404 | No BYORK verdict found for this transaction. | * X-Request-ID - |
| 500 | Internal server error. | * X-Request-ID - |
| 0 | Error Response | * X-Request-ID - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
LegalEntityRegistration get_legal_entity(legal_entity_id)
Get a legal entity
Returns details of a specific legal entity registration, including GLEIF data when available.
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.
from fireblocks.models.legal_entity_registration import LegalEntityRegistration
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
from fireblocks.base_path import BasePath
from pprint import pprint
# load the secret key content from a file
with open('your_secret_key_file_path', 'r') as file:
secret_key_value = file.read()
# build the configuration
configuration = ClientConfiguration(
api_key="your_api_key",
secret_key=secret_key_value,
base_path=BasePath.Sandbox, # or set it directly to a string "https://sandbox-api.fireblocks.io/v1"
)
# Enter a context with an instance of the API client
with Fireblocks(configuration) as fireblocks:
legal_entity_id = 'legal_entity_id_example' # str | The unique ID of the legal entity registration
try:
# Get a legal entity
api_response = fireblocks.compliance.get_legal_entity(legal_entity_id).result()
print("The response of ComplianceApi->get_legal_entity:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ComplianceApi->get_legal_entity: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| legal_entity_id | str | The unique ID of the legal entity registration |
No authorization required
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Legal entity registration details | * X-Request-ID - |
| 404 | Legal entity registration not found | * X-Request-ID - |
| 0 | Error Response | * X-Request-ID - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
AddressRegistryLegalEntity get_legal_entity_for_address(address)
Look up legal entity by blockchain address
Returns legal entity information for the given blockchain address (verification status, LEI, Travel Rule providers, contact email, and related fields — see response schema). URL-encode {address} when required.
from fireblocks.models.address_registry_legal_entity import AddressRegistryLegalEntity
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
from fireblocks.base_path import BasePath
from pprint import pprint
# load the secret key content from a file
with open('your_secret_key_file_path', 'r') as file:
secret_key_value = file.read()
# build the configuration
configuration = ClientConfiguration(
api_key="your_api_key",
secret_key=secret_key_value,
base_path=BasePath.Sandbox, # or set it directly to a string "https://sandbox-api.fireblocks.io/v1"
)
# Enter a context with an instance of the API client
with Fireblocks(configuration) as fireblocks:
address = '0x742d35cc6634c0532925a3b844bc9e7595f0beb0' # str | Blockchain address to look up
try:
# Look up legal entity by blockchain address
api_response = fireblocks.compliance.get_legal_entity_for_address(address).result()
print("The response of ComplianceApi->get_legal_entity_for_address:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ComplianceApi->get_legal_entity_for_address: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| address | str | Blockchain address to look up |
No authorization required
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Legal entity found | * X-Request-ID - |
| 400 | Bad request — either request validation (path `{address}` empty or whitespace-only after trim, e.g. encoded spaces only; numeric code 4100), or the authenticated workspace is not opted in to the address registry (numeric code 2140). The `message` field describes the failure; use `code` to distinguish. | * X-Request-ID - |
| 404 | Not found (error code 2142) — unresolved address, no legal entity for a resolved address, or the same not-found outcome in other cases. | * X-Request-ID - |
| 0 | Error Response | * X-Request-ID - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ScreeningPolicyResponse get_post_screening_policy()
Travel Rule - View Post-Screening Policy
Get the post-screening policy for Travel Rule.
from fireblocks.models.screening_policy_response import ScreeningPolicyResponse
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
from fireblocks.base_path import BasePath
from pprint import pprint
# load the secret key content from a file
with open('your_secret_key_file_path', 'r') as file:
secret_key_value = file.read()
# build the configuration
configuration = ClientConfiguration(
api_key="your_api_key",
secret_key=secret_key_value,
base_path=BasePath.Sandbox, # or set it directly to a string "https://sandbox-api.fireblocks.io/v1"
)
# Enter a context with an instance of the API client
with Fireblocks(configuration) as fireblocks:
try:
# Travel Rule - View Post-Screening Policy
api_response = fireblocks.compliance.get_post_screening_policy().result()
print("The response of ComplianceApi->get_post_screening_policy:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ComplianceApi->get_post_screening_policy: %s\n" % e)This endpoint does not need any parameter.
No authorization required
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Post-screening policy retrieved successfully. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ComplianceResultFullPayload get_screening_full_details(tx_id)
Provides all the compliance details for the given screened transaction.
Provides all the compliance details for the given screened transaction.
from fireblocks.models.compliance_result_full_payload import ComplianceResultFullPayload
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
from fireblocks.base_path import BasePath
from pprint import pprint
# load the secret key content from a file
with open('your_secret_key_file_path', 'r') as file:
secret_key_value = file.read()
# build the configuration
configuration = ClientConfiguration(
api_key="your_api_key",
secret_key=secret_key_value,
base_path=BasePath.Sandbox, # or set it directly to a string "https://sandbox-api.fireblocks.io/v1"
)
# Enter a context with an instance of the API client
with Fireblocks(configuration) as fireblocks:
tx_id = '550e8400-e29b-41d4-a716-446655440000' # str | Fireblocks transaction ID of the screened transaction
try:
# Provides all the compliance details for the given screened transaction.
api_response = fireblocks.compliance.get_screening_full_details(tx_id).result()
print("The response of ComplianceApi->get_screening_full_details:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ComplianceApi->get_screening_full_details: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| tx_id | str | Fireblocks transaction ID of the screened transaction |
No authorization required
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | A compliance object | * X-Request-ID - |
| 0 | Error Response | * X-Request-ID - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ScreeningProviderRulesConfigurationResponse get_screening_policy()
Travel Rule - View Screening Policy
Get the screening policy for Travel Rule.
from fireblocks.models.screening_provider_rules_configuration_response import ScreeningProviderRulesConfigurationResponse
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
from fireblocks.base_path import BasePath
from pprint import pprint
# load the secret key content from a file
with open('your_secret_key_file_path', 'r') as file:
secret_key_value = file.read()
# build the configuration
configuration = ClientConfiguration(
api_key="your_api_key",
secret_key=secret_key_value,
base_path=BasePath.Sandbox, # or set it directly to a string "https://sandbox-api.fireblocks.io/v1"
)
# Enter a context with an instance of the API client
with Fireblocks(configuration) as fireblocks:
try:
# Travel Rule - View Screening Policy
api_response = fireblocks.compliance.get_screening_policy().result()
print("The response of ComplianceApi->get_screening_policy:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ComplianceApi->get_screening_policy: %s\n" % e)This endpoint does not need any parameter.
ScreeningProviderRulesConfigurationResponse
No authorization required
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Screening policy retrieved successfully. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
AddressRegistryListVaultOptOutsResponse list_address_registry_vault_opt_outs(page_cursor=page_cursor, page_size=page_size, order=order)
List vault-level address registry opt-outs (paginated)
Lists vault accounts that are opted out of the address registry for this workspace. Pagination uses next and prev cursors from the response. If pageSize is omitted, 50 items are returned per page; allowed range is 1–100 per request.
from fireblocks.models.address_registry_list_vault_opt_outs_response import AddressRegistryListVaultOptOutsResponse
from fireblocks.models.address_registry_vault_list_order import AddressRegistryVaultListOrder
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
from fireblocks.base_path import BasePath
from pprint import pprint
# load the secret key content from a file
with open('your_secret_key_file_path', 'r') as file:
secret_key_value = file.read()
# build the configuration
configuration = ClientConfiguration(
api_key="your_api_key",
secret_key=secret_key_value,
base_path=BasePath.Sandbox, # or set it directly to a string "https://sandbox-api.fireblocks.io/v1"
)
# Enter a context with an instance of the API client
with Fireblocks(configuration) as fireblocks:
page_cursor = 'eyJvZmZzZXQiOjAsInBhZ2VTaXplIjoxMH0' # str | Opaque cursor from a previous response (`next` or `prev`). Omit for the first page. (optional)
page_size = 50 # int | Page size. Default **50** if omitted; must be between **1** and **100**. (optional) (default to 50)
order = VAULT_OPT_OUT_LIST_ORDER_ASC # AddressRegistryVaultListOrder | Sort direction by vault account id. Omit for ascending; use the enum value for descending. (optional) (default to VAULT_OPT_OUT_LIST_ORDER_ASC)
try:
# List vault-level address registry opt-outs (paginated)
api_response = fireblocks.compliance.list_address_registry_vault_opt_outs(page_cursor=page_cursor, page_size=page_size, order=order).result()
print("The response of ComplianceApi->list_address_registry_vault_opt_outs:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ComplianceApi->list_address_registry_vault_opt_outs: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| page_cursor | str | Opaque cursor from a previous response (`next` or `prev`). Omit for the first page. | [optional] |
| page_size | int | Page size. Default 50 if omitted; must be between 1 and 100. | [optional] [default to 50] |
| order | AddressRegistryVaultListOrder | Sort direction by vault account id. Omit for ascending; use the enum value for descending. | [optional] [default to VAULT_OPT_OUT_LIST_ORDER_ASC] |
AddressRegistryListVaultOptOutsResponse
No authorization required
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Page of vault opt-out rows | * X-Request-ID - |
| 400 | Validation error (e.g. invalid or malformed pageCursor) | * X-Request-ID - |
| 0 | Error Response | * X-Request-ID - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ListLegalEntitiesResponse list_legal_entities(vault_account_id=vault_account_id, page_cursor=page_cursor, page_size=page_size)
List legal entities (Paginated)
Returns legal entity registrations for the workspace with cursor-based pagination.
If query parameter vaultAccountId is used it returns the legal entity registration associated with a specific vault account. If no explicit mapping exists for the vault, the workspace default legal entity is returned. Returns an empty response if neither a vault mapping nor a default legal entity is configured.
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.
from fireblocks.models.list_legal_entities_response import ListLegalEntitiesResponse
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
from fireblocks.base_path import BasePath
from pprint import pprint
# load the secret key content from a file
with open('your_secret_key_file_path', 'r') as file:
secret_key_value = file.read()
# build the configuration
configuration = ClientConfiguration(
api_key="your_api_key",
secret_key=secret_key_value,
base_path=BasePath.Sandbox, # or set it directly to a string "https://sandbox-api.fireblocks.io/v1"
)
# Enter a context with an instance of the API client
with Fireblocks(configuration) as fireblocks:
vault_account_id = 'vault_account_id_example' # str | The ID of the vault account. When provided, returns the legal entity associated with that vault account and pagination parameters are ignored. (optional)
page_cursor = 'page_cursor_example' # str | Cursor string returned in `next` or `prev` of a previous response. Ignored when `vaultAccountId` is provided. (optional)
page_size = 50 # int | Maximum number of registrations to return. Ignored when `vaultAccountId` is provided. (optional) (default to 50)
try:
# List legal entities (Paginated)
api_response = fireblocks.compliance.list_legal_entities(vault_account_id=vault_account_id, page_cursor=page_cursor, page_size=page_size).result()
print("The response of ComplianceApi->list_legal_entities:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ComplianceApi->list_legal_entities: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| vault_account_id | str | The ID of the vault account. When provided, returns the legal entity associated with that vault account and pagination parameters are ignored. | [optional] |
| page_cursor | str | Cursor string returned in `next` or `prev` of a previous response. Ignored when `vaultAccountId` is provided. | [optional] |
| page_size | int | Maximum number of registrations to return. Ignored when `vaultAccountId` is provided. | [optional] [default to 50] |
No authorization required
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | A paginated list of legal entity registrations. When `vaultAccountId` is provided, `data` contains at most one item. | * X-Request-ID - |
| 0 | Error Response | * X-Request-ID - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ListVaultsForRegistrationResponse list_vaults_for_legal_entity(legal_entity_id, page_cursor=page_cursor, page_size=page_size)
List vault accounts for a legal entity (Paginated)
Returns vault account IDs explicitly assigned to a specific legal entity registration, with cursor-based pagination.
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.
from fireblocks.models.list_vaults_for_registration_response import ListVaultsForRegistrationResponse
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
from fireblocks.base_path import BasePath
from pprint import pprint
# load the secret key content from a file
with open('your_secret_key_file_path', 'r') as file:
secret_key_value = file.read()
# build the configuration
configuration = ClientConfiguration(
api_key="your_api_key",
secret_key=secret_key_value,
base_path=BasePath.Sandbox, # or set it directly to a string "https://sandbox-api.fireblocks.io/v1"
)
# Enter a context with an instance of the API client
with Fireblocks(configuration) as fireblocks:
legal_entity_id = 'legal_entity_id_example' # str | The unique ID of the legal entity registration
page_cursor = 'page_cursor_example' # str | Cursor string returned in `next` or `prev` of a previous response (optional)
page_size = 50 # int | Maximum number of registrations to return (optional) (default to 50)
try:
# List vault accounts for a legal entity (Paginated)
api_response = fireblocks.compliance.list_vaults_for_legal_entity(legal_entity_id, page_cursor=page_cursor, page_size=page_size).result()
print("The response of ComplianceApi->list_vaults_for_legal_entity:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ComplianceApi->list_vaults_for_legal_entity: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| legal_entity_id | str | The unique ID of the legal entity registration | |
| page_cursor | str | Cursor string returned in `next` or `prev` of a previous response | [optional] |
| page_size | int | Maximum number of registrations to return | [optional] [default to 50] |
ListVaultsForRegistrationResponse
No authorization required
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Paginated list of vault account IDs assigned to the legal entity | * X-Request-ID - |
| 404 | Legal entity registration not found | * X-Request-ID - |
| 0 | Error Response | * X-Request-ID - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
AddressRegistryTenantRegistryResponse opt_in_address_registry_tenant(idempotency_key=idempotency_key)
Opt the workspace in to the address registry
Opts the workspace in. No request body. Response uses the same JSON shape as GET; status is OPTED_IN.
from fireblocks.models.address_registry_tenant_registry_response import AddressRegistryTenantRegistryResponse
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
from fireblocks.base_path import BasePath
from pprint import pprint
# load the secret key content from a file
with open('your_secret_key_file_path', 'r') as file:
secret_key_value = file.read()
# build the configuration
configuration = ClientConfiguration(
api_key="your_api_key",
secret_key=secret_key_value,
base_path=BasePath.Sandbox, # or set it directly to a string "https://sandbox-api.fireblocks.io/v1"
)
# Enter a context with an instance of the API client
with Fireblocks(configuration) as fireblocks:
idempotency_key = 'idempotency_key_example' # str | 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)
try:
# Opt the workspace in to the address registry
api_response = fireblocks.compliance.opt_in_address_registry_tenant(idempotency_key=idempotency_key).result()
print("The response of ComplianceApi->opt_in_address_registry_tenant:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ComplianceApi->opt_in_address_registry_tenant: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| idempotency_key | str | 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] |
AddressRegistryTenantRegistryResponse
No authorization required
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Success; response body includes status OPTED_IN | * X-Request-ID - |
| 0 | Error Response | * X-Request-ID - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
AddressRegistryTenantRegistryResponse opt_out_address_registry_tenant()
Opt the workspace out of the address registry
Opts the workspace out. No request body. Response uses the same JSON shape as GET; status is OPTED_OUT.
from fireblocks.models.address_registry_tenant_registry_response import AddressRegistryTenantRegistryResponse
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
from fireblocks.base_path import BasePath
from pprint import pprint
# load the secret key content from a file
with open('your_secret_key_file_path', 'r') as file:
secret_key_value = file.read()
# build the configuration
configuration = ClientConfiguration(
api_key="your_api_key",
secret_key=secret_key_value,
base_path=BasePath.Sandbox, # or set it directly to a string "https://sandbox-api.fireblocks.io/v1"
)
# Enter a context with an instance of the API client
with Fireblocks(configuration) as fireblocks:
try:
# Opt the workspace out of the address registry
api_response = fireblocks.compliance.opt_out_address_registry_tenant().result()
print("The response of ComplianceApi->opt_out_address_registry_tenant:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ComplianceApi->opt_out_address_registry_tenant: %s\n" % e)This endpoint does not need any parameter.
AddressRegistryTenantRegistryResponse
No authorization required
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Success; response body includes status OPTED_OUT | * X-Request-ID - |
| 0 | Error Response | * X-Request-ID - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
LegalEntityRegistration register_legal_entity(register_legal_entity_request, idempotency_key=idempotency_key)
Register a new legal entity
Registers a new legal entity for the workspace using its LEI (Legal Entity Identifier) code. The LEI is validated against the GLEIF registry. Each workspace can register multiple legal entities.
Endpoint Permission: Admin, Non-Signing Admin.
from fireblocks.models.legal_entity_registration import LegalEntityRegistration
from fireblocks.models.register_legal_entity_request import RegisterLegalEntityRequest
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
from fireblocks.base_path import BasePath
from pprint import pprint
# load the secret key content from a file
with open('your_secret_key_file_path', 'r') as file:
secret_key_value = file.read()
# build the configuration
configuration = ClientConfiguration(
api_key="your_api_key",
secret_key=secret_key_value,
base_path=BasePath.Sandbox, # or set it directly to a string "https://sandbox-api.fireblocks.io/v1"
)
# Enter a context with an instance of the API client
with Fireblocks(configuration) as fireblocks:
register_legal_entity_request = fireblocks.RegisterLegalEntityRequest() # RegisterLegalEntityRequest |
idempotency_key = 'idempotency_key_example' # str | 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)
try:
# Register a new legal entity
api_response = fireblocks.compliance.register_legal_entity(register_legal_entity_request, idempotency_key=idempotency_key).result()
print("The response of ComplianceApi->register_legal_entity:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ComplianceApi->register_legal_entity: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| register_legal_entity_request | RegisterLegalEntityRequest | ||
| idempotency_key | str | 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] |
No authorization required
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 201 | Legal entity registered successfully | * X-Request-ID - |
| 400 | Invalid LEI or request parameters | * X-Request-ID - |
| 404 | LEI not found in the GLEIF registry | * X-Request-ID - |
| 409 | A legal entity with this LEI is already registered for the workspace | * X-Request-ID - |
| 500 | Internal Server Error | * X-Request-ID - |
| 0 | Error Response | * X-Request-ID - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
AddressRegistryRemoveVaultOptOutResponse remove_address_registry_vault_opt_out(vault_account_id)
Remove a single vault account from the address registry opt-out list
Removes this vault account id from the workspace opt-out list if it is present; otherwise the call still succeeds. Response body matches GET (optedOut is false after success). To clear the whole list, use DELETE /v1/address_registry/vaults.
from fireblocks.models.address_registry_remove_vault_opt_out_response import AddressRegistryRemoveVaultOptOutResponse
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
from fireblocks.base_path import BasePath
from pprint import pprint
# load the secret key content from a file
with open('your_secret_key_file_path', 'r') as file:
secret_key_value = file.read()
# build the configuration
configuration = ClientConfiguration(
api_key="your_api_key",
secret_key=secret_key_value,
base_path=BasePath.Sandbox, # or set it directly to a string "https://sandbox-api.fireblocks.io/v1"
)
# Enter a context with an instance of the API client
with Fireblocks(configuration) as fireblocks:
vault_account_id = 10001 # int | Vault account id (non-negative integer).
try:
# Remove a single vault account from the address registry opt-out list
api_response = fireblocks.compliance.remove_address_registry_vault_opt_out(vault_account_id).result()
print("The response of ComplianceApi->remove_address_registry_vault_opt_out:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ComplianceApi->remove_address_registry_vault_opt_out: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| vault_account_id | int | Vault account id (non-negative integer). |
AddressRegistryRemoveVaultOptOutResponse
No authorization required
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Success; `optedOut` is false (list entry removed if it existed) | * X-Request-ID - |
| 400 | Invalid path parameter (e.g. negative or out-of-range vault account id) | * X-Request-ID - |
| 0 | Error Response | * X-Request-ID - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
AddressRegistryRemoveAllVaultOptOutsResponse remove_all_address_registry_vault_opt_outs()
Remove all vault-level address registry opt-outs for the workspace
Removes all vault accounts from the workspace opt-out list.
from fireblocks.models.address_registry_remove_all_vault_opt_outs_response import AddressRegistryRemoveAllVaultOptOutsResponse
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
from fireblocks.base_path import BasePath
from pprint import pprint
# load the secret key content from a file
with open('your_secret_key_file_path', 'r') as file:
secret_key_value = file.read()
# build the configuration
configuration = ClientConfiguration(
api_key="your_api_key",
secret_key=secret_key_value,
base_path=BasePath.Sandbox, # or set it directly to a string "https://sandbox-api.fireblocks.io/v1"
)
# Enter a context with an instance of the API client
with Fireblocks(configuration) as fireblocks:
try:
# Remove all vault-level address registry opt-outs for the workspace
api_response = fireblocks.compliance.remove_all_address_registry_vault_opt_outs().result()
print("The response of ComplianceApi->remove_all_address_registry_vault_opt_outs:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ComplianceApi->remove_all_address_registry_vault_opt_outs: %s\n" % e)This endpoint does not need any parameter.
AddressRegistryRemoveAllVaultOptOutsResponse
No authorization required
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | All opt-outs cleared; response body includes `removedCount`. | * X-Request-ID - |
| 0 | Error Response | * X-Request-ID - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CreateTransactionResponse retry_rejected_transaction_bypass_screening_checks(tx_id, idempotency_key=idempotency_key)
Calling the "Bypass Screening Policy" API endpoint triggers a new transaction, with the API user as the initiator, bypassing the screening policy check
This endpoint is restricted to Admin API users and is only applicable to outgoing transactions.
from fireblocks.models.create_transaction_response import CreateTransactionResponse
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
from fireblocks.base_path import BasePath
from pprint import pprint
# load the secret key content from a file
with open('your_secret_key_file_path', 'r') as file:
secret_key_value = file.read()
# build the configuration
configuration = ClientConfiguration(
api_key="your_api_key",
secret_key=secret_key_value,
base_path=BasePath.Sandbox, # or set it directly to a string "https://sandbox-api.fireblocks.io/v1"
)
# Enter a context with an instance of the API client
with Fireblocks(configuration) as fireblocks:
tx_id = '550e8400-e29b-41d4-a716-446655440000' # str | The transaction id that was rejected by screening checks
idempotency_key = 'idempotency_key_example' # str | 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)
try:
# Calling the \"Bypass Screening Policy\" API endpoint triggers a new transaction, with the API user as the initiator, bypassing the screening policy check
api_response = fireblocks.compliance.retry_rejected_transaction_bypass_screening_checks(tx_id, idempotency_key=idempotency_key).result()
print("The response of ComplianceApi->retry_rejected_transaction_bypass_screening_checks:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ComplianceApi->retry_rejected_transaction_bypass_screening_checks: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| tx_id | str | The transaction id that was rejected by screening checks | |
| idempotency_key | str | 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] |
No authorization required
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 201 | A transaction object | * X-Request-ID - |
| 0 | Error Response | * X-Request-ID - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
AmlVerdictManualResponse set_aml_verdict(aml_verdict_manual_request, idempotency_key=idempotency_key)
Set AML Verdict (BYORK Super Light)
Set AML verdict for incoming transactions when BYORK Super Light (Manual Screening Verdict) is enabled. This endpoint is for Super Light only. For BYORK Light, use POST /screening/byork/verdict instead. When Super Light is retired, this endpoint will be deprecated; use the BYORK Light verdict API for new integrations.
from fireblocks.models.aml_verdict_manual_request import AmlVerdictManualRequest
from fireblocks.models.aml_verdict_manual_response import AmlVerdictManualResponse
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
from fireblocks.base_path import BasePath
from pprint import pprint
# load the secret key content from a file
with open('your_secret_key_file_path', 'r') as file:
secret_key_value = file.read()
# build the configuration
configuration = ClientConfiguration(
api_key="your_api_key",
secret_key=secret_key_value,
base_path=BasePath.Sandbox, # or set it directly to a string "https://sandbox-api.fireblocks.io/v1"
)
# Enter a context with an instance of the API client
with Fireblocks(configuration) as fireblocks:
aml_verdict_manual_request = fireblocks.AmlVerdictManualRequest() # AmlVerdictManualRequest |
idempotency_key = 'idempotency_key_example' # str | 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)
try:
# Set AML Verdict (BYORK Super Light)
api_response = fireblocks.compliance.set_aml_verdict(aml_verdict_manual_request, idempotency_key=idempotency_key).result()
print("The response of ComplianceApi->set_aml_verdict:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ComplianceApi->set_aml_verdict: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| aml_verdict_manual_request | AmlVerdictManualRequest | ||
| idempotency_key | str | 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] |
No authorization required
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | AML verdict set successfully. | - |
| 400 | Feature not enabled for tenant. | * X-Request-ID - |
| 425 | Too Early - transaction not yet in pending screening. | * X-Request-ID - |
| 500 | Internal server error. | * X-Request-ID - |
| 0 | Error Response | * X-Request-ID - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ByorkConfigResponse set_byork_timeouts(byork_set_timeouts_request, idempotency_key=idempotency_key)
Set BYORK Light timeouts
Updates timeout values for BYORK wait-for-response (incoming and/or outgoing). At least one of incomingTimeoutSeconds or outgoingTimeoutSeconds is required. Values must be within the ranges returned in GET config (timeoutRangeIncoming for incomingTimeoutSeconds, timeoutRangeOutgoing for outgoingTimeoutSeconds). Requires BYORK Light to be enabled for the tenant (contact your CSM to enable).
from fireblocks.models.byork_config_response import ByorkConfigResponse
from fireblocks.models.byork_set_timeouts_request import ByorkSetTimeoutsRequest
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
from fireblocks.base_path import BasePath
from pprint import pprint
# load the secret key content from a file
with open('your_secret_key_file_path', 'r') as file:
secret_key_value = file.read()
# build the configuration
configuration = ClientConfiguration(
api_key="your_api_key",
secret_key=secret_key_value,
base_path=BasePath.Sandbox, # or set it directly to a string "https://sandbox-api.fireblocks.io/v1"
)
# Enter a context with an instance of the API client
with Fireblocks(configuration) as fireblocks:
byork_set_timeouts_request = fireblocks.ByorkSetTimeoutsRequest() # ByorkSetTimeoutsRequest |
idempotency_key = 'idempotency_key_example' # str | 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)
try:
# Set BYORK Light timeouts
api_response = fireblocks.compliance.set_byork_timeouts(byork_set_timeouts_request, idempotency_key=idempotency_key).result()
print("The response of ComplianceApi->set_byork_timeouts:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ComplianceApi->set_byork_timeouts: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| byork_set_timeouts_request | ByorkSetTimeoutsRequest | ||
| idempotency_key | str | 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] |
No authorization required
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Timeouts updated. | * X-Request-ID - |
| 400 | BYORK Light not enabled, or timeout value out of range, or missing both timeouts. | * X-Request-ID - |
| 0 | Error Response | * X-Request-ID - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ByorkVerdictResponse set_byork_verdict(byork_verdict_request, idempotency_key=idempotency_key)
Set BYORK Light verdict
Submit verdict (ACCEPT or REJECT) for a transaction in the BYORK Light flow. If the transaction is awaiting your decision, the verdict is applied immediately (response status COMPLETED). If processing has not yet reached that point, the verdict is stored and applied when it does (response status PRE_ACCEPTED). Requires BYORK Light to be enabled for the tenant.
from fireblocks.models.byork_verdict_request import ByorkVerdictRequest
from fireblocks.models.byork_verdict_response import ByorkVerdictResponse
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
from fireblocks.base_path import BasePath
from pprint import pprint
# load the secret key content from a file
with open('your_secret_key_file_path', 'r') as file:
secret_key_value = file.read()
# build the configuration
configuration = ClientConfiguration(
api_key="your_api_key",
secret_key=secret_key_value,
base_path=BasePath.Sandbox, # or set it directly to a string "https://sandbox-api.fireblocks.io/v1"
)
# Enter a context with an instance of the API client
with Fireblocks(configuration) as fireblocks:
byork_verdict_request = fireblocks.ByorkVerdictRequest() # ByorkVerdictRequest |
idempotency_key = 'idempotency_key_example' # str | 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)
try:
# Set BYORK Light verdict
api_response = fireblocks.compliance.set_byork_verdict(byork_verdict_request, idempotency_key=idempotency_key).result()
print("The response of ComplianceApi->set_byork_verdict:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ComplianceApi->set_byork_verdict: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| byork_verdict_request | ByorkVerdictRequest | ||
| idempotency_key | str | 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] |
No authorization required
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Verdict applied (COMPLETED) or pre-accepted (PRE_ACCEPTED). | * X-Request-ID - |
| 400 | BYORK Light not enabled for tenant or invalid verdict. | * X-Request-ID - |
| 409 | BYORK decision already final, screening already completed, or state inconsistent. | * X-Request-ID - |
| 425 | Too Early - transaction not found (screening not started yet). | * X-Request-ID - |
| 500 | Internal server error. | * X-Request-ID - |
| 0 | Error Response | * X-Request-ID - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ScreeningConfigurationsRequest update_aml_screening_configuration(idempotency_key=idempotency_key)
Update AML Configuration
Updates bypass screening, inbound delay, or outbound delay configurations for AML.
from fireblocks.models.screening_configurations_request import ScreeningConfigurationsRequest
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
from fireblocks.base_path import BasePath
from pprint import pprint
# load the secret key content from a file
with open('your_secret_key_file_path', 'r') as file:
secret_key_value = file.read()
# build the configuration
configuration = ClientConfiguration(
api_key="your_api_key",
secret_key=secret_key_value,
base_path=BasePath.Sandbox, # or set it directly to a string "https://sandbox-api.fireblocks.io/v1"
)
# Enter a context with an instance of the API client
with Fireblocks(configuration) as fireblocks:
idempotency_key = 'idempotency_key_example' # str | 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)
try:
# Update AML Configuration
api_response = fireblocks.compliance.update_aml_screening_configuration(idempotency_key=idempotency_key).result()
print("The response of ComplianceApi->update_aml_screening_configuration:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ComplianceApi->update_aml_screening_configuration: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| idempotency_key | str | 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] |
ScreeningConfigurationsRequest
No authorization required
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Configuration updated successfully. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
LegalEntityRegistration update_legal_entity(legal_entity_id, update_legal_entity_request, idempotency_key=idempotency_key)
Update legal entity
Updates the status of a legal entity registration. Setting isDefault to true marks the registration as the workspace default, which is applied to vault accounts that have no explicit legal entity mapping.
Endpoint Permission: Admin, Non-Signing Admin.
from fireblocks.models.legal_entity_registration import LegalEntityRegistration
from fireblocks.models.update_legal_entity_request import UpdateLegalEntityRequest
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
from fireblocks.base_path import BasePath
from pprint import pprint
# load the secret key content from a file
with open('your_secret_key_file_path', 'r') as file:
secret_key_value = file.read()
# build the configuration
configuration = ClientConfiguration(
api_key="your_api_key",
secret_key=secret_key_value,
base_path=BasePath.Sandbox, # or set it directly to a string "https://sandbox-api.fireblocks.io/v1"
)
# Enter a context with an instance of the API client
with Fireblocks(configuration) as fireblocks:
legal_entity_id = 'legal_entity_id_example' # str | The unique ID of the legal entity registration
update_legal_entity_request = fireblocks.UpdateLegalEntityRequest() # UpdateLegalEntityRequest |
idempotency_key = 'idempotency_key_example' # str | 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)
try:
# Update legal entity
api_response = fireblocks.compliance.update_legal_entity(legal_entity_id, update_legal_entity_request, idempotency_key=idempotency_key).result()
print("The response of ComplianceApi->update_legal_entity:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ComplianceApi->update_legal_entity: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| legal_entity_id | str | The unique ID of the legal entity registration | |
| update_legal_entity_request | UpdateLegalEntityRequest | ||
| idempotency_key | str | 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] |
No authorization required
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Updated legal entity registration | * X-Request-ID - |
| 400 | Registration is not in APPROVED status | * X-Request-ID - |
| 404 | Legal entity registration not found | * X-Request-ID - |
| 0 | Error Response | * X-Request-ID - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ScreeningUpdateConfigurations update_screening_configuration(screening_update_configurations, idempotency_key=idempotency_key)
Tenant - Screening Configuration
Update tenant screening configuration.
from fireblocks.models.screening_update_configurations import ScreeningUpdateConfigurations
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
from fireblocks.base_path import BasePath
from pprint import pprint
# load the secret key content from a file
with open('your_secret_key_file_path', 'r') as file:
secret_key_value = file.read()
# build the configuration
configuration = ClientConfiguration(
api_key="your_api_key",
secret_key=secret_key_value,
base_path=BasePath.Sandbox, # or set it directly to a string "https://sandbox-api.fireblocks.io/v1"
)
# Enter a context with an instance of the API client
with Fireblocks(configuration) as fireblocks:
screening_update_configurations = fireblocks.ScreeningUpdateConfigurations() # ScreeningUpdateConfigurations |
idempotency_key = 'idempotency_key_example' # str | 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)
try:
# Tenant - Screening Configuration
api_response = fireblocks.compliance.update_screening_configuration(screening_update_configurations, idempotency_key=idempotency_key).result()
print("The response of ComplianceApi->update_screening_configuration:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ComplianceApi->update_screening_configuration: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| screening_update_configurations | ScreeningUpdateConfigurations | ||
| idempotency_key | str | 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] |
No authorization required
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Tenant Screening configuration updated successfully. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ScreeningConfigurationsRequest update_travel_rule_config(idempotency_key=idempotency_key)
Update Travel Rule Configuration
Updates bypass screening, inbound delay, or outbound delay configurations for Travel Rule.
from fireblocks.models.screening_configurations_request import ScreeningConfigurationsRequest
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
from fireblocks.base_path import BasePath
from pprint import pprint
# load the secret key content from a file
with open('your_secret_key_file_path', 'r') as file:
secret_key_value = file.read()
# build the configuration
configuration = ClientConfiguration(
api_key="your_api_key",
secret_key=secret_key_value,
base_path=BasePath.Sandbox, # or set it directly to a string "https://sandbox-api.fireblocks.io/v1"
)
# Enter a context with an instance of the API client
with Fireblocks(configuration) as fireblocks:
idempotency_key = 'idempotency_key_example' # str | 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)
try:
# Update Travel Rule Configuration
api_response = fireblocks.compliance.update_travel_rule_config(idempotency_key=idempotency_key).result()
print("The response of ComplianceApi->update_travel_rule_config:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ComplianceApi->update_travel_rule_config: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| idempotency_key | str | 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] |
ScreeningConfigurationsRequest
No authorization required
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Configuration updated successfully. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]