---
title: "Retrieve a form"
method: GET
path: "/v1/forms/{form_id}"
tags: ["Form"]
---

# Retrieve a form

`GET /v1/forms/{form_id}`

## Request

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

## Path parameters

- `form_id` string, required

## Response `200`

Retrieves form if the UUID exists

- object
  - `data` FormWithAssociations
    - `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
    - `business_information` BusinessInformation, nullable
      - `id` string
      - `form_id` string
      - `document_ids` string[]
      - `business_country` string, required
      - `company_name` string, required
      - `trading_name` string, nullable
      - `legal_entity_type` string, required
      - `sector` string, required
      - `company_registration_number` string, nullable
      - `vat_number` string, nullable
      - `incorporation_date` string, date, required
      - `business_website` string, nullable
      - `business_activity_description` string, required
      - `registered_address` object, required
        - `city` string, required
        - `street` string, required
        - `country` string, required
        - `postal_code` string, required
        - `apartment_number` string, nullable
        - `building_name` string, nullable
        - `building_number` string, nullable
        - `state_or_province` string, nullable
      - `trading_address` object
        - `city` string, required
        - `street` string, required
        - `country` string, required
        - `postal_code` string, required
        - `apartment_number` string, nullable
        - `building_name` string, nullable
        - `building_number` string, nullable
        - `state_or_province` string, nullable
      - `created_at` string, date-time
      - `updated_at` string, date-time
    - `account_usage` 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
    - `people` Person[]
      - `id` string, required
      - `form_id` string
      - `document_ids` string[]
      - `roles` string[], required
      - `first_name` string, required
      - `middle_name` string, nullable
      - `last_name` string, required
      - `dob` string, date, nullable
      - `phone_number` string, nullable
      - `email` string, nullable
      - `ownership_percentage` number
      - `id_number` string, nullable
      - `home_country` string, required
      - `passport_number` string, nullable
      - `passport_country_of_issue` string, nullable
      - `personal_address` object
        - `city` string
        - `street` string
        - `country` string
        - `postal_code` string
        - `apartment_number` string, nullable
        - `building_name` string, nullable
        - `building_number` string, nullable
        - `state_or_province` string, nullable
      - `created_at` string, date-time
      - `updated_at` string, date-time

## Other responses

- `404`: Record not found - Invalid UUID

## Changes

- **2022-09-01** `e3fe8184a3dd`: 3 info
  - added the optional property `data/agreed_to_corporate_authority` to the response with the `200` status
  - added the optional property `data/detached_document_ids` to the response with the `200` status
  - added the required property `data/products_required` to the response with the `200` status
- **2022-08-31** `c563da3e870a`: 1 breaking, 5 info
  - removed the required property `data/people/items/user_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/account_usage/document_ids` to the response with the `200` status
  - …2 more

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