generated: '2026-10-12'
method: derived
generator: derive-vocabulary.py
source:
- openapi/unstoppable-finance-addresses-api-openapi.yml
- openapi/unstoppable-finance-autoramp-api-openapi.yml
- openapi/unstoppable-finance-currencies-api-openapi.yml
- openapi/unstoppable-finance-customer-api-openapi.yml
- openapi/unstoppable-finance-exchange-rate-api-openapi.yml
vocabulary:
  name: Unstoppable Finance (Iron) Domain Vocabulary
  description: 'Terms declared by Unstoppable Finance (Iron)''s own API contract: its resource groups, objects and enumerations, with the contract''s
    definitions. Derived, not authored.'
  version: '2026-10-12'
  terms:
  - term: Addresses
    definition: Wallet and bank account registration Every wallet address that interacts with Iron must be registered (linked) to a customer **before**
      it can be used in any flow — onramp, offramp, or swap.
    tags:
    - Resource Group
    source: openapi/unstoppable-finance-addresses-api-openapi.yml
  - term: Autoramp
    definition: Operations on Autoramp
    tags:
    - Resource Group
    source: openapi/unstoppable-finance-autoramp-api-openapi.yml
  - term: Currencies
    definition: Operations on Currencies
    tags:
    - Resource Group
    source: openapi/unstoppable-finance-currencies-api-openapi.yml
  - term: Customer
    definition: Operations on Customers
    tags:
    - Resource Group
    source: openapi/unstoppable-finance-customer-api-openapi.yml
  - term: Exchange Rate
    definition: Operations on Exchange Rate
    tags:
    - Resource Group
    source: openapi/unstoppable-finance-exchange-rate-api-openapi.yml
  - term: Fee Profiles
    definition: Operations on Fee Profiles
    tags:
    - Resource Group
    source: openapi/unstoppable-finance-fee-profiles-api-openapi.yml
  - term: Sandbox
    definition: Operations for Sandbox Testing
    tags:
    - Resource Group
    source: openapi/unstoppable-finance-sandbox-api-openapi.yml
  - term: Terms And Conditions
    definition: Operations on Terms and Conditions
    tags:
    - Resource Group
    source: openapi/unstoppable-finance-terms-and-conditions-api-openapi.yml
  - term: Webhooks
    definition: Operations on Webhooks
    tags:
    - Resource Group
    source: openapi/unstoppable-finance-webhooks-api-openapi.yml
  - term: PixAccountIdentifier_PixEvpKey
    definition: 'PixAccountIdentifier How the recipient''s PIX account is identified: a DICT key of one of the five key types, or full bank account
      details.'
    tags:
    - Object
    source: openapi/unstoppable-finance-addresses-api-openapi.yml#/components/schemas/PixAccountIdentifier_PixEvpKey
  - term: IndividualName
    definition: 'Object declared by the contract with fields: family_name, given_name.'
    tags:
    - Object
    source: openapi/unstoppable-finance-addresses-api-openapi.yml#/components/schemas/IndividualName
  - term: PixAccountIdentifier
    definition: 'PixAccountIdentifier How the recipient''s PIX account is identified: a DICT key of one of the five key types, or full bank account
      details.'
    tags:
    - Object
    source: openapi/unstoppable-finance-addresses-api-openapi.yml#/components/schemas/PixAccountIdentifier
  - term: PixCpfKey
    definition: PixCpfKey A PIX DICT key that is the recipient's CPF.
    tags:
    - Object
    source: openapi/unstoppable-finance-addresses-api-openapi.yml#/components/schemas/PixCpfKey
  - term: BankAccountFPSIdentifier
    definition: 'Object declared by the contract with fields: account_number, sort_code.'
    tags:
    - Object
    source: openapi/unstoppable-finance-addresses-api-openapi.yml#/components/schemas/BankAccountFPSIdentifier
  - term: PagedList_FiatAddress
    definition: PagedList A list of items with cursors used to fetch the next or previous page
    tags:
    - Object
    source: openapi/unstoppable-finance-addresses-api-openapi.yml#/components/schemas/PagedList_FiatAddress
  - term: PixEvpKey
    definition: PixEvpKey A random PIX DICT key (EVP) generated by the recipient's bank.
    tags:
    - Object
    source: openapi/unstoppable-finance-addresses-api-openapi.yml#/components/schemas/PixEvpKey
  - term: AddressType
    definition: 'Enumeration declared by the contract with values: Hosted, SelfHosted.'
    tags:
    - Enumeration
    source: openapi/unstoppable-finance-addresses-api-openapi.yml#/components/schemas/AddressType
  - term: SelfHostedWalletResponse
    definition: Self-Hosted Wallet Response Response containing self-hosted wallet details
    tags:
    - Object
    source: openapi/unstoppable-finance-addresses-api-openapi.yml#/components/schemas/SelfHostedWalletResponse
  - term: RecipientBankAccount
    definition: RecipientBankAccount A recipient fiat bank account
    tags:
    - Object
    source: openapi/unstoppable-finance-addresses-api-openapi.yml#/components/schemas/RecipientBankAccount
  - term: PixCnpjKey
    definition: PixCnpjKey A PIX DICT key that is the recipient's CNPJ.
    tags:
    - Object
    source: openapi/unstoppable-finance-addresses-api-openapi.yml#/components/schemas/PixCnpjKey
  - term: RecipientPix
    definition: RecipientPix A PIX payout recipient.
    tags:
    - Object
    source: openapi/unstoppable-finance-addresses-api-openapi.yml#/components/schemas/RecipientPix
  - term: EmailAddress
    definition: EmailAddress An email address An email address
    tags:
    - Object
    source: openapi/unstoppable-finance-addresses-api-openapi.yml#/components/schemas/EmailAddress
  - term: FiatAddress
    definition: Fiat Address Response containing fiat address details
    tags:
    - Object
    source: openapi/unstoppable-finance-addresses-api-openapi.yml#/components/schemas/FiatAddress
  - term: FiatAddressStatus
    definition: Verification Status The status of the verification of a fiat address
    tags:
    - Enumeration
    source: openapi/unstoppable-finance-addresses-api-openapi.yml#/components/schemas/FiatAddressStatus
  - term: BankAccountWireIdentifier
    definition: 'Object declared by the contract with fields: account_number, routing_number.'
    tags:
    - Object
    source: openapi/unstoppable-finance-addresses-api-openapi.yml#/components/schemas/BankAccountWireIdentifier
  - term: BankAccountCHAPSIdentifier
    definition: 'Object declared by the contract with fields: account_number, sort_code.'
    tags:
    - Object
    source: openapi/unstoppable-finance-addresses-api-openapi.yml#/components/schemas/BankAccountCHAPSIdentifier
  - term: RegisterPixAddressRequest
    definition: Register PIX Address Request Request to register a PIX payout destination (Brazil / BRL).
    tags:
    - Object
    source: openapi/unstoppable-finance-addresses-api-openapi.yml#/components/schemas/RegisterPixAddressRequest
  - term: RegisterHostedWalletRequest
    definition: Hosted wallet registration request Register a VASP-custodied wallet address for Travel Rule compliance
    tags:
    - Object
    source: openapi/unstoppable-finance-addresses-api-openapi.yml#/components/schemas/RegisterHostedWalletRequest
  - term: ApiError
    definition: Standard error response returned to API clients for server errors. Includes a trace_id that clients can reference when reporting
      issues.
    tags:
    - Object
    source: openapi/unstoppable-finance-addresses-api-openapi.yml#/components/schemas/ApiError
  - term: PixEmailKey
    definition: PixEmailKey A PIX DICT key that is the recipient's email address.
    tags:
    - Object
    source: openapi/unstoppable-finance-addresses-api-openapi.yml#/components/schemas/PixEmailKey
  - term: RegisterFiatAddressRequest
    definition: Register Fiat Address Request Request to register a fiat (bank) address
    tags:
    - Object
    source: openapi/unstoppable-finance-addresses-api-openapi.yml#/components/schemas/RegisterFiatAddressRequest
  - term: PixAccountIdentifier_PixCnpjKey
    definition: 'PixAccountIdentifier How the recipient''s PIX account is identified: a DICT key of one of the five key types, or full bank account
      details.'
    tags:
    - Object
    source: openapi/unstoppable-finance-addresses-api-openapi.yml#/components/schemas/PixAccountIdentifier_PixCnpjKey
  - term: PixAddress
    definition: PIX Address Response containing PIX destination details.
    tags:
    - Object
    source: openapi/unstoppable-finance-addresses-api-openapi.yml#/components/schemas/PixAddress
  - term: PixAccountIdentifier_PixBankDetails
    definition: 'PixAccountIdentifier How the recipient''s PIX account is identified: a DICT key of one of the five key types, or full bank account
      details.'
    tags:
    - Object
    source: openapi/unstoppable-finance-addresses-api-openapi.yml#/components/schemas/PixAccountIdentifier_PixBankDetails
  - term: PixAccountType
    definition: PixAccountType The type of a Brazilian bank account.
    tags:
    - Enumeration
    source: openapi/unstoppable-finance-addresses-api-openapi.yml#/components/schemas/PixAccountType
  - term: VerifiedAddressResponse
    definition: Verified Address Response Response containing verified address details
    tags:
    - Object
    source: openapi/unstoppable-finance-addresses-api-openapi.yml#/components/schemas/VerifiedAddressResponse
  - term: RecipientPostalAddress
    definition: RecipientPostalAddress The account holder's address.
    tags:
    - Object
    source: openapi/unstoppable-finance-addresses-api-openapi.yml#/components/schemas/RecipientPostalAddress
  - term: BankAccountFedNowIdentifier
    definition: 'Object declared by the contract with fields: account_number, routing_number.'
    tags:
    - Object
    source: openapi/unstoppable-finance-addresses-api-openapi.yml#/components/schemas/BankAccountFedNowIdentifier
  - term: PixPhoneKey
    definition: PixPhoneKey A PIX DICT key that is the recipient's phone number.
    tags:
    - Object
    source: openapi/unstoppable-finance-addresses-api-openapi.yml#/components/schemas/PixPhoneKey
  - term: Fiat
    definition: A fiat currency
    tags:
    - Object
    source: openapi/unstoppable-finance-addresses-api-openapi.yml#/components/schemas/Fiat
  - term: PagedList_PixAddress
    definition: PagedList A list of items with cursors used to fetch the next or previous page
    tags:
    - Object
    source: openapi/unstoppable-finance-addresses-api-openapi.yml#/components/schemas/PagedList_PixAddress
  - term: RegisterSelfHostedWalletRequest
    definition: Self-hosted wallet registration request Proof of wallet ownership to register a self-hosted wallet for Travel Rule compliance
    tags:
    - Object
    source: openapi/unstoppable-finance-addresses-api-openapi.yml#/components/schemas/RegisterSelfHostedWalletRequest
  - term: PixAddressStatus
    definition: PIX Address Status
    tags:
    - Enumeration
    source: openapi/unstoppable-finance-addresses-api-openapi.yml#/components/schemas/PixAddressStatus
  - term: VaspSuggestion
    definition: Minimal VASP suggestion for hosted wallet providers
    tags:
    - Object
    source: openapi/unstoppable-finance-addresses-api-openapi.yml#/components/schemas/VaspSuggestion
  - term: BankAccountSWIFTIdentifier
    definition: 'Object declared by the contract with fields: account_number, bic, intermediary_bic.'
    tags:
    - Object
    source: openapi/unstoppable-finance-addresses-api-openapi.yml#/components/schemas/BankAccountSWIFTIdentifier
  - term: PixAccountIdentifier_PixEmailKey
    definition: 'PixAccountIdentifier How the recipient''s PIX account is identified: a DICT key of one of the five key types, or full bank account
      details.'
    tags:
    - Object
    source: openapi/unstoppable-finance-addresses-api-openapi.yml#/components/schemas/PixAccountIdentifier_PixEmailKey
  - term: BankPostalAddress
    definition: BankPostalAddress The bank's address. Only required for SWIFT accounts.
    tags:
    - Object
    source: openapi/unstoppable-finance-addresses-api-openapi.yml#/components/schemas/BankPostalAddress
  - term: BankAccountACHIdentifier
    definition: 'Object declared by the contract with fields: account_number, routing_number.'
    tags:
    - Object
    source: openapi/unstoppable-finance-addresses-api-openapi.yml#/components/schemas/BankAccountACHIdentifier
  - term: BusinessName
    definition: 'Object declared by the contract with fields: name.'
    tags:
    - Object
    source: openapi/unstoppable-finance-addresses-api-openapi.yml#/components/schemas/BusinessName
  - term: AddressFilter
    definition: Filter for address types when retrieving signatures Specifies which type of addresses to return
    tags:
    - Enumeration
    source: openapi/unstoppable-finance-addresses-api-openapi.yml#/components/schemas/AddressFilter
  - term: PixAccountIdentifier_PixCpfKey
    definition: 'PixAccountIdentifier How the recipient''s PIX account is identified: a DICT key of one of the five key types, or full bank account
      details.'
    tags:
    - Object
    source: openapi/unstoppable-finance-addresses-api-openapi.yml#/components/schemas/PixAccountIdentifier_PixCpfKey
  - term: Country
    definition: A country
    tags:
    - Object
    source: openapi/unstoppable-finance-addresses-api-openapi.yml#/components/schemas/Country
  - term: PixAccountIdentifier_PixPhoneKey
    definition: 'PixAccountIdentifier How the recipient''s PIX account is identified: a DICT key of one of the five key types, or full bank account
      details.'
    tags:
    - Object
    source: openapi/unstoppable-finance-addresses-api-openapi.yml#/components/schemas/PixAccountIdentifier_PixPhoneKey
  - term: Iban
    definition: 'Object declared by the contract with fields: iban.'
    tags:
    - Object
    source: openapi/unstoppable-finance-addresses-api-openapi.yml#/components/schemas/Iban
  - term: RegisterSelfAttestedWalletRequest
    definition: Self-attested wallet registration request Register a self-hosted wallet the customer declares as their own, **without** a cryptographic
      signature. For direct customers who can't sign from a custody UI (e.g. Fireblocks). Scoped to US and RoW customers.
    tags:
    - Object
    source: openapi/unstoppable-finance-addresses-api-openapi.yml#/components/schemas/RegisterSelfAttestedWalletRequest
  - term: Blockchain
    definition: Blockchain A type of blockchain
    tags:
    - Enumeration
    source: openapi/unstoppable-finance-addresses-api-openapi.yml#/components/schemas/Blockchain
  - term: BankAccountRTPIdentifier
    definition: 'Object declared by the contract with fields: account_number, routing_number.'
    tags:
    - Object
    source: openapi/unstoppable-finance-addresses-api-openapi.yml#/components/schemas/BankAccountRTPIdentifier
  - term: UpdateDisabledStatusRequest
    definition: Request to update the disabled status of a verified crypto address
    tags:
    - Object
    source: openapi/unstoppable-finance-addresses-api-openapi.yml#/components/schemas/UpdateDisabledStatusRequest
  - term: PixBankDetails
    definition: PixBankDetails Full Brazilian bank account details identifying the recipient's account, for recipients without a registered PIX
      key.
    tags:
    - Object
    source: openapi/unstoppable-finance-addresses-api-openapi.yml#/components/schemas/PixBankDetails
  - term: CountrySubdivision
    definition: 'Object declared by the contract with fields: code, name.'
    tags:
    - Object
    source: openapi/unstoppable-finance-addresses-api-openapi.yml#/components/schemas/CountrySubdivision
  - term: RampTransactionSource
    definition: The source of the autoramp transaction
    tags:
    - Object
    source: openapi/unstoppable-finance-autoramp-api-openapi.yml#/components/schemas/RampTransactionSource
  - term: CreateAutoramp
    definition: Either a set of market parameters or a signed quote. Optionally include a `type` field (`market` | `quote`) to get precise validation
      errors.
    tags:
    - Object
    source: openapi/unstoppable-finance-autoramp-api-openapi.yml#/components/schemas/CreateAutoramp
  - term: DepositAccount_MobileMoneyDepositInfo
    definition: 'DepositAccount DEPRECATED: please use the deposit_rails field instead'
    tags:
    - Object
    source: openapi/unstoppable-finance-autoramp-api-openapi.yml#/components/schemas/DepositAccount_MobileMoneyDepositInfo
  - term: Account
    definition: Account The account for the autoramp
    tags:
    - Object
    source: openapi/unstoppable-finance-autoramp-api-openapi.yml#/components/schemas/Account
  - term: Recipient_RecipientPix
    definition: Recipient The recipient of the payment
    tags:
    - Object
    source: openapi/unstoppable-finance-autoramp-api-openapi.yml#/components/schemas/Recipient_RecipientPix
  - term: Crypto
    definition: A cryptocurrency
    tags:
    - Object
    source: openapi/unstoppable-finance-autoramp-api-openapi.yml#/components/schemas/Crypto
  - term: Fee
    definition: Fee The fee for a given currency pair
    tags:
    - Object
    source: openapi/unstoppable-finance-autoramp-api-openapi.yml#/components/schemas/Fee
  - term: CreateAutorampParameters
    definition: Create Autoramp Parameters The parameters required to create a autoramp
    tags:
    - Object
    source: openapi/unstoppable-finance-autoramp-api-openapi.yml#/components/schemas/CreateAutorampParameters
  - term: CreateAutorampOpenBankingPayment
    definition: Create Autoramp Payment Link Payload The parameters for creating an autoramp payment link
    tags:
    - Object
    source: openapi/unstoppable-finance-autoramp-api-openapi.yml#/components/schemas/CreateAutorampOpenBankingPayment
  - term: PagedList_AutorampTransaction
    definition: PagedList A list of items with cursors used to fetch the next or previous page
    tags:
    - Object
    source: openapi/unstoppable-finance-autoramp-api-openapi.yml#/components/schemas/PagedList_AutorampTransaction
  - term: CryptoWallet
    definition: Crypto Wallet The crypto wallet for the autoramp
    tags:
    - Object
    source: openapi/unstoppable-finance-autoramp-api-openapi.yml#/components/schemas/CryptoWallet
  - term: DepositAccount
    definition: 'DepositAccount DEPRECATED: please use the deposit_rails field instead'
    tags:
    - Object
    source: openapi/unstoppable-finance-autoramp-api-openapi.yml#/components/schemas/DepositAccount
  - term: AutorampQuote
    definition: Autoramp Quote The autoramp quote used to create an autoramp
    tags:
    - Object
    source: openapi/unstoppable-finance-autoramp-api-openapi.yml#/components/schemas/AutorampQuote
  - term: SpeiDepositInfo
    definition: 'Object declared by the contract with fields: clabe, instruction.'
    tags:
    - Object
    source: openapi/unstoppable-finance-autoramp-api-openapi.yml#/components/schemas/SpeiDepositInfo
  - term: FeeSettlement
    definition: Fee Settlement The settlement type for the fee
    tags:
    - Enumeration
    source: openapi/unstoppable-finance-autoramp-api-openapi.yml#/components/schemas/FeeSettlement
  - term: ApiBankAccountSource
    definition: A bank account source of an autoramp transaction
    tags:
    - Object
    source: openapi/unstoppable-finance-autoramp-api-openapi.yml#/components/schemas/ApiBankAccountSource
  - term: SignedAutorampQuote
    definition: Signed Autoramp Quote The signed autoramp quote
    tags:
    - Object
    source: openapi/unstoppable-finance-autoramp-api-openapi.yml#/components/schemas/SignedAutorampQuote
  - term: DepositAccount_SpeiDepositInfo
    definition: 'DepositAccount DEPRECATED: please use the deposit_rails field instead'
    tags:
    - Object
    source: openapi/unstoppable-finance-autoramp-api-openapi.yml#/components/schemas/DepositAccount_SpeiDepositInfo
  - term: Currency
    definition: Currency Can be either crypto or fiat
    tags:
    - Object
    source: openapi/unstoppable-finance-autoramp-api-openapi.yml#/components/schemas/Currency
  - term: Currency_Fiat
    definition: Currency Can be either crypto or fiat
    tags:
    - Object
    source: openapi/unstoppable-finance-autoramp-api-openapi.yml#/components/schemas/Currency_Fiat