1. Welcome
FOMO API (v20260326)
  • Welcome
    • Onboarding
    • Webhook
    • Version History
  • OAuth2
    • Request an access token
      POST
  • Storage
    • Overview 🗺️
    • File
      • Create a file
      • Retrieve a file
      • Download file content
  • Simulator
    • Overview 🗺️
    • MCP for AI Agents ✨
      • JSON Configuration
    • Incoming Transfer
      • Create an incoming transfer
  • Treasury
    • Overview 🗺️
    • MCP for AI Agents ✨
      • (Option 1) MCP Bundles (Recommended)
      • (Option 2) JSON Configuration (Most Compatible)
    • Account
      • Retrieve an account
      • List accounts
    • Balance
      • Retrieve a balance
      • List balances
    • Transaction
      • Retrieve a transaction
      • List transactions
    • Virtual Account
      • Retrieve a virtual account
      • List virtual accounts
    • Account Holder
      • Retrieve an account holder
      • List account holders
    • Outgoing Transfer
      • Retrieve an outgoing transfer
      • List outgoing transfers
    • Incoming Transfer
      • Retrieve an incoming transfer
      • List incoming transfers
    • Internal Transfer
      • Retrieve an internal transfer
      • List internal transfers
    • Beneficiary
      • Retrieve a beneficiary
      • List beneficiaries
    • Beneficiary Account
      • Retrieve a beneficiary account
      • List beneficiary accounts
    • Quote
      • Retrieve a quote
      • List quotes
    • Trade
      • Retrieve a trade
      • List trades
    • Intents
      • Account Holder Creation
        • Create an account holder creation intent
        • Confirm an account holder creation intent
        • Retrieve an account holder creation intent
        • List account holder creation intents
      • Outgoing Transfer Creation
        • Create an outgoing transfer creation intent
        • Confirm an outgoing transfer creation intent
        • Retrieve an outgoing transfer creation intent
        • List outgoing transfer creation intents
      • Virtual Account Creation
        • Create a virtual account creation intent
        • Set account holder for virtual account creation intent
        • Set account name for virtual account creation intent
        • Set external account for virtual account creation intent
        • Confirm a virtual account creation intent
        • Retrieve a virtual account creation intent
        • List virtual account creation intents
      • Virtual Account Update
        • Create a virtual account update intent
        • Set account name for virtual account update intent
        • Confirm a virtual account update intent
        • Retrieve a virtual account update intent
        • List virtual account update intents
      • Virtual Account Closure
        • Create a virtual account closure intent
        • Confirm a virtual account closure intent
        • Retrieve a virtual account update intent
        • List virtual account update intents
      • Beneficiary Creation
        • Create a beneficiary creation intent
        • Confirm a beneficiary creation intent
        • Retrieve a beneficiary creation intent
        • List beneficiary creation intents
      • Beneficiary Account Creation
        • Create a beneficiary account creation intent
        • Confirm a beneficiary account creation intent
        • Retrieve a beneficiary account creation intent
        • List beneficiary account creation intents
      • Quote Creation
        • Create a quote creation intent
        • Confirm a quote creation intent
        • Retrieve a quote creation intent
        • List quote creation intents
      • Trade Creation
        • Create a trade creation intent
        • Confirm a trade creation intent
        • Retrieve a trade creation intent
        • List trade creation intents
      • Trade Cancellation
        • Create a trade cancellation intent
        • Confirm a trade cancellation intent
        • Retrieve a trade cancellation intent
        • List trade cancellation intents
      • Internal Transfer Creation
        • Create an internal transfer creation intent
        • Confirm an internal transfer creation intent
        • Retrieve an internal transfer creation intent
        • List internal transfer creation intents
  • Compliance
    • Party
      • Retrieve a party
      • List parties
    • Party Attribute
      • Retrieve a party attribute
      • List party attributes
    • Verification
      • Retrieve a verification
      • List verifications
    • Disclosure Consent
      • Retrieve a disclosure consent
      • List disclosure consents
    • Requirement
      • Retrieve a requirement
      • List requirements
    • Capability Grant
      • Retrieve a capability grant
      • List capability grants
    • Collection Session
      • Retrieve a collection session
      • List collection sessions
    • Evidence
      • Retrieve an evidence
      • List evidences
    • Screening
      • Retrieve a screening
      • List screenings
    • Crypto Address
      • Retrieve a crypto address
      • List crypto addresses
    • Travel Rule Message
      • Retrieve a travel rule message
      • List travel rule messages
    • Partner Access
      • Retrieve a partner access
      • List partner accesses
    • Crypto Address Declaration
      • Retrieve a crypto address declaration
      • List crypto address declarations
    • Requirement Type
      • Retrieve a requirement type
      • List requirement types
    • Capability
      • Check a capability
    • Partner
      • Retrieve a partner
      • List partners
    • Intents
      • Verification Creation
        • Create a verification creation intent
        • Set share token for verification creation intent
        • Answer a requirement for verification creation intent
        • Confirm a verification creation intent
        • Retrieve a verification creation intent
        • List verification creation intents
      • Verification Update
        • Create a verification update intent
        • Answer a requirement for verification update intent
        • Confirm a verification update intent
        • Retrieve a verification update intent
        • List verification update intents
      • Party Creation
        • Create a party creation intent
        • Confirm a party creation intent
        • Retrieve a party creation intent
        • List party creation intents
      • Party Attribute Creation
        • Create a party attribute creation intent
        • Confirm a party attribute creation intent
        • Retrieve a party attribute creation intent
        • List party attribute creation intents
      • Party Attribute Update
        • Create a party attribute update intent
        • Confirm a party attribute update intent
        • Retrieve a party attribute update intent
        • List party attribute update intents
      • Crypto Address Creation
        • Create a crypto address creation intent
        • Confirm a crypto address creation intent
        • Retrieve a crypto address creation intent
        • List crypto address creation intents
      • Partner Access Creation
        • Create a partner access creation intent
        • Confirm a partner access creation intent
        • Retrieve a partner access creation intent
        • List partner access creation intents
      • Crypto Address Declaration
        • Create a crypto address declaration intent
        • Confirm a crypto address declaration intent
        • Retrieve a crypto address declaration intent
        • List crypto address declaration intents
  1. Welcome

