Account Usage

Update a form's associated account usage

Changed on
put/v1/forms/{form_id}/account_usage

Request

Path parameters

form_idstring required

Request body

document_idsstring[] nullable
collections_accountboolean required
collection_currenciesstring[]
payment_currenciesstring[]
transaction_countriesstring[]
one_off_transactionboolean
estimated_monthly_transaction_currencystring nullable
estimated_monthly_transaction_valueinteger nullable
estimated_monthly_transaction_volumeinteger nullable
source_of_funds'business_revenue' | 'external_investment' | 'loan' | 'donations_or_grants' | 'inter_company_transfers' | 'sale_of_assets' | 'other' nullable
primary_purpose'intercompany_transfers' | 'liquidity_or_fx' | 'payment_to_an_individual' | 'paying_suppliers_or_bills' | 'investment_activity' | 'repatriating_overseas_earnings' | 'collecting_funds_from_clients' | 'property_purchase_or_sale' | 'other' required
purpose_detailsstring nullable

Response

Updates account usage when correct params are provided

Changes

    • info

      the endpoint scheme security AuthToken was added to the API

    • info

      the endpoint scheme security JWT was removed from the API

    • info

      added the optional property / to the response with the status