---
title: "Update a form's associated account usage"
method: PUT
path: "/v1/forms/{form_id}/account_usage"
tags: ["Account Usage"]
---

# Update a form's associated account usage

`PUT /v1/forms/{form_id}/account_usage`

## Request

- Base URL: `https://devapi.currencycloud.com/onboarding`
- URL: `https://devapi.currencycloud.com/onboarding/v1/forms/{form_id}/account_usage`
- Auth: API key in header `X-Auth-Token`
- TypeScript: <https://skmtc.dev/currencycloud/apis/api-onboarding/docs/v1/forms/:form_id/account_usage/put.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `form_id` string, required

## Request body

- CreateAccountUsageRequest
  - `document_ids` string[], nullable
  - `collections_account` boolean, required
  - `collection_currencies` string[]
  - `payment_currencies` string[]
  - `transaction_countries` string[]
  - `one_off_transaction` boolean
  - `estimated_monthly_transaction_currency` string, nullable
  - `estimated_monthly_transaction_value` integer, nullable
  - `estimated_monthly_transaction_volume` integer, 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_details` string, nullable

## Response `200`

Updates account usage when correct params are provided

- object
  - `data` AccountUsage, nullable
    - `id` string
    - `form_id` string
    - `document_ids` string[]
    - `collections_account` boolean, required
    - `collection_currencies` string[]
    - `payment_currencies` string[]
    - `transaction_countries` string[]
    - `one_off_transaction` boolean, required
    - `estimated_monthly_transaction_currency` string, nullable
    - `estimated_monthly_transaction_value` integer, nullable
    - `estimated_monthly_transaction_volume` integer, nullable
    - `source_of_funds` string, nullable
    - `primary_purpose` string, nullable
    - `purpose_details` string, nullable
    - `created_at` string, date-time
    - `updated_at` string, date-time

## Other responses

- `400`: Returns error if any request body schema validation fails
- `404`: Form not found
- `422`: Form is already submitted

## Changes

- **2022-08-31** `c563da3e870a`: 3 info
  - the endpoint scheme security `AuthToken` was added to the API
  - the endpoint scheme security `JWT` was removed from the API
  - added the optional property `data/document_ids` to the response with the `200` status

[Operation history](https://skmtc.dev/currencycloud/apis/api-onboarding/changes/v1/forms/:form_id/account_usage/put.md)

---

[API](https://skmtc.dev/currencycloud/apis/api-onboarding.md) - [All operations](https://skmtc.dev/currencycloud/apis/api-onboarding/llms.txt) - [OpenAPI document](https://skmtc.dev/currencycloud/apis/api-onboarding/revisions/e3fe8184a3dd?raw)