generated: '2026-10-12'
method: derived
generator: derive-vocabulary.py
source:
- openapi/weavr-access-token-api-openapi.yml
- openapi/weavr-access-tokens-api-openapi.yml
- openapi/weavr-accounts-api-openapi.yml
- openapi/weavr-additional-factors-api-openapi.yml
- openapi/weavr-authentication-factors-api-openapi.yml
vocabulary:
  name: Weavr Domain Vocabulary
  description: 'Terms declared by Weavr''s own API contract: its resource groups, objects and enumerations, with the contract''s definitions.
    Derived, not authored.'
  version: '2026-10-12'
  terms:
  - term: Access Token
    definition: Acquire a token granting you access to perform sensitive operations on behalf of an identity.
    tags:
    - Resource Group
    source: openapi/weavr-access-token-api-openapi.yml
  - term: Access Tokens
    definition: Acquire and revoke access tokens.
    tags:
    - Resource Group
    source: openapi/weavr-access-tokens-api-openapi.yml
  - term: Authentication Factors
    definition: Manage user authentication factors, including passwords and device-based factors (OTP and push).
    tags:
    - Resource Group
    source: openapi/weavr-authentication-factors-api-openapi.yml
  - term: Authentication Factors Webhooks
    definition: Notification of the Authentication Factors that are used for the `Identity`.
    tags:
    - Resource Group
    source: openapi/weavr-authentication-factors-webhooks-api-openapi.yml
  - term: Authorised Signatories
    definition: Verify the email of root users who act as authorised signatories of a Corporate or Consumer identity.
    tags:
    - Resource Group
    source: openapi/weavr-authorised-signatories-api-openapi.yml
  - term: Authorised Users
    definition: Corporate and Consumer identities can invite authorised users to access their account.
    tags:
    - Resource Group
    source: openapi/weavr-authorised-users-api-openapi.yml
  - term: Buyer Authorised Users
    definition: Buyers can invite authorised users to access their account. Once on-boarded, authorised users can transact on behalf of the identity
      they are on-boarded with. Authorised users are typically employees who have access to company's banking accounts. Note that `/users` endpoints
      are to be used only for performing operations related to authorised users - getting or updating the details of _admin_ users
    tags:
    - Resource Group
    source: openapi/weavr-buyer-authorised-users-api-openapi.yml
  - term: Buyers
    definition: Buyers are identities representing a business Once on-boarded, Buyers can create payment runs and pay their suppliers in your
      application.
    tags:
    - Resource Group
    source: openapi/weavr-buyers-api-openapi.yml
  - term: Buyers Webhooks
    definition: Buyers are identities representing companies. Once on-boarded, Buyers can create and manage their own instruments via your application.
    tags:
    - Resource Group
    source: openapi/weavr-buyers-webhooks-api-openapi.yml
  - term: Card Payments
    definition: Retrieve card payment activity, including authorisations, settlements, and related events.
    tags:
    - Resource Group
    source: openapi/weavr-card-payments-api-openapi.yml
  - term: Confirmation Challenges
    definition: Issue and verify confirmation challenges used to authorise lists of resources.
    tags:
    - Resource Group
    source: openapi/weavr-confirmation-challenges-api-openapi.yml
  - term: Correspondent Bank Transfers
    definition: Correspondent bank transfers allow financial institutions to initiate wire transfers on behalf of originators (third parties).
      These transfers comply with travel rule requirements by capturing and transmitting originator information.
    tags:
    - Resource Group
    source: openapi/weavr-correspondent-bank-transfers-api-openapi.yml
  - term: Customer Data & Due Diligence
    definition: Manage customer profile data and KYC/KYB due diligence flows for corporates and consumers.
    tags:
    - Resource Group
    source: openapi/weavr-customer-data-due-diligence-api-openapi.yml
  - term: Incoming Wire Transfers
    definition: Incoming wire transfers received from external bank accounts to managed accounts with IBANs.
    tags:
    - Resource Group
    source: openapi/weavr-incoming-wire-transfers-api-openapi.yml
  - term: Institutions
    definition: Institutions supported by Embedded Payment Run.
    tags:
    - Resource Group
    source: openapi/weavr-institutions-api-openapi.yml
  - term: Linked Accounts Webhooks
    definition: Notification that the status of a Linked Account has been updated.
    tags:
    - Resource Group
    source: openapi/weavr-linked-accounts-webhooks-api-openapi.yml
  - term: Managed Accounts
    definition: Managed Accounts are a type of financial instrument offered by Weavr.
    tags:
    - Resource Group
    source: openapi/weavr-managed-accounts-api-openapi.yml
  - term: Managed Cards
    definition: Managed Cards are a type of financial instrument offered by Weavr.
    tags:
    - Resource Group
    source: openapi/weavr-managed-cards-api-openapi.yml
  - term: Outgoing Wire Transfers
    definition: The Outgoing Wire Transfer transaction is used to transfer funds from managed accounts to an external bank account.
    tags:
    - Resource Group
    source: openapi/weavr-outgoing-wire-transfers-api-openapi.yml
  - term: Payment Runs
    definition: A Payment run contains a list of supplier payments.
    tags:
    - Resource Group
    source: openapi/weavr-payment-runs-api-openapi.yml
  - term: Payment runs Webhooks
    definition: Notification that the Payment Run and payment statuses have been updated.
    tags:
    - Resource Group
    source: openapi/weavr-payment-runs-webhooks-api-openapi.yml
  - term: Sends
    definition: The Send transaction is used to send funds between managed accounts and managed cards belonging to different identities.
    tags:
    - Resource Group
    source: openapi/weavr-sends-api-openapi.yml
  - term: Setup
    definition: Register and manage the lifecycle of users that can access an identity, including authorised users invited by a Corporate or Consumer
      root user.
    tags:
    - Resource Group
    source: openapi/weavr-setup-api-openapi.yml
  - term: Sign In
    definition: Sign users in using passwords, biometrics, or third-party auth providers.
    tags:
    - Resource Group
    source: openapi/weavr-sign-in-api-openapi.yml
  - term: Simulator
    definition: 'Simulators enable you to trigger processes in Sandbox that in Production are triggered from an external action rather than from
      your application. this way you can test scenarios that otherwise you would only encounter in the Live environment. *Note: These endpoints
      are only available on Sandbox and won’t work in the Live environment.*'
    tags:
    - Resource Group
    source: openapi/weavr-simulator-api-openapi.yml
  - term: Spend Controls
    definition: Manage spend rules and authorisation forwarding to approve or reject card payments in real time.
    tags:
    - Resource Group
    source: openapi/weavr-spend-controls-api-openapi.yml
  - term: Step-up Challenges
    definition: Issue and verify step-up challenges that elevate an existing user token.
    tags:
    - Resource Group
    source: openapi/weavr-step-up-challenges-api-openapi.yml
  - term: Stepup Webhooks
    definition: Notification that a step-up has been completed or declined.
    tags:
    - Resource Group
    source: openapi/weavr-stepup-webhooks-api-openapi.yml
  - term: Tokens Webhooks
    definition: Tokens webhooks
    tags:
    - Resource Group
    source: openapi/weavr-tokens-webhooks-api-openapi.yml
  - term: Transaction Activity
    definition: Retrieve the consolidated transaction activity across instruments.
    tags:
    - Resource Group
    source: openapi/weavr-transaction-activity-api-openapi.yml
  - term: Transactions Webhooks
    definition: Notification that the status of a transaction has been updated.
    tags:
    - Resource Group
    source: openapi/weavr-transactions-webhooks-api-openapi.yml
  - term: Trusted Payees
    definition: Manage a list of trusted payees for Outgoing wire transfers and Sends. Aside from convenience and a reduced chance of making errors
      when making transactions, this allows for the introduction an SCA exemption, where the account holder can request that transactions to `TRUSTED`
      payees to be exempted from the requirement to pass an SCA challenge every time.
    tags:
    - Resource Group
    source: openapi/weavr-trusted-payees-api-openapi.yml
  - term: CredentialId
    definition: 'Object declared by the contract with fields: type, id.'
    tags:
    - Object
    source: openapi/weavr-access-token-api-openapi.yml#/components/schemas/CredentialId
  - term: ValidationError
    definition: Is returned as part of an HTTP error response whenever a validation error is detected. A list of the fields together with their
      syntax error will be provided.
    tags:
    - Object
    source: openapi/weavr-access-token-api-openapi.yml#/components/schemas/ValidationError
  - term: IdentityId
    definition: 'Object declared by the contract with fields: type, id.'
    tags:
    - Object
    source: openapi/weavr-access-token-api-openapi.yml#/components/schemas/IdentityId
  - term: Error
    definition: 'Object declared by the contract with fields: code, message.'
    tags:
    - Object
    source: openapi/weavr-access-token-api-openapi.yml#/components/schemas/Error
  - term: TokenResponse
    definition: 'Object declared by the contract with fields: token.'
    tags:
    - Object
    source: openapi/weavr-access-token-api-openapi.yml#/components/schemas/TokenResponse
  - term: ImpersonateIdentityLoginRequest
    definition: 'Object declared by the contract with fields: identity, temp.'
    tags:
    - Object
    source: openapi/weavr-access-token-api-openapi.yml#/components/schemas/ImpersonateIdentityLoginRequest
  - term: SyntaxError
    definition: Is returned as part of an HTTP error response whenever a syntax error is detected. A list of the fields together with their syntax
      error will be provided.
    tags:
    - Object
    source: openapi/weavr-access-tokens-api-openapi.yml#/components/schemas/SyntaxError
  - term: TransferType
    definition: 'Enumeration declared by the contract with values: SEPA, FASTER_PAYMENTS, SWIFT, BACS, CHAPS, RIX.'
    tags:
    - Enumeration
    source: openapi/weavr-accounts-api-openapi.yml#/components/schemas/TransferType
  - term: CurrencyAmount
    definition: A message representing a monetary amount in a particular currency.
    tags:
    - Object
    source: openapi/weavr-accounts-api-openapi.yml#/components/schemas/CurrencyAmount
  - term: FieldValidationType
    definition: 'Enumeration declared by the contract with values: REQUIRED, HAS_TEXT, REQUIRES, SIZE, RANGE, IN, NOT_IN, REGEX, EXACTLY, AT_LEAST,
      AT_MOST, ALL_OR_NONE.'
    tags:
    - Enumeration
    source: openapi/weavr-accounts-api-openapi.yml#/components/schemas/FieldValidationType
  - term: AccountDescriptorDetails
    definition: 'Object declared by the contract with fields: accountDescriptor.'
    tags:
    - Object
    source: openapi/weavr-accounts-api-openapi.yml#/components/schemas/AccountDescriptorDetails
  - term: DefaultError
    definition: A default error model in case of errors other than 400, 409 or 504.
    tags:
    - Object
    source: openapi/weavr-accounts-api-openapi.yml#/components/schemas/DefaultError
  - term: DepositResponseDepositResponseCode1
    definition: 'Enumeration declared by the contract with values: COMPLETED, DENIED_ACCOUNT_NOT_FOUND, DENIED_AMOUNT_NOT_POSITIVE, DENIED_CURRENCY_NOT_ACCOUNT_CURRENCY,
      DENIED_ACCOUNT_INACTIVE, DENIED_INVALID_TX_ID, DENIED_OTHER, DENIED_ACCOUNT_NOT_UPGRADED_TO_IBAN.'
    tags:
    - Enumeration
    source: openapi/weavr-accounts-api-openapi.yml#/components/schemas/DepositResponseDepositResponseCode1
  - term: DepositRequestByAccountId
    definition: 'Object declared by the contract with fields: depositAmount, senderName, reference, receiverName, txId, senderIban, sepa, fasterPayments,
      accountDescriptor, paymentNetwork.'
    tags:
    - Object
    source: openapi/weavr-accounts-api-openapi.yml#/components/schemas/DepositRequestByAccountId
  - term: FasterPaymentsBankDetails
    definition: 'Object declared by the contract with fields: accountNumber, sortCode.'
    tags:
    - Object
    source: openapi/weavr-accounts-api-openapi.yml#/components/schemas/FasterPaymentsBankDetails
  - term: DepositRequest
    definition: 'Object declared by the contract with fields: iban, paymentReference, depositAmount, senderName, reference, receiverName, txId,
      senderIbanDetails, senderFasterPaymentsDetails, senderAccountDescriptorDetails, destinationIbanDetails, destinationFasterPaymentsDetails.
      (1 more)'
    tags:
    - Object
    source: openapi/weavr-accounts-api-openapi.yml#/components/schemas/DepositRequest
  - term: FieldValidationErrors
    definition: 'Object declared by the contract with fields: name, errors.'
    tags:
    - Object
    source: openapi/weavr-accounts-api-openapi.yml#/components/schemas/FieldValidationErrors
  - term: DepositResponse1
    definition: 'Object declared by the contract with fields: code.'
    tags:
    - Object
    source: openapi/weavr-accounts-api-openapi.yml#/components/schemas/DepositResponse1
  - term: FieldValidation
    definition: 'Object declared by the contract with fields: type, params.'
    tags:
    - Object
    source: openapi/weavr-accounts-api-openapi.yml#/components/schemas/FieldValidation
  - term: DepositResponse0
    definition: 'Object declared by the contract with fields: code.'
    tags:
    - Object
    source: openapi/weavr-accounts-api-openapi.yml#/components/schemas/DepositResponse0
  - term: IBANDetails
    definition: 'Object declared by the contract with fields: iban, bankIdentifierCode.'
    tags:
    - Object
    source: openapi/weavr-accounts-api-openapi.yml#/components/schemas/IBANDetails
  - term: FasterPaymentsDetails
    definition: 'Object declared by the contract with fields: sortCode, accountNumber, secondaryReference.'
    tags:
    - Object
    source: openapi/weavr-accounts-api-openapi.yml#/components/schemas/FasterPaymentsDetails
  - term: MessageValidation
    definition: 'Object declared by the contract with fields: invalid, fields.'
    tags:
    - Object
    source: openapi/weavr-accounts-api-openapi.yml#/components/schemas/MessageValidation
  - term: ClientInvalidRequest
    definition: 'Object declared by the contract with fields: message, validation.'
    tags:
    - Object
    source: openapi/weavr-accounts-api-openapi.yml#/components/schemas/ClientInvalidRequest
  - term: DepositResponseDepositResponseCode0
    definition: 'Enumeration declared by the contract with values: COMPLETED, DENIED_ACCOUNT_NOT_FOUND, DENIED_AMOUNT_NOT_POSITIVE, DENIED_CURRENCY_NOT_ACCOUNT_CURRENCY,
      DENIED_ACCOUNT_INACTIVE, DENIED_INVALID_TX_ID, DENIED_OTHER.'
    tags:
    - Enumeration
    source: openapi/weavr-accounts-api-openapi.yml#/components/schemas/DepositResponseDepositResponseCode0
  - term: IbanDetails
    definition: 'Object declared by the contract with fields: iban, bankIdentifierCode.'
    tags:
    - Object
    source: openapi/weavr-accounts-api-openapi.yml#/components/schemas/IbanDetails
  - term: SCAChannel
    definition: '- "SMS": The one-time-password is sent as a text message - "AUTHY": The push notification is sent to an Authy application - "BIOMETRIC":
      The push notification is sent to an innovator application'
    tags:
    - Enumeration
    source: openapi/weavr-authentication-factors-api-openapi.yml#/components/schemas/SCAChannel
  - term: SCAFactor
    definition: 'Object declared by the contract with fields: type, status, channel.'
    tags:
    - Object
    source: openapi/weavr-authentication-factors-api-openapi.yml#/components/schemas/SCAFactor
  - term: Nonce
    definition: A randomly generated one-time use code.
    tags:
    - Object
    source: openapi/weavr-authentication-factors-api-openapi.yml#/components/schemas/Nonce
  - term: SensitivePassword
    definition: 'The user''s password or passcode used to log in a user. Passwords must be: - minimum 8 characters for end-users (Consumers and
      Corporates); 12 characters for others - maximum 30 characters - include a lowercase character - include an uppercase character - include
      a digit and a special character - different from any of the 5 last such passwords used. For non-PCI compliant integrations, the password '
    tags:
    - Object
    source: openapi/weavr-authentication-factors-api-openapi.yml#/components/schemas/SensitivePassword
  - term: SCAPushChannel
    definition: '- "AUTHY": The push notification is sent on the user''s device using [Twilio Authy](https://www.twilio.com/authy) - "BIOMETRIC":
      The push notification is sent to the user''s device'
    tags:
    - Enumeration
    source: openapi/weavr-authentication-factors-api-openapi.yml#/components/schemas/SCAPushChannel
  - term: PasswordInfo
    definition: Additional information related to the user's password.
    tags:
    - Object
    source: openapi/weavr-authentication-factors-api-openapi.yml#/components/schemas/PasswordInfo
  - term: AuthSCAPushChannel
    definition: '- "AUTHY": The push notification is sent on the user''s device using [Twilio Authy](https://www.twilio.com/authy)'
    tags:
    - Enumeration
    source: openapi/weavr-authentication-factors-api-openapi.yml#/components/schemas/AuthSCAPushChannel
  - term: Email
    definition: E-mail Address of the user
    tags:
    - Object
    source: openapi/weavr-authentication-factors-api-openapi.yml#/components/schemas/Email
  - term: SCAOtpChannel
    definition: '- "SMS": The one-time-password is sent as a text message'
    tags:
    - Enumeration
    source: openapi/weavr-authentication-factors-api-openapi.yml#/components/schemas/SCAOtpChannel
  - term: SCAFactorStatus
    definition: 'The state of the factor type. - `PENDING_VERIFICATION` : The user has started the enrolment process but still hasn''t completed
      enrolment. Challenges cannot be used before they are verified. - `ACTIVE` : The user has successfully completed enrolment and the challenge
      can be used to verify transactions. - `INACTIVE` : The user has rejected the enrolment.'
    tags:
    - Enumeration
    source: openapi/weavr-authentication-factors-api-openapi.yml#/components/schemas/SCAFactorStatus
  - term: SCAChallengeType
    definition: '- "OTP": The OTP is sent as a text message - "PUSH": The authorisation request is sent as a push notification - "BIOMETRIC":
      The push notification is sent via Firebase to a mobile application'
    tags:
    - Enumeration
    source: openapi/weavr-authentication-factors-api-openapi.yml#/components/schemas/SCAChallengeType
  - term: TokenError
    definition: The used token is expired or not found
    tags:
    - Object
    source: openapi/weavr-authentication-factors-api-openapi.yml#/components/schemas/TokenError
  - term: EnrolmentEventEnrolmentStatus
    definition: 'Enumeration declared by the contract with values: ACTIVE, INACTIVE.'
    tags:
    - Enumeration
    source: openapi/weavr-authentication-factors-api-openapi.yml#/components/schemas/EnrolmentEventEnrolmentStatus
  - term: EnrolmentEvent
    definition: 'Object declared by the contract with fields: credentialId, type, status, publishedTimestamp.'
    tags:
    - Object
    source: openapi/weavr-authentication-factors-api-openapi.yml#/components/schemas/EnrolmentEvent
  - term: VerificationCode
    definition: A randomly generated one-time use code used to verify the user's email address or mobile number.
    tags:
    - Object
    source: openapi/weavr-authorised-signatories-api-openapi.yml#/components/schemas/VerificationCode
  - term: UserLocale
    definition: BCP47 locale code (e.g. en, en-US). The locale determines which email and SMS user notification templates are used.
    tags:
    - Object
    source: openapi/weavr-authorised-users-api-openapi.yml#/components/schemas/UserLocale
  - term: Date
    definition: 'Object declared by the contract with fields: year, month, day.'
    tags:
    - Object
    source: openapi/weavr-authorised-users-api-openapi.yml#/components/schemas/Date
  - term: Tag
    definition: The tag field is a custom field that can be used to search and filter.
    tags:
    - Object
    source: openapi/weavr-authorised-users-api-openapi.yml#/components/schemas/Tag
  - term: User
    definition: 'Object declared by the contract with fields: id, identity, name, surname, email, mobile, active, dateOfBirth, tag, countryOfResidence,
      locale, brand. (1 more)'
    tags:
    - Object
    source: openapi/weavr-authorised-users-api-openapi.yml#/components/schemas/User
  - term: Mobile
    definition: 'Object declared by the contract with fields: countryCode, number.'
    tags:
    - Object
    source: openapi/weavr-authorised-users-api-openapi.yml#/components/schemas/Mobile
  - term: UserPredefinedRole
    definition: 'Enumeration declared by the contract with values: CARD_ASSIGNEE, CARDS_MANAGEMENT_ROLE, FUNDS_MANAGEMENT_ROLE, ACCESS_MANAGEMENT_ROLE,
      ADMIN.'
    tags:
    - Enumeration
    source: openapi/weavr-authorised-users-api-openapi.yml#/components/schemas/UserPredefinedRole
  - term: Brand
    definition: Brand identifier used to determine the set of email and SMS user notification templates. Must be alphanumeric, up to 25 characters,
      and contain no spaces.
    tags:
    - Object
    source: openapi/weavr-authorised-users-api-openapi.yml#/components/schemas/Brand