---
title: "Submit the form"
method: POST
path: "/v1/forms/{form_id}/submit"
tags: ["Form"]
---

# Submit the form

`POST /v1/forms/{form_id}/submit`

## Request

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

## Path parameters

- `form_id` string, required

## Response `200`

Successful response

- object
  - `data` Form
    - `id` string, required
    - `detached_document_ids` string[]
    - `affiliate_code` string, nullable
    - `agreed_to_marketing_emails` boolean, required
    - `agreed_to_terms_and_conditions` boolean, required
    - `agreed_to_corporate_authority` boolean
    - `country` string, required
    - `email` string
    - `entity_type` string, required
    - `brand_name` string, required
    - `brand_key` string
    - `referred_by` string, nullable
    - `products_required` string[], required
    - `state` string
    - `phone_number` string
    - `contact_name` string
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required

## Other responses

- `422`: Form already submitted

## Changes

- **2022-09-01** `e3fe8184a3dd`: 1 info
  - added the required property `data/products_required` to the response with the `200` status
- **2022-08-31** `c563da3e870a`: 1 breaking, 3 info
  - removed the required property `data/products_required` from the response with the `200` status
  - 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/detached_document_ids` to the response with the `200` status

[Operation history](https://skmtc.dev/currencycloud/apis/api-onboarding/changes/v1/forms/:form_id/submit/post.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)