Webhook

Webhooks are a way for your apps to get notified of events. Such as when:
a new transaction has been posted to your account
a pending transaction has been cancelled
your account balance has changed
a virtual account has been created
a virtual account has been suspended due to suspicious transaction
and much more ...
If you would like to opt-in for webhook events, you may do so by contacting your account manager. They will assist setting up your webhooks and provide you a secret for each of the webhooks.
You may register for more than one webhooks. Each webhook may listen for a different set of events and post to a different destination.
Webhook events will be notified to all matching webhooks by HTTP POST.

Webhook payload#

WebhookEvent

Verifying webhook notifications#

Webhook notifications carry the following headers
KeyValue
x-fomo-webhook-version1
x-fomo-webhook-signatureSignature in hexadecimal
content-typeapplication/json
The signature is calculated by applying HMAC-SHA256 to the webhook payload (HTTP body) using the secret for the webhook.
If you have multiple webhooks configured, please make sure you are using the correct secret for each of the webhooks.
If the computed signature does not match the signature provided in the webhook header, the message must be rejected, as it may indicate payload tampering.

Webhook delivery#

Notifications will be retried multiple times if FOMO did not get a successful acknowledgement from the webhook endpoint. The interval between each notification increases exponentially.
You may acknowledge the webhook event by responding HTTP status 200 to the notification. By acknowledging the webhook event, the same webhook event will not be notified again. However, you must be able to handle cases where the same event is notified multiple times. You may identify if events in multiple notifications for a webhook are the same by comparing the event id. Each event carries an unique event id.
Previous
Onboarding
Next
Version History
Built with