---
title: "Push Transaction"
method: POST
path: "/api/v1/transactions/{id}/push"
tags: ["Transactions"]
---
# Push Transaction
`POST /api/v1/transactions/{id}/push`
Push an existing signed transaction to the chain. The transaction must
have been previously created with a `push_mode: manual` flag and must now
be in state `signed`.
## Path parameters
- `id` string, uuid, required — ID of the transaction to be pushed to chain.
## Request body
- PushTransactionRequest
- `push_data` CosmosPushData
- `type` 'cosmos_transaction', required — The type of the transaction.
- `transaction_body` string — The byte sequence of the serialized signed transaction to be sent to the chain.
## Response `200`
Successful Response
- union
- AptosMessage
- `id` string, uuid, required — The unique identifier of the object in the Fordefi platform.
- `created_at` string, date-time, required — The date and time when the object was created.
- `modified_at` string, date-time, required — The date and time when the object was last modified. Any change to any field of the resource is considered a modification.
- `managed_transaction_data` ManagedTransactionData
- `created_by` union, required — Represents a reference to a user in the Fordefi platform
- PersonRef
- `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
- `user_type` 'person', required — The type of user. Can be a person, or (in programmatic scenarios) an API user or API Signer.
- `name` string — The name of the user.
- `email` string, required — The email of the user.
- `state` 'active' | 'onboarding_pending_code_generation' | 'onboarding_pending_activation' | 'reset_device_pending_code_generation' | 'reset_device_pending_activation' | 'pending_approval' | 'deleted', required
- `role` 'admin' | 'trader' | 'viewer', required
- ApiUserRef
- `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
- `user_type` 'api_user', required — The type of the user.
- `name` string, required — The name of the user.
- `state` 'active' | 'deleted', required — The state of the user.
- `role` 'admin' | 'trader' | 'viewer', required
- ApiSignerRef
- `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
- `user_type` 'api_signer', required — The type of the user.
- `name` string, required — The name of the user.
- `state` 'active' | 'onboarding_pending_code_generation' | 'onboarding_pending_activation' | 'deleted', required — The state of the user.
- EndUserRef
- `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
- `user_type` 'end_user', required — The type of the user.
- `external_id` string, required — External id of the user.
- `state` 'active' | 'deleted', required — The state of the user.
- SystemUserRef
- `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
- `user_type` 'system', required — The type of the user.
- `name` string, required — The name is Fordefi CARE
- `aborted_by` union — Represents a reference to a user in the Fordefi platform
- PersonRef
- `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
- `user_type` 'person', required — The type of user. Can be a person, or (in programmatic scenarios) an API user or API Signer.
- `name` string — The name of the user.
- `email` string, required — The email of the user.
- `state` 'active' | 'onboarding_pending_code_generation' | 'onboarding_pending_activation' | 'reset_device_pending_code_generation' | 'reset_device_pending_activation' | 'pending_approval' | 'deleted', required
- `role` 'admin' | 'trader' | 'viewer', required
- ApiUserRef
- `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
- `user_type` 'api_user', required — The type of the user.
- `name` string, required — The name of the user.
- `state` 'active' | 'deleted', required — The state of the user.
- `role` 'admin' | 'trader' | 'viewer', required
- ApiSignerRef
- `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
- `user_type` 'api_signer', required — The type of the user.
- `name` string, required — The name of the user.
- `state` 'active' | 'onboarding_pending_code_generation' | 'onboarding_pending_activation' | 'deleted', required — The state of the user.
- EndUserRef
- `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
- `user_type` 'end_user', required — The type of the user.
- `external_id` string, required — External id of the user.
- `state` 'active' | 'deleted', required — The state of the user.
- SystemUserRef
- `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
- `user_type` 'system', required — The type of the user.
- `name` string, required — The name is Fordefi CARE
- `finalized_for_signing_by` union — Represents a reference to a user in the Fordefi platform
- PersonRef
- `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
- `user_type` 'person', required — The type of user. Can be a person, or (in programmatic scenarios) an API user or API Signer.
- `name` string — The name of the user.
- `email` string, required — The email of the user.
- `state` 'active' | 'onboarding_pending_code_generation' | 'onboarding_pending_activation' | 'reset_device_pending_code_generation' | 'reset_device_pending_activation' | 'pending_approval' | 'deleted', required
- `role` 'admin' | 'trader' | 'viewer', required
- ApiUserRef
- `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
- `user_type` 'api_user', required — The type of the user.
- `name` string, required — The name of the user.
- `state` 'active' | 'deleted', required — The state of the user.
- `role` 'admin' | 'trader' | 'viewer', required
- ApiSignerRef
- `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
- `user_type` 'api_signer', required — The type of the user.
- `name` string, required — The name of the user.
- `state` 'active' | 'onboarding_pending_code_generation' | 'onboarding_pending_activation' | 'deleted', required — The state of the user.
- EndUserRef
- `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
- `user_type` 'end_user', required — The type of the user.
- `external_id` string, required — External id of the user.
- `state` 'active' | 'deleted', required — The state of the user.
- SystemUserRef
- `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
- `user_type` 'system', required — The type of the user.
- `name` string, required — The name is Fordefi CARE
- `device_signing_request` ActionSigningRequest — Represents a device sign request for an action in the Foredefi platform
- `created_by` union, required — Represents a reference to a user in the Fordefi platform
- PersonRef
- `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
- `user_type` 'person', required — The type of user. Can be a person, or (in programmatic scenarios) an API user or API Signer.
- `name` string — The name of the user.
- `email` string, required — The email of the user.
- `state` 'active' | 'onboarding_pending_code_generation' | 'onboarding_pending_activation' | 'reset_device_pending_code_generation' | 'reset_device_pending_activation' | 'pending_approval' | 'deleted', required
- `role` 'admin' | 'trader' | 'viewer', required
- ApiUserRef
- `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
- `user_type` 'api_user', required — The type of the user.
- `name` string, required — The name of the user.
- `state` 'active' | 'deleted', required — The state of the user.
- `role` 'admin' | 'trader' | 'viewer', required
- ApiSignerRef
- `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
- `user_type` 'api_signer', required — The type of the user.
- `name` string, required — The name of the user.
- `state` 'active' | 'onboarding_pending_code_generation' | 'onboarding_pending_activation' | 'deleted', required — The state of the user.
- EndUserRef
- `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
- `user_type` 'end_user', required — The type of the user.
- `external_id` string, required — External id of the user.
- `state` 'active' | 'deleted', required — The state of the user.
- SystemUserRef
- `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
- `user_type` 'system', required — The type of the user.
- `name` string, required — The name is Fordefi CARE
- `signers` ActionSigner[], required — A list of required signers. A signer can be a person or an API Signer.
- `user` union, required — Represents a reference to a user in the Fordefi platform
- PersonRef
- …
- ApiUserRef
- …
- ApiSignerRef
- …
- EndUserRef
- …
- SystemUserRef
- …
- `modified_at` string, date-time, required — When the signer received/signed the action
- `has_signed` boolean, required — Whether the signer signed the action
- `approval_request` ApprovalRequest — Represents an approval request for an action in the Fordefi platform
- `state` 'created' | 'approved' | 'insufficient_approvers' | 'auto_approved' | 'failed', required — Represents the whole approval request state
- `required_groups` integer, required — The number of required approval groups.
- `approval_groups` ApprovalRequestGroup[], required — A list of the possible approvers from different groups.
- `quorum_size` integer, required — The number of approvers required to approve the transaction.
- `approvers` RequestApprover[], required — A list of the possible approvers.
- `user` union, required
- …
- `modified_at` string, date-time, required — The date and time when this approval was modified.
- `decision` string — The decision of the approver.
- `state` 'pending' | 'approved' | 'unauthorized' | 'not_participated', required — Represents an approval state of a single approver
- `error_message` string — The error message if the request failed.
- `aml_policy_match` AmlPolicyMatchOutgoing
- `is_default` boolean, required — `True` if this is the default rule, `False` otherwise.
- `rule_id` string, uuid, required — The unique identifier of the rule.
- `rule_name` string, required — The name of the rule.
- `action_type` 'allow' | 'block' | 'require_approval' | 'skip', required
- `policy_match` PolicyMatch
- `is_default` boolean, required — `True` if this is the default rule, `False` otherwise.
- `rule_id` string, uuid, required — The unique identifier of the rule.
- `rule_name` string, required — The name of the rule.
- `action_type` 'allow' | 'block' | 'require_approval', required
- `signer_type` 'initiator' | 'api_signer' | 'end_user' | 'multiple_signers' | 'api_user', required
- `risks` TransactionRisk[], required — The list of risks associated with this transaction.
- `type` 'transfer_to_erc20_contract' | 'organization_not_interacted_with_address' | 'vault_not_interacted_with_address' | 'allowance_to_eoa' | 'unlimited_allowance' | 'contract_not_verified' | 'bridge_dest_differ_from_sender' | 'nft_approve_for_all' | 'missing_simulation' | 'unsupported_simulation' | 'post_conditions_allow_mode' | 'safe_sensitive_operation', required
- `severity` 'low' | 'medium' | 'high', required
- `title` string, required — The title of the risk.
- `description` string, required — A detailed description of the risk.
- `error_pushing_to_blockchain_message` string — The translated error message received from the node if it was rejected by it.
- `original_error_pushing_to_blockchain_message` string — The error message received from the node if it was rejected by it.
- `vault` VaultRef, required — Represents a reference to a vault in the Fordefi platform
- `id` string, uuid, required — The unique identifier of the vault in the Fordefi platform.
- `vault_group_id` string, uuid — The unique identifier of the vault group this vault belongs to.
- `vault_group_ids` string[], required — The unique identifiers of the vault groups this vault belongs to.
- `name` string, required — The name of the vault.
- `address` string — The address of the vault.
- `state` 'active' | 'archived' | 'deleted' | 'pending' | 'aborted', required
- `type` 'aptos' | 'arch' | 'black_box' | 'canton' | 'cosmos' | 'evm' | 'safe' | 'solana' | 'stacks' | 'starknet' | 'stellar' | 'sui' | 'ton' | 'tron' | 'utxo' | 'exchange', required
- `logo_url` string, uri — The logo of the vault. Supported for exchange and Safe vaults.
- `end_user` EndUserRef
- `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
- `user_type` 'end_user', required — The type of the user.
- `external_id` string, required — External id of the user.
- `state` 'active' | 'deleted', required — The state of the user.
- `is_external_signer` boolean — Whether the vault uses an externally imported key (external signer).
- `idempotence_id` string, uuid — Optional idempotence ID of a transaction.
- `has_current_user_vault_permissions` boolean, required — Does current user have permissions to the origin vault according to its vault group permissions.
- `batch_data` BatchData
- `batch_id` string, uuid, required — The unique identifier of the batch.
- `index_in_batch` integer, required — Index of transaction in the batch.
- `batch_size` integer, required — The number of transactions in the batch.
- `matched_policies` PolicyMatch[], required — List of policies matched by this message.
- `is_default` boolean, required — `True` if this is the default rule, `False` otherwise.
- `rule_id` string, uuid, required — The unique identifier of the rule.
- `rule_name` string, required — The name of the rule.
- `action_type` 'allow' | 'block' | 'require_approval', required
- `push_mode` 'auto' | 'manual' | 'deferred'
- `last_pushed_at` string, date-time — The last time the transaction was pushed to the node.
- `sign_mode` 'auto' | 'triggered'
- `fee_paid_by` FeePaidByVault
- `type` 'vault', required — The type of fee payer.
- `vault` VaultRef, required — Represents a reference to a vault in the Fordefi platform
- `id` string, uuid, required — The unique identifier of the vault in the Fordefi platform.
- `vault_group_id` string, uuid — The unique identifier of the vault group this vault belongs to.
- `vault_group_ids` string[], required — The unique identifiers of the vault groups this vault belongs to.
- `name` string, required — The name of the vault.
- `address` string — The address of the vault.
- `state` 'active' | 'archived' | 'deleted' | 'pending' | 'aborted', required
- `type` 'aptos' | 'arch' | 'black_box' | 'canton' | 'cosmos' | 'evm' | 'safe' | 'solana' | 'stacks' | 'starknet' | 'stellar' | 'sui' | 'ton' | 'tron' | 'utxo' | 'exchange', required
- `logo_url` string, uri — The logo of the vault. Supported for exchange and Safe vaults.
- `end_user` EndUserRef
- `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
- `user_type` 'end_user', required — The type of the user.
- `external_id` string, required — External id of the user.
- `state` 'active' | 'deleted', required — The state of the user.
- `is_external_signer` boolean — Whether the vault uses an externally imported key (external signer).
- `attested_payload_for_signing` string — JWS attestation for the payload (external signer). Set after finalize-for-signing.
- `tx_policy_explanation_id` string, uuid — The id of the transaction policy explanation produced for this transaction, if any.
- `signatures` Signature[], required — The transaction signatures.
- `data` string, required — Signature on the transaction, encoded in base64 format.
- `signed_by` union — The user who created this signature, `null` if the signature wasn't created by a Fordefi user.
- PersonRef
- `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
- `user_type` 'person', required — The type of user. Can be a person, or (in programmatic scenarios) an API user or API Signer.
- `name` string — The name of the user.
- `email` string, required — The email of the user.
- `state` 'active' | 'onboarding_pending_code_generation' | 'onboarding_pending_activation' | 'reset_device_pending_code_generation' | 'reset_device_pending_activation' | 'pending_approval' | 'deleted', required
- `role` 'admin' | 'trader' | 'viewer', required
- ApiSignerRef
- `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
- `user_type` 'api_signer', required — The type of the user.
- `name` string, required — The name of the user.
- `state` 'active' | 'onboarding_pending_code_generation' | 'onboarding_pending_activation' | 'deleted', required — The state of the user.
- EndUserRef
- `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
- `user_type` 'end_user', required — The type of the user.
- `external_id` string, required — External id of the user.
- `state` 'active' | 'deleted', required — The state of the user.
- ApiUserRef
- `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
- `user_type` 'api_user', required — The type of the user.
- `name` string, required — The name of the user.
- `state` 'active' | 'deleted', required — The state of the user.
- `role` 'admin' | 'trader' | 'viewer', required
- `note` string — An optional transaction note.
- `spam_state` 'unset' | 'manually_set' | 'automatically_set'
- `direction` 'outgoing' | 'incoming', required
- `signed_externally` boolean — Whether the transaction was signed by an external user (for example in case of imported vault).
- `interacted_vaults` VaultRef[], required — The vaults that interacted with the transaction.
- `id` string, uuid, required — The unique identifier of the vault in the Fordefi platform.
- `vault_group_id` string, uuid — The unique identifier of the vault group this vault belongs to.
- `vault_group_ids` string[], required — The unique identifiers of the vault groups this vault belongs to.
- `name` string, required — The name of the vault.
- `address` string — The address of the vault.
- `state` 'active' | 'archived' | 'deleted' | 'pending' | 'aborted', required
- `type` 'aptos' | 'arch' | 'black_box' | 'canton' | 'cosmos' | 'evm' | 'safe' | 'solana' | 'stacks' | 'starknet' | 'stellar' | 'sui' | 'ton' | 'tron' | 'utxo' | 'exchange', required
- `logo_url` string, uri — The logo of the vault. Supported for exchange and Safe vaults.
- `end_user` EndUserRef
- `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
- `user_type` 'end_user', required — The type of the user.
- `external_id` string, required — External id of the user.
- `state` 'active' | 'deleted', required — The state of the user.
- `is_external_signer` boolean — Whether the vault uses an externally imported key (external signer).
- `related_transactions` RelatedTransaction[] — The related transactions.
- `type` 'swap_fulfilled_by' | 'swap_fulfilling' | 'bridge_intent' | 'bridge_source' | 'bridge_destination' | 'stellar_claim_of' | 'stellar_claimed_by' | 'canton_accept_of' | 'canton_accepted_by', required
- `hash` string — The hash of the related transaction.
- `id` string, uuid — The id of the related transaction.
- `chain` union, required — A blockchain with metadata.
- EnrichedAptosChain
- `chain_type` 'aptos', required — The type of the chain.
- `unique_id` 'aptos_mainnet' | 'aptos_testnet' | 'aptos_movement_mainnet' | 'aptos_movement_testnet', required
- `name` string, required — The full blockchain name.
- `native_currency_symbol` string, required — The native currency symbol.
- `native_currency_name` string, required — The native currency name.
- `blockchain_explorer` BlockchainExplorer — A blockchain explorer entry point.
- `transaction_url` string, uri, required
- `address_url` string, uri, required
- `root_url` string, uri, required
- `transaction_format_url` string, uri
- `address_format_url` string, uri
- `asset_format_url` string, uri
- `logo_url` string, uri, required — The logo URL of the chain.
- `is_testnet` boolean, required — Whether the chain is on a testnet.
- `is_enabled` boolean, required — Whether the chain is enabled.
- EnrichedArchChain
- `chain_type` 'arch', required — The type of the chain.
- `unique_id` 'arch_mainnet' | 'arch_testnet', required
- `name` string, required — The full blockchain name.
- `native_currency_symbol` string, required — The native currency symbol.
- `native_currency_name` string, required — The native currency name.
- `blockchain_explorer` BlockchainExplorer — A blockchain explorer entry point.
- `transaction_url` string, uri, required
- `address_url` string, uri, required
- `root_url` string, uri, required
- `transaction_format_url` string, uri
- `address_format_url` string, uri
- `asset_format_url` string, uri
- `logo_url` string, uri, required — The logo URL of the chain.
- `is_testnet` boolean, required — Whether the chain is on a testnet.
- `is_enabled` boolean, required — Whether the chain is enabled.
- EnrichedCantonChain
- `chain_type` 'canton', required — The type of the chain.
- `unique_id` 'canton_mainnet' | 'canton_testnet', required
- `name` string, required — The full blockchain name.
- `native_currency_symbol` string, required — The native currency symbol.
- `native_currency_name` string, required — The native currency name.
- `blockchain_explorer` BlockchainExplorer — A blockchain explorer entry point.
- `transaction_url` string, uri, required
- `address_url` string, uri, required
- `root_url` string, uri, required
- `transaction_format_url` string, uri
- `address_format_url` string, uri
- `asset_format_url` string, uri
- `logo_url` string, uri, required — The logo URL of the chain.
- `is_testnet` boolean, required — Whether the chain is on a testnet.
- `is_enabled` boolean, required — Whether the chain is enabled.
- EnrichedCosmosChain
- `chain_type` 'cosmos', required — The type of the chain.
- `unique_id` 'cosmos_agoric-3' | 'cosmos_akashnet-2' | 'cosmos_archway-1' | 'cosmos_axelar-dojo-1' | 'cosmos_bbn-1' | 'cosmos_celestia' | 'cosmos_cosmoshub-4' | 'cosmos_dydx-mainnet-1' | 'cosmos_dydx-testnet-4' | 'cosmos_dymension_1100-1' | 'cosmos_injective-1' | 'cosmos_neutron-1' | 'cosmos_nillion-1' | 'cosmos_noble-1' | 'cosmos_osmosis-1' | 'cosmos_provider' | 'cosmos_ssc-1' | 'cosmos_pacific-1' | 'cosmos_stride-1' | 'cosmos_thorchain-1' | 'cosmos_mantra-1', required
- `name` string, required — The full blockchain name.
- `native_currency_symbol` string, required — The native currency symbol.
- `native_currency_name` string, required — The native currency name.
- `blockchain_explorer` BlockchainExplorer — A blockchain explorer entry point.
- `transaction_url` string, uri, required
- `address_url` string, uri, required
- `root_url` string, uri, required
- `transaction_format_url` string, uri
- `address_format_url` string, uri
- `asset_format_url` string, uri
- `logo_url` string, uri, required — The logo URL of the chain.
- `is_testnet` boolean, required — Whether the chain is on a testnet.
- `is_enabled` boolean, required — Whether the chain is enabled.
- `base_denom` string, required — The base denom of the chain.
- `bech32_prefix` 'agoric' | 'akash' | 'archway' | 'axelar' | 'bbn' | 'celestia' | 'cosmos' | 'dydx' | 'dym' | 'inj' | 'neutron' | 'nillion' | 'noble' | 'osmo' | 'saga' | 'sei' | 'stride' | 'thor' | 'mantra', required
- EnrichedEvmChain
- `chain_type` 'evm', required — The type of the chain.
- `named_chain_id` string — The EVM chain name can be either one of those supported by the default chains below or a custom chain name if one was added to your organization. - `arbitrum_mainnet`
- `arbitrum_sepolia`
- `aster_mainnet`
- `avalanche_chain`
- `avalanche_fuji`
- `base_mainnet`
- `berachain_mainnet`
- `blast_mainnet`
- `bsc_mainnet`
- `canto_mainnet`
- `clink_mainnet`
- `clink_testnet`
- `conflux_mainnet`
- `dymension_mainnet`
- `ethereum_goerli`
- `ethereum_holesky`
- `ethereum_mainnet`
- `ethereum_sepolia`
- `fantom_mainnet`
- `flare_mainnet`
- `flare_testnet`
- `gnosis_mainnet`
- `hypercore_mainnet`
- `hyperevm_mainnet`
- `ink_mainnet`
- `kava_mainnet`
- `katana_mainnet`
- `linea_mainnet`
- `optimism_mainnet`
- `pharos_mainnet`
- `plasma_mainnet`
- `manta_pacific_mainnet`
- `mantle_mainnet`
- `merlin_mainnet`
- `monad_mainnet`
- `polygon_mainnet`
- `polygon_mumbai`
- `polygon_zkevm_mainnet`
- `reya_mainnet`
- `robinhood_mainnet`
- `rootstock_mainnet`
- `scroll_mainnet`
- `sei_mainnet`
- `sonic_mainnet`
- `tempo_mainnet`
- `unichain_mainnet`
- `xai_mainnet`
- `x_layer_mainnet`
- `zero_gravity_mainnet`
- `zeta_mainnet`
- `zklink_nova_mainnet`
- `zksync_era_mainnet`
- `chain_id` integer, required — The EVM chain ID can be either one of those supported by the default chains below or a custom chain ID if one was added to your organization. - 1=`ethereum_mainnet`
- 5=`ethereum_goerli`
- 10=`optimism_mainnet`
- 14=`flare_mainnet`
- 16=`flare_testnet`
- 30=`rootstock_mainnet`
- 56=`bsc_mainnet`
- 100=`gnosis_mainnet`
- 130=`unichain_mainnet`
- 137=`polygon_mainnet`
- 143=`monad_mainnet`
- 146=`sonic_mainnet`
- 169=`manta_pacific_mainnet`
- 196=`x_layer_mainnet`
- 250=`fantom_mainnet`
- 324=`zksync_era_mainnet`
- 999=`hyperevm_mainnet`
- 1030=`conflux_mainnet`
- 1100=`dymension_mainnet`
- 1101=`polygon_zkevm_mainnet`
- 1329=`sei_mainnet`
- 1337=`hypercore_mainnet`
- 1666=`aster_mainnet`
- 1672=`pharos_mainnet`
- 1729=`reya_mainnet`
- 2222=`kava_mainnet`
- 4200=`merlin_mainnet`
- 4217=`tempo_mainnet`
- 4663=`robinhood_mainnet`
- 5000=`mantle_mainnet`
- 7000=`zeta_mainnet`
- 7700=`canto_mainnet`
- 8453=`base_mainnet`
- 8818=`clink_mainnet`
- 8819=`clink_testnet`
- 9745=`plasma_mainnet`
- 16661=`zero_gravity_mainnet`
- 17000=`ethereum_holesky`
- 80001=`polygon_mumbai`
- 80094=`berachain_mainnet`
- 42161=`arbitrum_mainnet`
- 43113=`avalanche_fuji`
- 43114=`avalanche_chain`
- 57073=`ink_mainnet`
- 59144=`linea_mainnet`
- 81457=`blast_mainnet`
- 421614=`arbitrum_sepolia`
- 534352=`scroll_mainnet`
- 660279=`xai_mainnet`
- 747474=`katana_mainnet`
- 810180=`zklink_nova_mainnet`
- 11155111=`ethereum_sepolia`
- `unique_id` string, required — The unique EVM chain ID. Can be either one of those supported by the default chains below or a custom numeric chain ID `evm_` if one was added to your organization. - `"evm_1"`
- `"evm_5"`
- `"evm_10"`
- `"evm_14"`
- `"evm_16"`
- `"evm_30"`
- `"evm_56"`
- `"evm_100"`
- `"evm_130"`
- `"evm_137"`
- `"evm_143"`
- `"evm_146"`
- `"evm_169"`
- `"evm_196"`
- `"evm_250"`
- `"evm_324"`
- `"evm_999"`
- `"evm_1030"`
- `"evm_1100"`
- `"evm_1101"`
- `"evm_1329"`
- `"evm_1337"`
- `"evm_1666"`
- `"evm_1672"`
- `"evm_1729"`
- `"evm_2222"`
- `"evm_4200"`
- `"evm_4217"`
- `"evm_4663"`
- `"evm_5000"`
- `"evm_7000"`
- `"evm_7700"`
- `"evm_8453"`
- `"evm_8818"`
- `"evm_8819"`
- `"evm_9745"`
- `"evm_16661"`
- `"evm_17000"`
- `"evm_80001"`
- `"evm_80094"`
- `"evm_42161"`
- `"evm_43113"`
- `"evm_43114"`
- `"evm_57073"`
- `"evm_59144"`
- `"evm_81457"`
- `"evm_421614"`
- `"evm_534352"`
- `"evm_660279"`
- `"evm_747474"`
- `"evm_810180"`
- `"evm_11155111"`
- `"evm_ethereum_mainnet"`
- `"evm_ethereum_goerli"`
- `"evm_optimism_mainnet"`
- `"evm_flare_mainnet"`
- `"evm_flare_testnet"`
- `"evm_rootstock_mainnet"`
- `"evm_bsc_mainnet"`
- `"evm_gnosis_mainnet"`
- `"evm_unichain_mainnet"`
- `"evm_polygon_mainnet"`
- `"evm_monad_mainnet"`
- `"evm_sonic_mainnet"`
- `"evm_manta_pacific_mainnet"`
- `"evm_x_layer_mainnet"`
- `"evm_fantom_mainnet"`
- `"evm_zksync_era_mainnet"`
- `"evm_hyperevm_mainnet"`
- `"evm_conflux_mainnet"`
- `"evm_dymension_mainnet"`
- `"evm_polygon_zkevm_mainnet"`
- `"evm_sei_mainnet"`
- `"evm_hypercore_mainnet"`
- `"evm_aster_mainnet"`
- `"evm_pharos_mainnet"`
- `"evm_reya_mainnet"`
- `"evm_kava_mainnet"`
- `"evm_merlin_mainnet"`
- `"evm_tempo_mainnet"`
- `"evm_robinhood_mainnet"`
- `"evm_mantle_mainnet"`
- `"evm_zeta_mainnet"`
- `"evm_canto_mainnet"`
- `"evm_base_mainnet"`
- `"evm_clink_mainnet"`
- `"evm_clink_testnet"`
- `"evm_plasma_mainnet"`
- `"evm_zero_gravity_mainnet"`
- `"evm_ethereum_holesky"`
- `"evm_polygon_mumbai"`
- `"evm_berachain_mainnet"`
- `"evm_arbitrum_mainnet"`
- `"evm_avalanche_fuji"`
- `"evm_avalanche_chain"`
- `"evm_ink_mainnet"`
- `"evm_linea_mainnet"`
- `"evm_blast_mainnet"`
- `"evm_arbitrum_sepolia"`
- `"evm_scroll_mainnet"`
- `"evm_xai_mainnet"`
- `"evm_katana_mainnet"`
- `"evm_zklink_nova_mainnet"`
- `"evm_ethereum_sepolia"`
- `name` string, required — The full blockchain name.
- `native_currency_symbol` string, required — The native currency symbol.
- `native_currency_name` string, required — The native currency name.
- `blockchain_explorer` BlockchainExplorer — A blockchain explorer entry point.
- `transaction_url` string, uri, required
- `address_url` string, uri, required
- `root_url` string, uri, required
- `transaction_format_url` string, uri
- `address_format_url` string, uri
- `asset_format_url` string, uri
- `logo_url` string, uri, required — The logo URL of the chain.
- `is_testnet` boolean, required — Whether the chain is on a testnet.
- `is_enabled` boolean, required — Whether the chain is enabled.
- `gas_type` 'dynamic' | 'legacy', required
- `supports_secure_node` boolean — `True` if the chain supports secure nodes, `False` otherwise.
- `supports_mev_protected_node` boolean — `True` if the chain supports MEV protected nodes, `False` otherwise.
- `rpc_url` string — The URL of the chain's RPC. Exists only for custom chains.
- `source` 'default' | 'custom', required
- `supports_7702` boolean — `True` if the chain supports 7702, `False` otherwise.
- EnrichedExchangeChain
- `chain_type` 'exchange', required — The type of the chain.
- `unique_id` 'exchange_binance' | 'exchange_bybit' | 'exchange_coinbase_international' | 'exchange_coinbase_us' | 'exchange_okx' | 'exchange_kraken', required
- `name` string, required — The full blockchain name.
- `native_currency_symbol` string, required — The native currency symbol.
- `native_currency_name` string, required — The native currency name.
- `blockchain_explorer` BlockchainExplorer — A blockchain explorer entry point.
- `transaction_url` string, uri, required
- `address_url` string, uri, required
- `root_url` string, uri, required
- `transaction_format_url` string, uri
- `address_format_url` string, uri
- `asset_format_url` string, uri
- `logo_url` string, uri, required — The logo URL of the chain.
- `is_testnet` boolean, required — Whether the chain is on a testnet.
- `is_enabled` boolean, required — Whether the chain is enabled.
- EnrichedSolanaChain
- `chain_type` 'solana', required — The type of the chain.
- `unique_id` 'solana_mainnet' | 'solana_devnet' | 'solana_eclipse_mainnet' | 'solana_fogo_mainnet' | 'solana_fogo_testnet', required
- `name` string, required — The full blockchain name.
- `native_currency_symbol` string, required — The native currency symbol.
- `native_currency_name` string, required — The native currency name.
- `blockchain_explorer` BlockchainExplorer — A blockchain explorer entry point.
- `transaction_url` string, uri, required
- `address_url` string, uri, required
- `root_url` string, uri, required
- `transaction_format_url` string, uri
- `address_format_url` string, uri
- `asset_format_url` string, uri
- `logo_url` string, uri, required — The logo URL of the chain.
- `is_testnet` boolean, required — Whether the chain is on a testnet.
- `is_enabled` boolean, required — Whether the chain is enabled.
- EnrichedStacksChain
- `chain_type` 'stacks', required — The type of the chain.
- `unique_id` 'stacks_mainnet', required
- `name` string, required — The full blockchain name.
- `native_currency_symbol` string, required — The native currency symbol.
- `native_currency_name` string, required — The native currency name.
- `blockchain_explorer` BlockchainExplorer — A blockchain explorer entry point.
- `transaction_url` string, uri, required
- `address_url` string, uri, required
- `root_url` string, uri, required
- `transaction_format_url` string, uri
- `address_format_url` string, uri
- `asset_format_url` string, uri
- `logo_url` string, uri, required — The logo URL of the chain.
- `is_testnet` boolean, required — Whether the chain is on a testnet.
- `is_enabled` boolean, required — Whether the chain is enabled.
- EnrichedStarknetChain
- `chain_type` 'starknet', required — The type of the chain.
- `unique_id` 'starknet_mainnet', required
- `name` string, required — The full blockchain name.
- `native_currency_symbol` string, required — The native currency symbol.
- `native_currency_name` string, required — The native currency name.
- `blockchain_explorer` BlockchainExplorer — A blockchain explorer entry point.
- `transaction_url` string, uri, required
- `address_url` string, uri, required
- `root_url` string, uri, required
- `transaction_format_url` string, uri
- `address_format_url` string, uri
- `asset_format_url` string, uri
- `logo_url` string, uri, required — The logo URL of the chain.
- `is_testnet` boolean, required — Whether the chain is on a testnet.
- `is_enabled` boolean, required — Whether the chain is enabled.
- EnrichedStellarChain
- `chain_type` 'stellar', required — The type of the chain.
- `unique_id` 'stellar_mainnet' | 'stellar_testnet', required
- `name` string, required — The full blockchain name.
- `native_currency_symbol` string, required — The native currency symbol.
- `native_currency_name` string, required — The native currency name.
- `blockchain_explorer` BlockchainExplorer — A blockchain explorer entry point.
- `transaction_url` string, uri, required
- `address_url` string, uri, required
- `root_url` string, uri, required
- `transaction_format_url` string, uri
- `address_format_url` string, uri
- `asset_format_url` string, uri
- `logo_url` string, uri, required — The logo URL of the chain.
- `is_testnet` boolean, required — Whether the chain is on a testnet.
- `is_enabled` boolean, required — Whether the chain is enabled.
- EnrichedSuiChain
- `chain_type` 'sui', required — The type of the chain.
- `unique_id` 'sui_mainnet' | 'sui_testnet', required
- `name` string, required — The full blockchain name.
- `native_currency_symbol` string, required — The native currency symbol.
- `native_currency_name` string, required — The native currency name.
- `blockchain_explorer` BlockchainExplorer — A blockchain explorer entry point.
- `transaction_url` string, uri, required
- `address_url` string, uri, required
- `root_url` string, uri, required
- `transaction_format_url` string, uri
- `address_format_url` string, uri
- `asset_format_url` string, uri
- `logo_url` string, uri, required — The logo URL of the chain.
- `is_testnet` boolean, required — Whether the chain is on a testnet.
- `is_enabled` boolean, required — Whether the chain is enabled.
- EnrichedTonChain
- `chain_type` 'ton', required — The type of the chain.
- `unique_id` 'ton_mainnet', required
- `name` string, required — The full blockchain name.
- `native_currency_symbol` string, required — The native currency symbol.
- `native_currency_name` string, required — The native currency name.
- `blockchain_explorer` BlockchainExplorer — A blockchain explorer entry point.
- `transaction_url` string, uri, required
- `address_url` string, uri, required
- `root_url` string, uri, required
- `transaction_format_url` string, uri
- `address_format_url` string, uri
- `asset_format_url` string, uri
- `logo_url` string, uri, required — The logo URL of the chain.
- `is_testnet` boolean, required — Whether the chain is on a testnet.
- `is_enabled` boolean, required — Whether the chain is enabled.
- EnrichedTronChain
- `chain_type` 'tron', required — The type of the chain.
- `unique_id` 'tron_mainnet' | 'tron_shasta', required
- `name` string, required — The full blockchain name.
- `native_currency_symbol` string, required — The native currency symbol.
- `native_currency_name` string, required — The native currency name.
- `blockchain_explorer` BlockchainExplorer — A blockchain explorer entry point.
- `transaction_url` string, uri, required
- `address_url` string, uri, required
- `root_url` string, uri, required
- `transaction_format_url` string, uri
- `address_format_url` string, uri
- `asset_format_url` string, uri
- `logo_url` string, uri, required — The logo URL of the chain.
- `is_testnet` boolean, required — Whether the chain is on a testnet.
- `is_enabled` boolean, required — Whether the chain is enabled.
- EnrichedUtxoChain
- `chain_type` 'utxo', required — The type of the chain.
- `unique_id` 'bitcoin_mainnet' | 'bitcoin_testnet' | 'bitcoin_testnet_v4' | 'dogecoin_mainnet' | 'bitcoin_cash_mainnet' | 'pearl_testnet' | 'pearl_mainnet', required
- `name` string, required — The full blockchain name.
- `native_currency_symbol` string, required — The native currency symbol.
- `native_currency_name` string, required — The native currency name.
- `blockchain_explorer` BlockchainExplorer — A blockchain explorer entry point.
- `transaction_url` string, uri, required
- `address_url` string, uri, required
- `root_url` string, uri, required
- `transaction_format_url` string, uri
- `address_format_url` string, uri
- `asset_format_url` string, uri
- `logo_url` string, uri, required — The logo URL of the chain.
- `is_testnet` boolean, required — Whether the chain is on a testnet.
- `is_enabled` boolean, required — Whether the chain is enabled.
- `explorer_url` string, uri — The URL of the related transaction in a blockchain explorer.
- `organization_id` string, uuid, required — The organization that the transaction belongs to.
- `state` 'waiting_for_approval' | 'waiting_for_signing_trigger' | 'approved' | 'finalized_for_signing' | 'signed' | 'sent_to_provider' | 'completed' | 'error_signing' | 'aborted' | 'error_submitting_to_provider' | 'dropped', required
- `state_changes` NonPushableTransactionStateChange[], required — The state changes of the message.
- `changed_at` string, date-time, required — The date and time when the state was changed.
- `reason` 'failed_to_verify_signature' | 'original_transaction_was_completed' | 'stale_nonce' | 'quote_expired' | 'another_dlc_transaction_was_completed' | 'fee_limit_exceeded' | 'not_in_mempool_or_chain' | 'exchange_withdraw_address_not_whitelisted' | 'exchange_invalid_api_key_permissions' | 'exchange_funds_pending_settlement' | 'exchange_withdrawal_limit_exceeded' | 'exchange_security_and_policy_holds' | 'exchange_service_unavailable'
- `previous_state` 'waiting_for_approval' | 'waiting_for_signing_trigger' | 'approved' | 'finalized_for_signing' | 'signed' | 'sent_to_provider' | 'completed' | 'error_signing' | 'aborted' | 'error_submitting_to_provider' | 'dropped'
- `new_state` 'waiting_for_approval' | 'waiting_for_signing_trigger' | 'approved' | 'finalized_for_signing' | 'signed' | 'sent_to_provider' | 'completed' | 'error_signing' | 'aborted' | 'error_submitting_to_provider' | 'dropped', required
- `type` 'aptos_message', required — Aptos message type.
- `aptos_message_type` 'personal_message_type', required
- `raw_original_message_to_sign` string, required — The original message that was requested to be signed, encoded in base64.
- `string_original_message_to_sign` string, required — The original message that was requested to be signed.
- `raw_full_message_to_sign` string, required — The full message to be signed, encoded in base64.
- `string_full_message_to_sign` string, required — The full message to be signed.
- `chain` EnrichedAptosChain, required
- `chain_type` 'aptos', required — The type of the chain.
- `unique_id` 'aptos_mainnet' | 'aptos_testnet' | 'aptos_movement_mainnet' | 'aptos_movement_testnet', required
- `name` string, required — The full blockchain name.
- `native_currency_symbol` string, required — The native currency symbol.
- `native_currency_name` string, required — The native currency name.
- `blockchain_explorer` BlockchainExplorer — A blockchain explorer entry point.
- `transaction_url` string, uri, required
- `address_url` string, uri, required
- `root_url` string, uri, required
- `transaction_format_url` string, uri
- `address_format_url` string, uri
- `asset_format_url` string, uri
- `logo_url` string, uri, required — The logo URL of the chain.
- `is_testnet` boolean, required — Whether the chain is on a testnet.
- `is_enabled` boolean, required — Whether the chain is enabled.
- `sender` EnrichedAptosAddress, required
- `vault` VaultRef — Represents a reference to a vault in the Fordefi platform
- `id` string, uuid, required — The unique identifier of the vault in the Fordefi platform.
- `vault_group_id` string, uuid — The unique identifier of the vault group this vault belongs to.
- `vault_group_ids` string[], required — The unique identifiers of the vault groups this vault belongs to.
- `name` string, required — The name of the vault.
- `address` string — The address of the vault.
- `state` 'active' | 'archived' | 'deleted' | 'pending' | 'aborted', required
- `type` 'aptos' | 'arch' | 'black_box' | 'canton' | 'cosmos' | 'evm' | 'safe' | 'solana' | 'stacks' | 'starknet' | 'stellar' | 'sui' | 'ton' | 'tron' | 'utxo' | 'exchange', required
- `logo_url` string, uri — The logo of the vault. Supported for exchange and Safe vaults.
- `end_user` EndUserRef
- `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
- `user_type` 'end_user', required — The type of the user.
- `external_id` string, required — External id of the user.
- `state` 'active' | 'deleted', required — The state of the user.
- `is_external_signer` boolean — Whether the vault uses an externally imported key (external signer).
- `explorer_url` string, uri — The URL of a blockchain explorer that provides real-time information about the address.
- `contact` ContactRef — Represents a reference to an address book contact in the Fordefi platform.
- `id` string, uuid, required — The unique identifier of the address book contact in the Fordefi platform.
- `name` string, required — The name of the contact.
- `address_ref` union, required
- AptosAddressBookContactAddressRef
- `chain_type` 'aptos', required — The type of the chain.
- `address` string, required — The address on the Aptos chain.
- `chains` AptosChain[], required — The chains that the contact belongs to.
- …
- ArchAddressBookContactAddressRef
- `chain_type` 'arch', required — The type of the chain.
- `address` string, required — The address on the Arch chain.
- `chains` ArchChain[], required — The chains the contact belongs to.
- …
- CantonAddressBookContactAddressRef
- `chain_type` 'canton', required — The type of the chain.
- `address` string, required — The party id on the Canton chain.
- `chains` CantonChain[], required — The chains the contact belongs to.
- …
- `memo` string — Memo is an additional address feature used for identifying a recipient.
- CosmosAddressBookContactAddressRef
- `chain_type` 'cosmos', required — The type of the chain.
- `address` string, required — The address on the cosmos chain.
- `chain` CosmosChain, required
- …
- `memo` string — Memo is an additional address feature used for identifying a recipient.
- EVMAddressBookContactAddressRef
- `chain_type` 'evm', required — The type of the chain.
- `address` string, required — The address of the contact.
- `chains` EvmChain[], required — The chains the contact belongs to.
- …
- SolanaAddressBookContactAddressRef
- `chain_type` 'solana', required — The type of the chain.
- `address` string, required — The address on the Solana chain.
- `chains` SolanaChain[], required — The chains the contact belongs to.
- …
- StacksAddressBookContactAddressRef
- `chain_type` 'stacks', required — The type of the chain.
- `address` string, required — The address on the Stacks chain.
- `chains` StacksChain[], required — The chains the contact belongs to.
- …
- `memo` string — Memo is an additional address feature used for identifying a recipient.
- StarknetAddressBookContactAddressRef
- `chain_type` 'starknet', required — The type of the chain.
- `address` string, required — The address on the Starknet chain.
- `chains` StarknetChain[], required — The chains the contact belongs to.
- …
- StellarAddressBookContactAddressRef
- `chain_type` 'stellar', required — The type of the chain.
- `address` string, required — The address on the Stellar chain.
- `chains` StellarChain[], required — The chains the contact belongs to.
- …
- `memo` string — Memo is an additional address feature used for identifying a recipient.
- SuiAddressBookContactAddressRef
- `chain_type` 'sui', required — The type of the chain.
- `address` string, required — The address on the Sui chain.
- `chains` SuiChain[], required — The chains the contact belongs to.
- …
- TonAddressBookContactAddressRef
- `chain_type` 'ton', required — The type of the chain.
- `address` string, required — The address on the TON chain.
- `chains` TonChain[], required — The chains the contact belongs to.
- …
- `comment` string — Comment is an additional address feature used for identifying a recipient.
- TronAddressBookContactAddressRef
- `chain_type` 'tron', required — The type of the chain.
- `address` string, required — The address on the TRON chain.
- `chains` TronChain[], required — The chains the contact belongs to.
- …
- `memo` string — Memo is an additional address feature used for identifying a recipient.
- UtxoAddressBookContactAddressRef
- `chain_type` 'utxo', required — The type of the chain.
- `address` string, required — The address on the utxo chain.
- `chain` UtxoChain, required
- …
- `type` 'aptos', required
- `address` string, required — The Aptos address represented in hex format.
- AptosTransaction
- `id` string, uuid, required — The unique identifier of the object in the Fordefi platform.
- `created_at` string, date-time, required — The date and time when the object was created.
- `modified_at` string, date-time, required — The date and time when the object was last modified. Any change to any field of the resource is considered a modification.
- `managed_transaction_data` ManagedTransactionData
- `created_by` union, required — Represents a reference to a user in the Fordefi platform
- PersonRef
- `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
- `user_type` 'person', required — The type of user. Can be a person, or (in programmatic scenarios) an API user or API Signer.
- `name` string — The name of the user.
- `email` string, required — The email of the user.
- `state` 'active' | 'onboarding_pending_code_generation' | 'onboarding_pending_activation' | 'reset_device_pending_code_generation' | 'reset_device_pending_activation' | 'pending_approval' | 'deleted', required
- `role` 'admin' | 'trader' | 'viewer', required
- ApiUserRef
- `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
- `user_type` 'api_user', required — The type of the user.
- `name` string, required — The name of the user.
- `state` 'active' | 'deleted', required — The state of the user.
- `role` 'admin' | 'trader' | 'viewer', required
- ApiSignerRef
- `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
- `user_type` 'api_signer', required — The type of the user.
- `name` string, required — The name of the user.
- `state` 'active' | 'onboarding_pending_code_generation' | 'onboarding_pending_activation' | 'deleted', required — The state of the user.
- EndUserRef
- `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
- `user_type` 'end_user', required — The type of the user.
- `external_id` string, required — External id of the user.
- `state` 'active' | 'deleted', required — The state of the user.
- SystemUserRef
- `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
- `user_type` 'system', required — The type of the user.
- `name` string, required — The name is Fordefi CARE
- `aborted_by` union — Represents a reference to a user in the Fordefi platform
- PersonRef
- `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
- `user_type` 'person', required — The type of user. Can be a person, or (in programmatic scenarios) an API user or API Signer.
- `name` string — The name of the user.
- `email` string, required — The email of the user.
- `state` 'active' | 'onboarding_pending_code_generation' | 'onboarding_pending_activation' | 'reset_device_pending_code_generation' | 'reset_device_pending_activation' | 'pending_approval' | 'deleted', required
- `role` 'admin' | 'trader' | 'viewer', required
- ApiUserRef
- `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
- `user_type` 'api_user', required — The type of the user.
- `name` string, required — The name of the user.
- `state` 'active' | 'deleted', required — The state of the user.
- `role` 'admin' | 'trader' | 'viewer', required
- ApiSignerRef
- `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
- `user_type` 'api_signer', required — The type of the user.
- `name` string, required — The name of the user.
- `state` 'active' | 'onboarding_pending_code_generation' | 'onboarding_pending_activation' | 'deleted', required — The state of the user.
- EndUserRef
- `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
- `user_type` 'end_user', required — The type of the user.
- `external_id` string, required — External id of the user.
- `state` 'active' | 'deleted', required — The state of the user.
- SystemUserRef
- `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
- `user_type` 'system', required — The type of the user.
- `name` string, required — The name is Fordefi CARE
- `finalized_for_signing_by` union — Represents a reference to a user in the Fordefi platform
- PersonRef
- `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
- `user_type` 'person', required — The type of user. Can be a person, or (in programmatic scenarios) an API user or API Signer.
- `name` string — The name of the user.
- `email` string, required — The email of the user.
- `state` 'active' | 'onboarding_pending_code_generation' | 'onboarding_pending_activation' | 'reset_device_pending_code_generation' | 'reset_device_pending_activation' | 'pending_approval' | 'deleted', required
- `role` 'admin' | 'trader' | 'viewer', required
- ApiUserRef
- `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
- `user_type` 'api_user', required — The type of the user.
- `name` string, required — The name of the user.
- `state` 'active' | 'deleted', required — The state of the user.
- `role` 'admin' | 'trader' | 'viewer', required
- ApiSignerRef
- `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
- `user_type` 'api_signer', required — The type of the user.
- `name` string, required — The name of the user.
- `state` 'active' | 'onboarding_pending_code_generation' | 'onboarding_pending_activation' | 'deleted', required — The state of the user.
- EndUserRef
- `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
- `user_type` 'end_user', required — The type of the user.
- `external_id` string, required — External id of the user.
- `state` 'active' | 'deleted', required — The state of the user.
- SystemUserRef
- `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
- `user_type` 'system', required — The type of the user.
- `name` string, required — The name is Fordefi CARE
- `device_signing_request` ActionSigningRequest — Represents a device sign request for an action in the Foredefi platform
- `created_by` union, required — Represents a reference to a user in the Fordefi platform
- PersonRef
- `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
- `user_type` 'person', required — The type of user. Can be a person, or (in programmatic scenarios) an API user or API Signer.
- `name` string — The name of the user.
- `email` string, required — The email of the user.
- `state` 'active' | 'onboarding_pending_code_generation' | 'onboarding_pending_activation' | 'reset_device_pending_code_generation' | 'reset_device_pending_activation' | 'pending_approval' | 'deleted', required
- `role` 'admin' | 'trader' | 'viewer', required
- ApiUserRef
- `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
- `user_type` 'api_user', required — The type of the user.
- `name` string, required — The name of the user.
- `state` 'active' | 'deleted', required — The state of the user.
- `role` 'admin' | 'trader' | 'viewer', required
- ApiSignerRef
- `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
- `user_type` 'api_signer', required — The type of the user.
- `name` string, required — The name of the user.
- `state` 'active' | 'onboarding_pending_code_generation' | 'onboarding_pending_activation' | 'deleted', required — The state of the user.
- EndUserRef
- `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
- `user_type` 'end_user', required — The type of the user.
- `external_id` string, required — External id of the user.
- `state` 'active' | 'deleted', required — The state of the user.
- SystemUserRef
- `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
- `user_type` 'system', required — The type of the user.
- `name` string, required — The name is Fordefi CARE
- `signers` ActionSigner[], required — A list of required signers. A signer can be a person or an API Signer.
- `user` union, required — Represents a reference to a user in the Fordefi platform
- PersonRef
- …
- ApiUserRef
- …
- ApiSignerRef
- …
- EndUserRef
- …
- SystemUserRef
- …
- `modified_at` string, date-time, required — When the signer received/signed the action
- `has_signed` boolean, required — Whether the signer signed the action
- `approval_request` ApprovalRequest — Represents an approval request for an action in the Fordefi platform
- `state` 'created' | 'approved' | 'insufficient_approvers' | 'auto_approved' | 'failed', required — Represents the whole approval request state
- `required_groups` integer, required — The number of required approval groups.
- `approval_groups` ApprovalRequestGroup[], required — A list of the possible approvers from different groups.
- `quorum_size` integer, required — The number of approvers required to approve the transaction.
- `approvers` RequestApprover[], required — A list of the possible approvers.
- `user` union, required
- …
- `modified_at` string, date-time, required — The date and time when this approval was modified.
- `decision` string — The decision of the approver.
- `state` 'pending' | 'approved' | 'unauthorized' | 'not_participated', required — Represents an approval state of a single approver
- `error_message` string — The error message if the request failed.
- `aml_policy_match` AmlPolicyMatchOutgoing
- `is_default` boolean, required — `True` if this is the default rule, `False` otherwise.
- `rule_id` string, uuid, required — The unique identifier of the rule.
- `rule_name` string, required — The name of the rule.
- `action_type` 'allow' | 'block' | 'require_approval' | 'skip', required
- `policy_match` PolicyMatch
- `is_default` boolean, required — `True` if this is the default rule, `False` otherwise.
- `rule_id` string, uuid, required — The unique identifier of the rule.
- `rule_name` string, required — The name of the rule.
- `action_type` 'allow' | 'block' | 'require_approval', required
- `signer_type` 'initiator' | 'api_signer' | 'end_user' | 'multiple_signers' | 'api_user', required
- `risks` TransactionRisk[], required — The list of risks associated with this transaction.
- `type` 'transfer_to_erc20_contract' | 'organization_not_interacted_with_address' | 'vault_not_interacted_with_address' | 'allowance_to_eoa' | 'unlimited_allowance' | 'contract_not_verified' | 'bridge_dest_differ_from_sender' | 'nft_approve_for_all' | 'missing_simulation' | 'unsupported_simulation' | 'post_conditions_allow_mode' | 'safe_sensitive_operation', required
- `severity` 'low' | 'medium' | 'high', required
- `title` string, required — The title of the risk.
- `description` string, required — A detailed description of the risk.
- `error_pushing_to_blockchain_message` string — The translated error message received from the node if it was rejected by it.
- `original_error_pushing_to_blockchain_message` string — The error message received from the node if it was rejected by it.
- `vault` VaultRef, required — Represents a reference to a vault in the Fordefi platform
- `id` string, uuid, required — The unique identifier of the vault in the Fordefi platform.
- `vault_group_id` string, uuid — The unique identifier of the vault group this vault belongs to.
- `vault_group_ids` string[], required — The unique identifiers of the vault groups this vault belongs to.
- `name` string, required — The name of the vault.
- `address` string — The address of the vault.
- `state` 'active' | 'archived' | 'deleted' | 'pending' | 'aborted', required
- `type` 'aptos' | 'arch' | 'black_box' | 'canton' | 'cosmos' | 'evm' | 'safe' | 'solana' | 'stacks' | 'starknet' | 'stellar' | 'sui' | 'ton' | 'tron' | 'utxo' | 'exchange', required
- `logo_url` string, uri — The logo of the vault. Supported for exchange and Safe vaults.
- `end_user` EndUserRef
- `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
- `user_type` 'end_user', required — The type of the user.
- `external_id` string, required — External id of the user.
- `state` 'active' | 'deleted', required — The state of the user.
- `is_external_signer` boolean — Whether the vault uses an externally imported key (external signer).
- `idempotence_id` string, uuid — Optional idempotence ID of a transaction.
- `has_current_user_vault_permissions` boolean, required — Does current user have permissions to the origin vault according to its vault group permissions.
- `batch_data` BatchData
- `batch_id` string, uuid, required — The unique identifier of the batch.
- `index_in_batch` integer, required — Index of transaction in the batch.
- `batch_size` integer, required — The number of transactions in the batch.
- `matched_policies` PolicyMatch[], required — List of policies matched by this message.
- `is_default` boolean, required — `True` if this is the default rule, `False` otherwise.
- `rule_id` string, uuid, required — The unique identifier of the rule.
- `rule_name` string, required — The name of the rule.
- `action_type` 'allow' | 'block' | 'require_approval', required
- `push_mode` 'auto' | 'manual' | 'deferred'
- `last_pushed_at` string, date-time — The last time the transaction was pushed to the node.
- `sign_mode` 'auto' | 'triggered'
- `fee_paid_by` FeePaidByVault
- `type` 'vault', required — The type of fee payer.
- `vault` VaultRef, required — Represents a reference to a vault in the Fordefi platform
- `id` string, uuid, required — The unique identifier of the vault in the Fordefi platform.
- `vault_group_id` string, uuid — The unique identifier of the vault group this vault belongs to.
- `vault_group_ids` string[], required — The unique identifiers of the vault groups this vault belongs to.
- `name` string, required — The name of the vault.
- `address` string — The address of the vault.
- `state` 'active' | 'archived' | 'deleted' | 'pending' | 'aborted', required
- `type` 'aptos' | 'arch' | 'black_box' | 'canton' | 'cosmos' | 'evm' | 'safe' | 'solana' | 'stacks' | 'starknet' | 'stellar' | 'sui' | 'ton' | 'tron' | 'utxo' | 'exchange', required
- `logo_url` string, uri — The logo of the vault. Supported for exchange and Safe vaults.
- `end_user` EndUserRef
- `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
- `user_type` 'end_user', required — The type of the user.
- `external_id` string, required — External id of the user.
- `state` 'active' | 'deleted', required — The state of the user.
- `is_external_signer` boolean — Whether the vault uses an externally imported key (external signer).
- `attested_payload_for_signing` string — JWS attestation for the payload (external signer). Set after finalize-for-signing.
- `tx_policy_explanation_id` string, uuid — The id of the transaction policy explanation produced for this transaction, if any.
- `signatures` Signature[], required — The transaction signatures.
- `data` string, required — Signature on the transaction, encoded in base64 format.
- `signed_by` union — The user who created this signature, `null` if the signature wasn't created by a Fordefi user.
- PersonRef
- `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
- `user_type` 'person', required — The type of user. Can be a person, or (in programmatic scenarios) an API user or API Signer.
- `name` string — The name of the user.
- `email` string, required — The email of the user.
- `state` 'active' | 'onboarding_pending_code_generation' | 'onboarding_pending_activation' | 'reset_device_pending_code_generation' | 'reset_device_pending_activation' | 'pending_approval' | 'deleted', required
- `role` 'admin' | 'trader' | 'viewer', required
- ApiSignerRef
- `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
- `user_type` 'api_signer', required — The type of the user.
- `name` string, required — The name of the user.
- `state` 'active' | 'onboarding_pending_code_generation' | 'onboarding_pending_activation' | 'deleted', required — The state of the user.
- EndUserRef
- `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
- `user_type` 'end_user', required — The type of the user.
- `external_id` string, required — External id of the user.
- `state` 'active' | 'deleted', required — The state of the user.
- ApiUserRef
- `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
- `user_type` 'api_user', required — The type of the user.
- `name` string, required — The name of the user.
- `state` 'active' | 'deleted', required — The state of the user.
- `role` 'admin' | 'trader' | 'viewer', required
- `note` string — An optional transaction note.
- `spam_state` 'unset' | 'manually_set' | 'automatically_set'
- `direction` 'outgoing' | 'incoming', required
- `signed_externally` boolean — Whether the transaction was signed by an external user (for example in case of imported vault).
- `interacted_vaults` VaultRef[], required — The vaults that interacted with the transaction.
- `id` string, uuid, required — The unique identifier of the vault in the Fordefi platform.
- `vault_group_id` string, uuid — The unique identifier of the vault group this vault belongs to.
- `vault_group_ids` string[], required — The unique identifiers of the vault groups this vault belongs to.
- `name` string, required — The name of the vault.
- `address` string — The address of the vault.
- `state` 'active' | 'archived' | 'deleted' | 'pending' | 'aborted', required
- `type` 'aptos' | 'arch' | 'black_box' | 'canton' | 'cosmos' | 'evm' | 'safe' | 'solana' | 'stacks' | 'starknet' | 'stellar' | 'sui' | 'ton' | 'tron' | 'utxo' | 'exchange', required
- `logo_url` string, uri — The logo of the vault. Supported for exchange and Safe vaults.
- `end_user` EndUserRef
- `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
- `user_type` 'end_user', required — The type of the user.
- `external_id` string, required — External id of the user.
- `state` 'active' | 'deleted', required — The state of the user.
- `is_external_signer` boolean — Whether the vault uses an externally imported key (external signer).
- `related_transactions` RelatedTransaction[] — The related transactions.
- `type` 'swap_fulfilled_by' | 'swap_fulfilling' | 'bridge_intent' | 'bridge_source' | 'bridge_destination' | 'stellar_claim_of' | 'stellar_claimed_by' | 'canton_accept_of' | 'canton_accepted_by', required
- `hash` string — The hash of the related transaction.
- `id` string, uuid — The id of the related transaction.
- `chain` union, required — A blockchain with metadata.
- EnrichedAptosChain
- `chain_type` 'aptos', required — The type of the chain.
- `unique_id` 'aptos_mainnet' | 'aptos_testnet' | 'aptos_movement_mainnet' | 'aptos_movement_testnet', required
- `name` string, required — The full blockchain name.
- `native_currency_symbol` string, required — The native currency symbol.
- `native_currency_name` string, required — The native currency name.
- `blockchain_explorer` BlockchainExplorer — A blockchain explorer entry point.
- `transaction_url` string, uri, required
- `address_url` string, uri, required
- `root_url` string, uri, required
- `transaction_format_url` string, uri
- `address_format_url` string, uri
- `asset_format_url` string, uri
- `logo_url` string, uri, required — The logo URL of the chain.
- `is_testnet` boolean, required — Whether the chain is on a testnet.
- `is_enabled` boolean, required — Whether the chain is enabled.
- EnrichedArchChain
- `chain_type` 'arch', required — The type of the chain.
- `unique_id` 'arch_mainnet' | 'arch_testnet', required
- `name` string, required — The full blockchain name.
- `native_currency_symbol` string, required — The native currency symbol.
- `native_currency_name` string, required — The native currency name.
- `blockchain_explorer` BlockchainExplorer — A blockchain explorer entry point.
- `transaction_url` string, uri, required
- `address_url` string, uri, required
- `root_url` string, uri, required
- `transaction_format_url` string, uri
- `address_format_url` string, uri
- `asset_format_url` string, uri
- `logo_url` string, uri, required — The logo URL of the chain.
- `is_testnet` boolean, required — Whether the chain is on a testnet.
- `is_enabled` boolean, required — Whether the chain is enabled.
- EnrichedCantonChain
- `chain_type` 'canton', required — The type of the chain.
- `unique_id` 'canton_mainnet' | 'canton_testnet', required
- `name` string, required — The full blockchain name.
- `native_currency_symbol` string, required — The native currency symbol.
- `native_currency_name` string, required — The native currency name.
- `blockchain_explorer` BlockchainExplorer — A blockchain explorer entry point.
- `transaction_url` string, uri, required
- `address_url` string, uri, required
- `root_url` string, uri, required
- `transaction_format_url` string, uri
- `address_format_url` string, uri
- `asset_format_url` string, uri
- `logo_url` string, uri, required — The logo URL of the chain.
- `is_testnet` boolean, required — Whether the chain is on a testnet.
- `is_enabled` boolean, required — Whether the chain is enabled.
- EnrichedCosmosChain
- `chain_type` 'cosmos', required — The type of the chain.
- `unique_id` 'cosmos_agoric-3' | 'cosmos_akashnet-2' | 'cosmos_archway-1' | 'cosmos_axelar-dojo-1' | 'cosmos_bbn-1' | 'cosmos_celestia' | 'cosmos_cosmoshub-4' | 'cosmos_dydx-mainnet-1' | 'cosmos_dydx-testnet-4' | 'cosmos_dymension_1100-1' | 'cosmos_injective-1' | 'cosmos_neutron-1' | 'cosmos_nillion-1' | 'cosmos_noble-1' | 'cosmos_osmosis-1' | 'cosmos_provider' | 'cosmos_ssc-1' | 'cosmos_pacific-1' | 'cosmos_stride-1' | 'cosmos_thorchain-1' | 'cosmos_mantra-1', required
- `name` string, required — The full blockchain name.
- `native_currency_symbol` string, required — The native currency symbol.
- `native_currency_name` string, required — The native currency name.
- `blockchain_explorer` BlockchainExplorer — A blockchain explorer entry point.
- `transaction_url` string, uri, required
- `address_url` string, uri, required
- `root_url` string, uri, required
- `transaction_format_url` string, uri
- `address_format_url` string, uri
- `asset_format_url` string, uri
- `logo_url` string, uri, required — The logo URL of the chain.
- `is_testnet` boolean, required — Whether the chain is on a testnet.
- `is_enabled` boolean, required — Whether the chain is enabled.
- `base_denom` string, required — The base denom of the chain.
- `bech32_prefix` 'agoric' | 'akash' | 'archway' | 'axelar' | 'bbn' | 'celestia' | 'cosmos' | 'dydx' | 'dym' | 'inj' | 'neutron' | 'nillion' | 'noble' | 'osmo' | 'saga' | 'sei' | 'stride' | 'thor' | 'mantra', required
- EnrichedEvmChain
- `chain_type` 'evm', required — The type of the chain.
- `named_chain_id` string — The EVM chain name can be either one of those supported by the default chains below or a custom chain name if one was added to your organization. - `arbitrum_mainnet`
- `arbitrum_sepolia`
- `aster_mainnet`
- `avalanche_chain`
- `avalanche_fuji`
- `base_mainnet`
- `berachain_mainnet`
- `blast_mainnet`
- `bsc_mainnet`
- `canto_mainnet`
- `clink_mainnet`
- `clink_testnet`
- `conflux_mainnet`
- `dymension_mainnet`
- `ethereum_goerli`
- `ethereum_holesky`
- `ethereum_mainnet`
- `ethereum_sepolia`
- `fantom_mainnet`
- `flare_mainnet`
- `flare_testnet`
- `gnosis_mainnet`
- `hypercore_mainnet`
- `hyperevm_mainnet`
- `ink_mainnet`
- `kava_mainnet`
- `katana_mainnet`
- `linea_mainnet`
- `optimism_mainnet`
- `pharos_mainnet`
- `plasma_mainnet`
- `manta_pacific_mainnet`
- `mantle_mainnet`
- `merlin_mainnet`
- `monad_mainnet`
- `polygon_mainnet`
- `polygon_mumbai`
- `polygon_zkevm_mainnet`
- `reya_mainnet`
- `robinhood_mainnet`
- `rootstock_mainnet`
- `scroll_mainnet`
- `sei_mainnet`
- `sonic_mainnet`
- `tempo_mainnet`
- `unichain_mainnet`
- `xai_mainnet`
- `x_layer_mainnet`
- `zero_gravity_mainnet`
- `zeta_mainnet`
- `zklink_nova_mainnet`
- `zksync_era_mainnet`
- `chain_id` integer, required — The EVM chain ID can be either one of those supported by the default chains below or a custom chain ID if one was added to your organization. - 1=`ethereum_mainnet`
- 5=`ethereum_goerli`
- 10=`optimism_mainnet`
- 14=`flare_mainnet`
- 16=`flare_testnet`
- 30=`rootstock_mainnet`
- 56=`bsc_mainnet`
- 100=`gnosis_mainnet`
- 130=`unichain_mainnet`
- 137=`polygon_mainnet`
- 143=`monad_mainnet`
- 146=`sonic_mainnet`
- 169=`manta_pacific_mainnet`
- 196=`x_layer_mainnet`
- 250=`fantom_mainnet`
- 324=`zksync_era_mainnet`
- 999=`hyperevm_mainnet`
- 1030=`conflux_mainnet`
- 1100=`dymension_mainnet`
- 1101=`polygon_zkevm_mainnet`
- 1329=`sei_mainnet`
- 1337=`hypercore_mainnet`
- 1666=`aster_mainnet`
- 1672=`pharos_mainnet`
- 1729=`reya_mainnet`
- 2222=`kava_mainnet`
- 4200=`merlin_mainnet`
- 4217=`tempo_mainnet`
- 4663=`robinhood_mainnet`
- 5000=`mantle_mainnet`
- 7000=`zeta_mainnet`
- 7700=`canto_mainnet`
- 8453=`base_mainnet`
- 8818=`clink_mainnet`
- 8819=`clink_testnet`
- 9745=`plasma_mainnet`
- 16661=`zero_gravity_mainnet`
- 17000=`ethereum_holesky`
- 80001=`polygon_mumbai`
- 80094=`berachain_mainnet`
- 42161=`arbitrum_mainnet`
- 43113=`avalanche_fuji`
- 43114=`avalanche_chain`
- 57073=`ink_mainnet`
- 59144=`linea_mainnet`
- 81457=`blast_mainnet`
- 421614=`arbitrum_sepolia`
- 534352=`scroll_mainnet`
- 660279=`xai_mainnet`
- 747474=`katana_mainnet`
- 810180=`zklink_nova_mainnet`
- 11155111=`ethereum_sepolia`
- `unique_id` string, required — The unique EVM chain ID. Can be either one of those supported by the default chains below or a custom numeric chain ID `evm_` if one was added to your organization. - `"evm_1"`
- `"evm_5"`
- `"evm_10"`
- `"evm_14"`
- `"evm_16"`
- `"evm_30"`
- `"evm_56"`
- `"evm_100"`
- `"evm_130"`
- `"evm_137"`
- `"evm_143"`
- `"evm_146"`
- `"evm_169"`
- `"evm_196"`
- `"evm_250"`
- `"evm_324"`
- `"evm_999"`
- `"evm_1030"`
- `"evm_1100"`
- `"evm_1101"`
- `"evm_1329"`
- `"evm_1337"`
- `"evm_1666"`
- `"evm_1672"`
- `"evm_1729"`
- `"evm_2222"`
- `"evm_4200"`
- `"evm_4217"`
- `"evm_4663"`
- `"evm_5000"`
- `"evm_7000"`
- `"evm_7700"`
- `"evm_8453"`
- `"evm_8818"`
- `"evm_8819"`
- `"evm_9745"`
- `"evm_16661"`
- `"evm_17000"`
- `"evm_80001"`
- `"evm_80094"`
- `"evm_42161"`
- `"evm_43113"`
- `"evm_43114"`
- `"evm_57073"`
- `"evm_59144"`
- `"evm_81457"`
- `"evm_421614"`
- `"evm_534352"`
- `"evm_660279"`
- `"evm_747474"`
- `"evm_810180"`
- `"evm_11155111"`
- `"evm_ethereum_mainnet"`
- `"evm_ethereum_goerli"`
- `"evm_optimism_mainnet"`
- `"evm_flare_mainnet"`
- `"evm_flare_testnet"`
- `"evm_rootstock_mainnet"`
- `"evm_bsc_mainnet"`
- `"evm_gnosis_mainnet"`
- `"evm_unichain_mainnet"`
- `"evm_polygon_mainnet"`
- `"evm_monad_mainnet"`
- `"evm_sonic_mainnet"`
- `"evm_manta_pacific_mainnet"`
- `"evm_x_layer_mainnet"`
- `"evm_fantom_mainnet"`
- `"evm_zksync_era_mainnet"`
- `"evm_hyperevm_mainnet"`
- `"evm_conflux_mainnet"`
- `"evm_dymension_mainnet"`
- `"evm_polygon_zkevm_mainnet"`
- `"evm_sei_mainnet"`
- `"evm_hypercore_mainnet"`
- `"evm_aster_mainnet"`
- `"evm_pharos_mainnet"`
- `"evm_reya_mainnet"`
- `"evm_kava_mainnet"`
- `"evm_merlin_mainnet"`
- `"evm_tempo_mainnet"`
- `"evm_robinhood_mainnet"`
- `"evm_mantle_mainnet"`
- `"evm_zeta_mainnet"`
- `"evm_canto_mainnet"`
- `"evm_base_mainnet"`
- `"evm_clink_mainnet"`
- `"evm_clink_testnet"`
- `"evm_plasma_mainnet"`
- `"evm_zero_gravity_mainnet"`
- `"evm_ethereum_holesky"`
- `"evm_polygon_mumbai"`
- `"evm_berachain_mainnet"`
- `"evm_arbitrum_mainnet"`
- `"evm_avalanche_fuji"`
- `"evm_avalanche_chain"`
- `"evm_ink_mainnet"`
- `"evm_linea_mainnet"`
- `"evm_blast_mainnet"`
- `"evm_arbitrum_sepolia"`
- `"evm_scroll_mainnet"`
- `"evm_xai_mainnet"`
- `"evm_katana_mainnet"`
- `"evm_zklink_nova_mainnet"`
- `"evm_ethereum_sepolia"`
- `name` string, required — The full blockchain name.
- `native_currency_symbol` string, required — The native currency symbol.
- `native_currency_name` string, required — The native currency name.
- `blockchain_explorer` BlockchainExplorer — A blockchain explorer entry point.
- `transaction_url` string, uri, required
- `address_url` string, uri, required
- `root_url` string, uri, required
- `transaction_format_url` string, uri
- `address_format_url` string, uri
- `asset_format_url` string, uri
- `logo_url` string, uri, required — The logo URL of the chain.
- `is_testnet` boolean, required — Whether the chain is on a testnet.
- `is_enabled` boolean, required — Whether the chain is enabled.
- `gas_type` 'dynamic' | 'legacy', required
- `supports_secure_node` boolean — `True` if the chain supports secure nodes, `False` otherwise.
- `supports_mev_protected_node` boolean — `True` if the chain supports MEV protected nodes, `False` otherwise.
- `rpc_url` string — The URL of the chain's RPC. Exists only for custom chains.
- `source` 'default' | 'custom', required
- `supports_7702` boolean — `True` if the chain supports 7702, `False` otherwise.
- EnrichedExchangeChain
- `chain_type` 'exchange', required — The type of the chain.
- `unique_id` 'exchange_binance' | 'exchange_bybit' | 'exchange_coinbase_international' | 'exchange_coinbase_us' | 'exchange_okx' | 'exchange_kraken', required
- `name` string, required — The full blockchain name.
- `native_currency_symbol` string, required — The native currency symbol.
- `native_currency_name` string, required — The native currency name.
- `blockchain_explorer` BlockchainExplorer — A blockchain explorer entry point.
- `transaction_url` string, uri, required
- `address_url` string, uri, required
- `root_url` string, uri, required
- `transaction_format_url` string, uri
- `address_format_url` string, uri
- `asset_format_url` string, uri
- `logo_url` string, uri, required — The logo URL of the chain.
- `is_testnet` boolean, required — Whether the chain is on a testnet.
- `is_enabled` boolean, required — Whether the chain is enabled.
- EnrichedSolanaChain
- `chain_type` 'solana', required — The type of the chain.
- `unique_id` 'solana_mainnet' | 'solana_devnet' | 'solana_eclipse_mainnet' | 'solana_fogo_mainnet' | 'solana_fogo_testnet', required
- `name` string, required — The full blockchain name.
- `native_currency_symbol` string, required — The native currency symbol.
- `native_currency_name` string, required — The native currency name.
- `blockchain_explorer` BlockchainExplorer — A blockchain explorer entry point.
- `transaction_url` string, uri, required
- `address_url` string, uri, required
- `root_url` string, uri, required
- `transaction_format_url` string, uri
- `address_format_url` string, uri
- `asset_format_url` string, uri
- `logo_url` string, uri, required — The logo URL of the chain.
- `is_testnet` boolean, required — Whether the chain is on a testnet.
- `is_enabled` boolean, required — Whether the chain is enabled.
- EnrichedStacksChain
- `chain_type` 'stacks', required — The type of the chain.
- `unique_id` 'stacks_mainnet', required
- `name` string, required — The full blockchain name.
- `native_currency_symbol` string, required — The native currency symbol.
- `native_currency_name` string, required — The native currency name.
- `blockchain_explorer` BlockchainExplorer — A blockchain explorer entry point.
- `transaction_url` string, uri, required
- `address_url` string, uri, required
- `root_url` string, uri, required
- `transaction_format_url` string, uri
- `address_format_url` string, uri
- `asset_format_url` string, uri
- `logo_url` string, uri, required — The logo URL of the chain.
- `is_testnet` boolean, required — Whether the chain is on a testnet.
- `is_enabled` boolean, required — Whether the chain is enabled.
- EnrichedStarknetChain
- `chain_type` 'starknet', required — The type of the chain.
- `unique_id` 'starknet_mainnet', required
- `name` string, required — The full blockchain name.
- `native_currency_symbol` string, required — The native currency symbol.
- `native_currency_name` string, required — The native currency name.
- `blockchain_explorer` BlockchainExplorer — A blockchain explorer entry point.
- `transaction_url` string, uri, required
- `address_url` string, uri, required
- `root_url` string, uri, required
- `transaction_format_url` string, uri
- `address_format_url` string, uri
- `asset_format_url` string, uri
- `logo_url` string, uri, required — The logo URL of the chain.
- `is_testnet` boolean, required — Whether the chain is on a testnet.
- `is_enabled` boolean, required — Whether the chain is enabled.
- EnrichedStellarChain
- `chain_type` 'stellar', required — The type of the chain.
- `unique_id` 'stellar_mainnet' | 'stellar_testnet', required
- `name` string, required — The full blockchain name.
- `native_currency_symbol` string, required — The native currency symbol.
- `native_currency_name` string, required — The native currency name.
- `blockchain_explorer` BlockchainExplorer — A blockchain explorer entry point.
- `transaction_url` string, uri, required
- `address_url` string, uri, required
- `root_url` string, uri, required
- `transaction_format_url` string, uri
- `address_format_url` string, uri
- `asset_format_url` string, uri
- `logo_url` string, uri, required — The logo URL of the chain.
- `is_testnet` boolean, required — Whether the chain is on a testnet.
- `is_enabled` boolean, required — Whether the chain is enabled.
- EnrichedSuiChain
- `chain_type` 'sui', required — The type of the chain.
- `unique_id` 'sui_mainnet' | 'sui_testnet', required
- `name` string, required — The full blockchain name.
- `native_currency_symbol` string, required — The native currency symbol.
- `native_currency_name` string, required — The native currency name.
- `blockchain_explorer` BlockchainExplorer — A blockchain explorer entry point.
- `transaction_url` string, uri, required
- `address_url` string, uri, required
- `root_url` string, uri, required
- `transaction_format_url` string, uri
- `address_format_url` string, uri
- `asset_format_url` string, uri
- `logo_url` string, uri, required — The logo URL of the chain.
- `is_testnet` boolean, required — Whether the chain is on a testnet.
- `is_enabled` boolean, required — Whether the chain is enabled.
- EnrichedTonChain
- `chain_type` 'ton', required — The type of the chain.
- `unique_id` 'ton_mainnet', required
- `name` string, required — The full blockchain name.
- `native_currency_symbol` string, required — The native currency symbol.
- `native_currency_name` string, required — The native currency name.
- `blockchain_explorer` BlockchainExplorer — A blockchain explorer entry point.
- `transaction_url` string, uri, required
- `address_url` string, uri, required
- `root_url` string, uri, required
- `transaction_format_url` string, uri
- `address_format_url` string, uri
- `asset_format_url` string, uri
- `logo_url` string, uri, required — The logo URL of the chain.
- `is_testnet` boolean, required — Whether the chain is on a testnet.
- `is_enabled` boolean, required — Whether the chain is enabled.
- EnrichedTronChain
- `chain_type` 'tron', required — The type of the chain.
- `unique_id` 'tron_mainnet' | 'tron_shasta', required
- `name` string, required — The full blockchain name.
- `native_currency_symbol` string, required — The native currency symbol.
- `native_currency_name` string, required — The native currency name.
- `blockchain_explorer` BlockchainExplorer — A blockchain explorer entry point.
- `transaction_url` string, uri, required
- `address_url` string, uri, required
- `root_url` string, uri, required
- `transaction_format_url` string, uri
- `address_format_url` string, uri
- `asset_format_url` string, uri
- `logo_url` string, uri, required — The logo URL of the chain.
- `is_testnet` boolean, required — Whether the chain is on a testnet.
- `is_enabled` boolean, required — Whether the chain is enabled.
- EnrichedUtxoChain
- `chain_type` 'utxo', required — The type of the chain.
- `unique_id` 'bitcoin_mainnet' | 'bitcoin_testnet' | 'bitcoin_testnet_v4' | 'dogecoin_mainnet' | 'bitcoin_cash_mainnet' | 'pearl_testnet' | 'pearl_mainnet', required
- `name` string, required — The full blockchain name.
- `native_currency_symbol` string, required — The native currency symbol.
- `native_currency_name` string, required — The native currency name.
- `blockchain_explorer` BlockchainExplorer — A blockchain explorer entry point.
- `transaction_url` string, uri, required
- `address_url` string, uri, required
- `root_url` string, uri, required
- `transaction_format_url` string, uri
- `address_format_url` string, uri
- `asset_format_url` string, uri
- `logo_url` string, uri, required — The logo URL of the chain.
- `is_testnet` boolean, required — Whether the chain is on a testnet.
- `is_enabled` boolean, required — Whether the chain is enabled.
- `explorer_url` string, uri — The URL of the related transaction in a blockchain explorer.
- `organization_id` string, uuid, required — The organization that the transaction belongs to.
- `block` Block
- `number` integer, required — The block number.
- `hash` string — The block hash.
- `mined_at` string, date-time, required — The date and time when this block was mined.
- `state` 'waiting_for_approval' | 'waiting_for_signing_trigger' | 'approved' | 'finalized_for_signing' | 'signed' | 'pushed_to_blockchain' | 'mined' | 'completed' | 'aborted' | 'error_pushing_to_blockchain' | 'mined_reverted' | 'completed_reverted' | 'error_signing' | 'stuck' | 'dropped' | 'queued' | 'accelerating' | 'canceling' | 'accelerated' | 'cancelled' | 'insufficient_funds', required
- `state_changes` PushableTransactionStateChange[], required — The state changes of the transaction.
- `changed_at` string, date-time, required — The date and time when the state was changed.
- `reason` 'failed_to_verify_signature' | 'original_transaction_was_completed' | 'stale_nonce' | 'quote_expired' | 'another_dlc_transaction_was_completed' | 'fee_limit_exceeded' | 'not_in_mempool_or_chain' | 'exchange_withdraw_address_not_whitelisted' | 'exchange_invalid_api_key_permissions' | 'exchange_funds_pending_settlement' | 'exchange_withdrawal_limit_exceeded' | 'exchange_security_and_policy_holds' | 'exchange_service_unavailable'
- `previous_state` 'waiting_for_approval' | 'waiting_for_signing_trigger' | 'approved' | 'finalized_for_signing' | 'signed' | 'pushed_to_blockchain' | 'mined' | 'completed' | 'aborted' | 'error_pushing_to_blockchain' | 'mined_reverted' | 'completed_reverted' | 'error_signing' | 'stuck' | 'dropped' | 'queued' | 'accelerating' | 'canceling' | 'accelerated' | 'cancelled' | 'insufficient_funds'
- `new_state` 'waiting_for_approval' | 'waiting_for_signing_trigger' | 'approved' | 'finalized_for_signing' | 'signed' | 'pushed_to_blockchain' | 'mined' | 'completed' | 'aborted' | 'error_pushing_to_blockchain' | 'mined_reverted' | 'completed_reverted' | 'error_signing' | 'stuck' | 'dropped' | 'queued' | 'accelerating' | 'canceling' | 'accelerated' | 'cancelled' | 'insufficient_funds', required
- `aml_check` AmlCheck
- `results` AmlResults
- `scan_status` 'error' | 'timeout' | 'skipped' | 'completed' | 'unsupported_chain' | 'pending', required
- `error_message` string — The error message if the scan failed.
- `scan_results` ChainalysisScanResult
- `type` 'chainalysis', required — The type of the policy.
- `alerts` ChainalysisAlert[], required — The list of alerts.
- `category` Category, required
- …
- `risk_rating` 'low' | 'medium' | 'high' | 'severe', required
- `exposure_type` 'direct' | 'indirect', required
- `service` string — The name of the service as defined by Chainalysis. If null returns, Chainalysis has not yet identified the service's name.
- `external_id` string, uuid, required — A unique identifier of the scan.
- `incoming_aml_check` IncomingAmlCheck
- `policy_match` AmlPolicyMatchIncoming
- `is_default` boolean, required — `True` if this is the default rule, `False` otherwise.
- `rule_id` string, uuid, required — The unique identifier of the rule.
- `rule_name` string, required — The name of the rule.
- `action_type` 'allow' | 'freeze' | 'skip', required
- `users_eligible_to_unfreeze` RequestApprover[] — list of possible approvers
- `user` union, required
- PersonRef
- …
- ApiUserRef
- …
- `modified_at` string, date-time, required — The date and time when this approval was modified.
- `decision` string — The decision of the approver.
- `state` 'pending' | 'approved' | 'unauthorized' | 'not_participated', required — Represents an approval state of a single approver
- `frozen` boolean — Whether the transaction is frozen.
- `mined_result_status` 'success' | 'missing' | 'potentially_partial'
- `simulation_status_result` SimulationStatusResult
- `simulation_status` 'success' | 'failed' | 'reverted' | 'skipped'
- `details` string, required — Details about transaction reversion if occurred.
- `type` 'aptos_transaction', required — Aptos transaction type.
- `aptos_transaction_type_details` union, required — Details of the Aptos transaction based on its type.
- AptosNativeTransferDetails
- `type` 'native_transfer', required — A transaction involving the transfer of APT coin from one address to another.
- `sender` EnrichedAptosAddress, required
- `vault` VaultRef — Represents a reference to a vault in the Fordefi platform
- `id` string, uuid, required — The unique identifier of the vault in the Fordefi platform.
- `vault_group_id` string, uuid — The unique identifier of the vault group this vault belongs to.
- `vault_group_ids` string[], required — The unique identifiers of the vault groups this vault belongs to.
- `name` string, required — The name of the vault.
- `address` string — The address of the vault.
- `state` 'active' | 'archived' | 'deleted' | 'pending' | 'aborted', required
- `type` 'aptos' | 'arch' | 'black_box' | 'canton' | 'cosmos' | 'evm' | 'safe' | 'solana' | 'stacks' | 'starknet' | 'stellar' | 'sui' | 'ton' | 'tron' | 'utxo' | 'exchange', required
- `logo_url` string, uri — The logo of the vault. Supported for exchange and Safe vaults.
- `end_user` EndUserRef
- …
- `is_external_signer` boolean — Whether the vault uses an externally imported key (external signer).
- `explorer_url` string, uri — The URL of a blockchain explorer that provides real-time information about the address.
- `contact` ContactRef — Represents a reference to an address book contact in the Fordefi platform.
- `id` string, uuid, required — The unique identifier of the address book contact in the Fordefi platform.
- `name` string, required — The name of the contact.
- `address_ref` union, required
- …
- `type` 'aptos', required
- `address` string, required — The Aptos address represented in hex format.
- `recipient` EnrichedAptosAddress, required
- `vault` VaultRef — Represents a reference to a vault in the Fordefi platform
- `id` string, uuid, required — The unique identifier of the vault in the Fordefi platform.
- `vault_group_id` string, uuid — The unique identifier of the vault group this vault belongs to.
- `vault_group_ids` string[], required — The unique identifiers of the vault groups this vault belongs to.
- `name` string, required — The name of the vault.
- `address` string — The address of the vault.
- `state` 'active' | 'archived' | 'deleted' | 'pending' | 'aborted', required
- `type` 'aptos' | 'arch' | 'black_box' | 'canton' | 'cosmos' | 'evm' | 'safe' | 'solana' | 'stacks' | 'starknet' | 'stellar' | 'sui' | 'ton' | 'tron' | 'utxo' | 'exchange', required
- `logo_url` string, uri — The logo of the vault. Supported for exchange and Safe vaults.
- `end_user` EndUserRef
- …
- `is_external_signer` boolean — Whether the vault uses an externally imported key (external signer).
- `explorer_url` string, uri — The URL of a blockchain explorer that provides real-time information about the address.
- `contact` ContactRef — Represents a reference to an address book contact in the Fordefi platform.
- `id` string, uuid, required — The unique identifier of the address book contact in the Fordefi platform.
- `name` string, required — The name of the contact.
- `address_ref` union, required
- …
- `type` 'aptos', required
- `address` string, required — The Aptos address represented in hex format.
- `is_internal` boolean — Is this transfer an internal transfer between two vaults. None if the transaction is incoming.
- AptosCoinTransferDetails
- `type` 'coin_transfer', required — A transaction involving the transfer of non-APT coin from one address to another.
- `sender` EnrichedAptosAddress, required
- `vault` VaultRef — Represents a reference to a vault in the Fordefi platform
- `id` string, uuid, required — The unique identifier of the vault in the Fordefi platform.
- `vault_group_id` string, uuid — The unique identifier of the vault group this vault belongs to.
- `vault_group_ids` string[], required — The unique identifiers of the vault groups this vault belongs to.
- `name` string, required — The name of the vault.
- `address` string — The address of the vault.
- `state` 'active' | 'archived' | 'deleted' | 'pending' | 'aborted', required
- `type` 'aptos' | 'arch' | 'black_box' | 'canton' | 'cosmos' | 'evm' | 'safe' | 'solana' | 'stacks' | 'starknet' | 'stellar' | 'sui' | 'ton' | 'tron' | 'utxo' | 'exchange', required
- `logo_url` string, uri — The logo of the vault. Supported for exchange and Safe vaults.
- `end_user` EndUserRef
- …
- `is_external_signer` boolean — Whether the vault uses an externally imported key (external signer).
- `explorer_url` string, uri — The URL of a blockchain explorer that provides real-time information about the address.
- `contact` ContactRef — Represents a reference to an address book contact in the Fordefi platform.
- `id` string, uuid, required — The unique identifier of the address book contact in the Fordefi platform.
- `name` string, required — The name of the contact.
- `address_ref` union, required
- …
- `type` 'aptos', required
- `address` string, required — The Aptos address represented in hex format.
- `recipient` EnrichedAptosAddress, required
- `vault` VaultRef — Represents a reference to a vault in the Fordefi platform
- `id` string, uuid, required — The unique identifier of the vault in the Fordefi platform.
- `vault_group_id` string, uuid — The unique identifier of the vault group this vault belongs to.
- `vault_group_ids` string[], required — The unique identifiers of the vault groups this vault belongs to.
- `name` string, required — The name of the vault.
- `address` string — The address of the vault.
- `state` 'active' | 'archived' | 'deleted' | 'pending' | 'aborted', required
- `type` 'aptos' | 'arch' | 'black_box' | 'canton' | 'cosmos' | 'evm' | 'safe' | 'solana' | 'stacks' | 'starknet' | 'stellar' | 'sui' | 'ton' | 'tron' | 'utxo' | 'exchange', required
- `logo_url` string, uri — The logo of the vault. Supported for exchange and Safe vaults.
- `end_user` EndUserRef
- …
- `is_external_signer` boolean — Whether the vault uses an externally imported key (external signer).
- `explorer_url` string, uri — The URL of a blockchain explorer that provides real-time information about the address.
- `contact` ContactRef — Represents a reference to an address book contact in the Fordefi platform.
- `id` string, uuid, required — The unique identifier of the address book contact in the Fordefi platform.
- `name` string, required — The name of the contact.
- `address_ref` union, required
- …
- `type` 'aptos', required
- `address` string, required — The Aptos address represented in hex format.
- `is_internal` boolean — Is this transfer an internal transfer between two vaults. None if the transaction is incoming.
- AptosEntryPointDetails
- `type` 'entry_point', required — A transaction with an entry point function.
- `recipient` EnrichedAptosAddress, required
- `vault` VaultRef — Represents a reference to a vault in the Fordefi platform
- `id` string, uuid, required — The unique identifier of the vault in the Fordefi platform.
- `vault_group_id` string, uuid — The unique identifier of the vault group this vault belongs to.
- `vault_group_ids` string[], required — The unique identifiers of the vault groups this vault belongs to.
- `name` string, required — The name of the vault.
- `address` string — The address of the vault.
- `state` 'active' | 'archived' | 'deleted' | 'pending' | 'aborted', required
- `type` 'aptos' | 'arch' | 'black_box' | 'canton' | 'cosmos' | 'evm' | 'safe' | 'solana' | 'stacks' | 'starknet' | 'stellar' | 'sui' | 'ton' | 'tron' | 'utxo' | 'exchange', required
- `logo_url` string, uri — The logo of the vault. Supported for exchange and Safe vaults.
- `end_user` EndUserRef
- …
- `is_external_signer` boolean — Whether the vault uses an externally imported key (external signer).
- `explorer_url` string, uri — The URL of a blockchain explorer that provides real-time information about the address.
- `contact` ContactRef — Represents a reference to an address book contact in the Fordefi platform.
- `id` string, uuid, required — The unique identifier of the address book contact in the Fordefi platform.
- `name` string, required — The name of the contact.
- `address_ref` union, required
- …
- `type` 'aptos', required
- `address` string, required — The Aptos address represented in hex format.
- AptosScriptDetails
- `type` 'script', required — A transaction with running a move script.
- `code` string, required — The code of the script.
- `chain` EnrichedAptosChain, required
- `chain_type` 'aptos', required — The type of the chain.
- `unique_id` 'aptos_mainnet' | 'aptos_testnet' | 'aptos_movement_mainnet' | 'aptos_movement_testnet', required
- `name` string, required — The full blockchain name.
- `native_currency_symbol` string, required — The native currency symbol.
- `native_currency_name` string, required — The native currency name.
- `blockchain_explorer` BlockchainExplorer — A blockchain explorer entry point.
- `transaction_url` string, uri, required
- `address_url` string, uri, required
- `root_url` string, uri, required
- `transaction_format_url` string, uri
- `address_format_url` string, uri
- `asset_format_url` string, uri
- `logo_url` string, uri, required — The logo URL of the chain.
- `is_testnet` boolean, required — Whether the chain is on a testnet.
- `is_enabled` boolean, required — Whether the chain is enabled.
- `version` integer — The version of the transaction.
- `nonce` integer — The nonce of the transaction.
- `sender` EnrichedAptosAddress, required
- `vault` VaultRef — Represents a reference to a vault in the Fordefi platform
- `id` string, uuid, required — The unique identifier of the vault in the Fordefi platform.
- `vault_group_id` string, uuid — The unique identifier of the vault group this vault belongs to.
- `vault_group_ids` string[], required — The unique identifiers of the vault groups this vault belongs to.
- `name` string, required — The name of the vault.
- `address` string — The address of the vault.
- `state` 'active' | 'archived' | 'deleted' | 'pending' | 'aborted', required
- `type` 'aptos' | 'arch' | 'black_box' | 'canton' | 'cosmos' | 'evm' | 'safe' | 'solana' | 'stacks' | 'starknet' | 'stellar' | 'sui' | 'ton' | 'tron' | 'utxo' | 'exchange', required
- `logo_url` string, uri — The logo of the vault. Supported for exchange and Safe vaults.
- `end_user` EndUserRef
- `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
- `user_type` 'end_user', required — The type of the user.
- `external_id` string, required — External id of the user.
- `state` 'active' | 'deleted', required — The state of the user.
- `is_external_signer` boolean — Whether the vault uses an externally imported key (external signer).
- `explorer_url` string, uri — The URL of a blockchain explorer that provides real-time information about the address.
- `contact` ContactRef — Represents a reference to an address book contact in the Fordefi platform.
- `id` string, uuid, required — The unique identifier of the address book contact in the Fordefi platform.
- `name` string, required — The name of the contact.
- `address_ref` union, required
- AptosAddressBookContactAddressRef
- `chain_type` 'aptos', required — The type of the chain.
- `address` string, required — The address on the Aptos chain.
- `chains` AptosChain[], required — The chains that the contact belongs to.
- …
- ArchAddressBookContactAddressRef
- `chain_type` 'arch', required — The type of the chain.
- `address` string, required — The address on the Arch chain.
- `chains` ArchChain[], required — The chains the contact belongs to.
- …
- CantonAddressBookContactAddressRef
- `chain_type` 'canton', required — The type of the chain.
- `address` string, required — The party id on the Canton chain.
- `chains` CantonChain[], required — The chains the contact belongs to.
- …
- `memo` string — Memo is an additional address feature used for identifying a recipient.
- CosmosAddressBookContactAddressRef
- `chain_type` 'cosmos', required — The type of the chain.
- `address` string, required — The address on the cosmos chain.
- `chain` CosmosChain, required
- …
- `memo` string — Memo is an additional address feature used for identifying a recipient.
- EVMAddressBookContactAddressRef
- `chain_type` 'evm', required — The type of the chain.
- `address` string, required — The address of the contact.
- `chains` EvmChain[], required — The chains the contact belongs to.
- …
- SolanaAddressBookContactAddressRef
- `chain_type` 'solana', required — The type of the chain.
- `address` string, required — The address on the Solana chain.
- `chains` SolanaChain[], required — The chains the contact belongs to.
- …
- StacksAddressBookContactAddressRef
- `chain_type` 'stacks', required — The type of the chain.
- `address` string, required — The address on the Stacks chain.
- `chains` StacksChain[], required — The chains the contact belongs to.
- …
- `memo` string — Memo is an additional address feature used for identifying a recipient.
- StarknetAddressBookContactAddressRef
- `chain_type` 'starknet', required — The type of the chain.
- `address` string, required — The address on the Starknet chain.
- `chains` StarknetChain[], required — The chains the contact belongs to.
- …
- StellarAddressBookContactAddressRef
- `chain_type` 'stellar', required — The type of the chain.
- `address` string, required — The address on the Stellar chain.
- `chains` StellarChain[], required — The chains the contact belongs to.
- …
- `memo` string — Memo is an additional address feature used for identifying a recipient.
- SuiAddressBookContactAddressRef
- `chain_type` 'sui', required — The type of the chain.
- `address` string, required — The address on the Sui chain.
- `chains` SuiChain[], required — The chains the contact belongs to.
- …
- TonAddressBookContactAddressRef
- `chain_type` 'ton', required — The type of the chain.
- `address` string, required — The address on the TON chain.
- `chains` TonChain[], required — The chains the contact belongs to.
- …
- `comment` string — Comment is an additional address feature used for identifying a recipient.
- TronAddressBookContactAddressRef
- `chain_type` 'tron', required — The type of the chain.
- `address` string, required — The address on the TRON chain.
- `chains` TronChain[], required — The chains the contact belongs to.
- …
- `memo` string — Memo is an additional address feature used for identifying a recipient.
- UtxoAddressBookContactAddressRef
- `chain_type` 'utxo', required — The type of the chain.
- `address` string, required — The address on the utxo chain.
- `chain` UtxoChain, required
- …
- `type` 'aptos', required
- `address` string, required — The Aptos address represented in hex format.
- `payload` union, required — The payload of the transaction.
- AptosEntryFunctionPayload
- `typed_arguments` string[], required — The typed arguments of the transaction.
- `arguments` string[], required — The arguments of the transaction.
- `type` 'entry_point', required
- `function_id` string, required — The entry function of the transaction.
- `address` EnrichedAptosAddress, required
- `vault` VaultRef — Represents a reference to a vault in the Fordefi platform
- `id` string, uuid, required — The unique identifier of the vault in the Fordefi platform.
- `vault_group_id` string, uuid — The unique identifier of the vault group this vault belongs to.
- `vault_group_ids` string[], required — The unique identifiers of the vault groups this vault belongs to.
- `name` string, required — The name of the vault.
- `address` string — The address of the vault.
- `state` 'active' | 'archived' | 'deleted' | 'pending' | 'aborted', required
- `type` 'aptos' | 'arch' | 'black_box' | 'canton' | 'cosmos' | 'evm' | 'safe' | 'solana' | 'stacks' | 'starknet' | 'stellar' | 'sui' | 'ton' | 'tron' | 'utxo' | 'exchange', required
- `logo_url` string, uri — The logo of the vault. Supported for exchange and Safe vaults.
- `end_user` EndUserRef
- …
- `is_external_signer` boolean — Whether the vault uses an externally imported key (external signer).
- `explorer_url` string, uri — The URL of a blockchain explorer that provides real-time information about the address.
- `contact` ContactRef — Represents a reference to an address book contact in the Fordefi platform.
- `id` string, uuid, required — The unique identifier of the address book contact in the Fordefi platform.
- `name` string, required — The name of the contact.
- `address_ref` union, required
- …
- `type` 'aptos', required
- `address` string, required — The Aptos address represented in hex format.
- `module` string, required — The module of the entry function.
- `function_name` string, required — The name of the entry function.
- ScriptPayload
- `typed_arguments` string[], required — The typed arguments of the transaction.
- `arguments` string[], required — The arguments of the transaction.
- `type` 'script', required
- `code` string, required — The script code of the transaction.
- `hash` string — The hash of the transaction.
- `gas_submitted` AptosGasData, required
- `gas_limit` string, required — The gas limit of the transaction.
- `price` AptosGasPrice, required
- `priority_level` 'custom' | 'low' | 'medium' | 'high', required
- `price` string, required — The price per gas unit (in Octa).
- `fiat_price` Price — Price represents a price in a given FiatCurrency.
- `price` string, required — The price in the given fiat currency.
- `price_float` string, required — The absolute price in the given fiat currency. When is_negative is true the asset's value is the negative of this (e.g. a debt token).
- `is_negative` boolean — Whether the asset's value is negative (e.g. a debt token). price_float holds the absolute value.
- `fiat_currency` FiatCurrency, required
- `currency_symbol` 'usd', required — FiatCurrencySymbol
- `decimals` integer, required — The number of decimals in the fiat currency.
- `with_external_fee_payer` boolean — If true, the transaction's Authenticator will be configured to support an external fee payer. After Fordefi signs the transaction, the client is responsible for forwarding it to the designated fee payer for final signing and broadcasting.
- `fee_payer` EnrichedAptosAddress
- `vault` VaultRef — Represents a reference to a vault in the Fordefi platform
- `id` string, uuid, required — The unique identifier of the vault in the Fordefi platform.
- `vault_group_id` string, uuid — The unique identifier of the vault group this vault belongs to.
- `vault_group_ids` string[], required — The unique identifiers of the vault groups this vault belongs to.
- `name` string, required — The name of the vault.
- `address` string — The address of the vault.
- `state` 'active' | 'archived' | 'deleted' | 'pending' | 'aborted', required
- `type` 'aptos' | 'arch' | 'black_box' | 'canton' | 'cosmos' | 'evm' | 'safe' | 'solana' | 'stacks' | 'starknet' | 'stellar' | 'sui' | 'ton' | 'tron' | 'utxo' | 'exchange', required
- `logo_url` string, uri — The logo of the vault. Supported for exchange and Safe vaults.
- `end_user` EndUserRef
- `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
- `user_type` 'end_user', required — The type of the user.
- `external_id` string, required — External id of the user.
- `state` 'active' | 'deleted', required — The state of the user.
- `is_external_signer` boolean — Whether the vault uses an externally imported key (external signer).
- `explorer_url` string, uri — The URL of a blockchain explorer that provides real-time information about the address.
- `contact` ContactRef — Represents a reference to an address book contact in the Fordefi platform.
- `id` string, uuid, required — The unique identifier of the address book contact in the Fordefi platform.
- `name` string, required — The name of the contact.
- `address_ref` union, required
- AptosAddressBookContactAddressRef
- `chain_type` 'aptos', required — The type of the chain.
- `address` string, required — The address on the Aptos chain.
- `chains` AptosChain[], required — The chains that the contact belongs to.
- …
- ArchAddressBookContactAddressRef
- `chain_type` 'arch', required — The type of the chain.
- `address` string, required — The address on the Arch chain.
- `chains` ArchChain[], required — The chains the contact belongs to.
- …
- CantonAddressBookContactAddressRef
- `chain_type` 'canton', required — The type of the chain.
- `address` string, required — The party id on the Canton chain.
- `chains` CantonChain[], required — The chains the contact belongs to.
- …
- `memo` string — Memo is an additional address feature used for identifying a recipient.
- CosmosAddressBookContactAddressRef
- `chain_type` 'cosmos', required — The type of the chain.
- `address` string, required — The address on the cosmos chain.
- `chain` CosmosChain, required
- …
- `memo` string — Memo is an additional address feature used for identifying a recipient.
- EVMAddressBookContactAddressRef
- `chain_type` 'evm', required — The type of the chain.
- `address` string, required — The address of the contact.
- `chains` EvmChain[], required — The chains the contact belongs to.
- …
- SolanaAddressBookContactAddressRef
- `chain_type` 'solana', required — The type of the chain.
- `address` string, required — The address on the Solana chain.
- `chains` SolanaChain[], required — The chains the contact belongs to.
- …
- StacksAddressBookContactAddressRef
- `chain_type` 'stacks', required — The type of the chain.
- `address` string, required — The address on the Stacks chain.
- `chains` StacksChain[], required — The chains the contact belongs to.
- …
- `memo` string — Memo is an additional address feature used for identifying a recipient.
- StarknetAddressBookContactAddressRef
- `chain_type` 'starknet', required — The type of the chain.
- `address` string, required — The address on the Starknet chain.
- `chains` StarknetChain[], required — The chains the contact belongs to.
- …
- StellarAddressBookContactAddressRef
- `chain_type` 'stellar', required — The type of the chain.
- `address` string, required — The address on the Stellar chain.
- `chains` StellarChain[], required — The chains the contact belongs to.
- …
- `memo` string — Memo is an additional address feature used for identifying a recipient.
- SuiAddressBookContactAddressRef
- `chain_type` 'sui', required — The type of the chain.
- `address` string, required — The address on the Sui chain.
- `chains` SuiChain[], required — The chains the contact belongs to.
- …
- TonAddressBookContactAddressRef
- `chain_type` 'ton', required — The type of the chain.
- `address` string, required — The address on the TON chain.
- `chains` TonChain[], required — The chains the contact belongs to.
- …
- `comment` string — Comment is an additional address feature used for identifying a recipient.
- TronAddressBookContactAddressRef
- `chain_type` 'tron', required — The type of the chain.
- `address` string, required — The address on the TRON chain.
- `chains` TronChain[], required — The chains the contact belongs to.
- …
- `memo` string — Memo is an additional address feature used for identifying a recipient.
- UtxoAddressBookContactAddressRef
- `chain_type` 'utxo', required — The type of the chain.
- `address` string, required — The address on the utxo chain.
- `chain` UtxoChain, required
- …
- `type` 'aptos', required
- `address` string, required — The Aptos address represented in hex format.
- `serialized_signed_transaction` string — The serialized signed transaction.
- `expected_result` AptosTransactionResult
- `reversion` AptosReversion, required
- `state` 'not_reverted' | 'unknown_revert' | 'contract_asserted' | 'insufficient_funds_gas_and_value', required
- `reason` string — The reason for the reversion (additional information).
- `fee_statement` AptosFeeStatement, required
- `execution_gas_units` string, required
- `io_gas_units` string, required
- `storage_fee_octas` string, required
- `storage_fee_refund_octas` string, required
- `total_charge_gas_units` string, required
- `total_gas` string, required — The total gas fee of the transaction (in Octa).
- `priced_asset` PricedAsset, required
- `type` 'asset_price', required
- `asset_info` AssetInfo, required
- `id` string, uuid, required — The asset ID.
- `asset_identifier` union, required
- …
- `name` string, required — The name of the asset.
- `symbol` string, required — The symbol (ticker) of the asset.
- `decimals` integer, required
- `verified` boolean, required — `True` if this asset is verified by Fordefi, `False` otherwise.
- `metadata_uri` string — The URI of the asset metadata.
- `is_spam` boolean, required — `True` if this asset is spam, `False` otherwise.
- `logo_url` string, uri — The URL of the asset logo.
- `explorer_url` string, uri — The URL of a blockchain explorer that provides real-time information about the asset.
- `issuer_name` string — Best-effort display name of the issuer
- `price` Price — Price represents a price in a given FiatCurrency.
- `price` string, required — The price in the given fiat currency.
- `price_float` string, required — The absolute price in the given fiat currency. When is_negative is true the asset's value is the negative of this (e.g. a debt token).
- `is_negative` boolean — Whether the asset's value is negative (e.g. a debt token). price_float holds the absolute value.
- `fiat_currency` FiatCurrency, required
- …
- `effects` AptosEffects, required
- `balance_changes` AptosBalanceChangeEffect[], required
- `priced_asset` PricedAsset, required
- `type` 'asset_price', required
- `asset_info` AssetInfo, required
- …
- `price` Price — Price represents a price in a given FiatCurrency.
- …
- `diff` string, required — The amount of that was added to or deducted from the owner's balance. If the amount was deducted, the value is negative; if the amount was added, the value is positive.
- `address` EnrichedAptosAddress, required
- `vault` VaultRef — Represents a reference to a vault in the Fordefi platform
- …
- `explorer_url` string, uri — The URL of a blockchain explorer that provides real-time information about the address.
- `contact` ContactRef — Represents a reference to an address book contact in the Fordefi platform.
- …
- `type` 'aptos', required
- `address` string, required — The Aptos address represented in hex format.
- `transfers` AptosTransferEffect[], required
- `priced_asset` PricedAsset, required
- `type` 'asset_price', required
- `asset_info` AssetInfo, required
- …
- `price` Price — Price represents a price in a given FiatCurrency.
- …
- `amount` string, required — The amount of the transfer.
- `from` EnrichedAptosAddress, required
- `vault` VaultRef — Represents a reference to a vault in the Fordefi platform
- …
- `explorer_url` string, uri — The URL of a blockchain explorer that provides real-time information about the address.
- `contact` ContactRef — Represents a reference to an address book contact in the Fordefi platform.
- …
- `type` 'aptos', required
- `address` string, required — The Aptos address represented in hex format.
- `to` EnrichedAptosAddress, required
- `vault` VaultRef — Represents a reference to a vault in the Fordefi platform
- …
- `explorer_url` string, uri — The URL of a blockchain explorer that provides real-time information about the address.
- `contact` ContactRef — Represents a reference to an address book contact in the Fordefi platform.
- …
- `type` 'aptos', required
- `address` string, required — The Aptos address represented in hex format.
- `raw_result` string — The raw result of the transaction.
- `mined_result` AptosTransactionResult
- `reversion` AptosReversion, required
- `state` 'not_reverted' | 'unknown_revert' | 'contract_asserted' | 'insufficient_funds_gas_and_value', required
- `reason` string — The reason for the reversion (additional information).
- `fee_statement` AptosFeeStatement, required
- `execution_gas_units` string, required
- `io_gas_units` string, required
- `storage_fee_octas` string, required
- `storage_fee_refund_octas` string, required
- `total_charge_gas_units` string, required
- `total_gas` string, required — The total gas fee of the transaction (in Octa).
- `priced_asset` PricedAsset, required
- `type` 'asset_price', required
- `asset_info` AssetInfo, required
- `id` string, uuid, required — The asset ID.
- `asset_identifier` union, required
- …
- `name` string, required — The name of the asset.
- `symbol` string, required — The symbol (ticker) of the asset.
- `decimals` integer, required
- `verified` boolean, required — `True` if this asset is verified by Fordefi, `False` otherwise.
- `metadata_uri` string — The URI of the asset metadata.
- `is_spam` boolean, required — `True` if this asset is spam, `False` otherwise.
- `logo_url` string, uri — The URL of the asset logo.
- `explorer_url` string, uri — The URL of a blockchain explorer that provides real-time information about the asset.
- `issuer_name` string — Best-effort display name of the issuer
- `price` Price — Price represents a price in a given FiatCurrency.
- `price` string, required — The price in the given fiat currency.
- `price_float` string, required — The absolute price in the given fiat currency. When is_negative is true the asset's value is the negative of this (e.g. a debt token).
- `is_negative` boolean — Whether the asset's value is negative (e.g. a debt token). price_float holds the absolute value.
- `fiat_currency` FiatCurrency, required
- …
- `effects` AptosEffects, required
- `balance_changes` AptosBalanceChangeEffect[], required
- `priced_asset` PricedAsset, required
- `type` 'asset_price', required
- `asset_info` AssetInfo, required
- …
- `price` Price — Price represents a price in a given FiatCurrency.
- …
- `diff` string, required — The amount of that was added to or deducted from the owner's balance. If the amount was deducted, the value is negative; if the amount was added, the value is positive.
- `address` EnrichedAptosAddress, required
- … truncated; see the full OpenAPI document linked below
## Other responses
- `400` — Bad Request
- `401` — Unauthorized User
- `403` — Forbidden User
- `404` — Not Found
- `408` — Request Timeout
- `422` — Validation Error
- `429` — Rate Limit Exceeded
- `500` — Unexpected Error
---
[API](https://skmtc.net/fordefi/apis/fordefi-api.md) · [All operations](https://skmtc.net/fordefi/apis/fordefi-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/fordefi/fordefi-api/versions/8014fd69ea17/schema)