> For the complete documentation index, see [llms.txt](https://detected.gitbook.io/detected-api-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://detected.gitbook.io/detected-api-docs/api-reference/forms.md).

# Forms

Forms collect information that the standard onboarding steps don't cover, and can contain a wide variety of inputs. A form can be internal (completed by the compliance team) or customer-facing (completed in the onboarding or verify portals). This section covers the forms available in your account. For the forms assigned to a profile or a representative, and their answers, see the Forms sub-sections of Profiles and Representatives.

## List forms

> Returns the forms available in your account. Use an internal form's ID to assign it to a profile with \*\*Assign an internal form to a profile\*\* (\`PUT /profiles/{uuid}/forms\`).

```json
{"openapi":"3.0.0","info":{"title":"Detected API","version":"v2"},"tags":[{"name":"Forms","description":"Forms collect information that the standard onboarding steps don't cover, and can contain a wide variety of inputs. A form can be internal (completed by the compliance team) or customer-facing (completed in the onboarding or verify portals). This section covers the forms available in your account. For the forms assigned to a profile or a representative, and their answers, see the Forms sub-sections of Profiles and Representatives."}],"servers":[{"url":"https://api.detected.app/api/v2/public","description":"Production"}],"security":[{"AccessToken":[]}],"components":{"securitySchemes":{"AccessToken":{"type":"http","description":"The API uses OAuth 2.0. Request an access token with **Create an access token** (`POST /oauth/token`), sending the client ID and client secret of your integration client, and your account slug. Send the access token in the `Authorization` header of every request, in the format `Authorization: Bearer <access_token>`. The access token carries the scopes set on your integration client in the dashboard. Access tokens expire. When one expires, request a new one.","bearerFormat":"OAuth 2.0 access token","scheme":"bearer"}},"headers":{"X-RateLimit-Limit":{"description":"Maximum number of requests allowed in the rate limit window.","schema":{"type":"number","nullable":false}},"X-RateLimit-Remaining":{"description":"Number of requests remaining in the current rate limit window.","schema":{"type":"number","nullable":false}},"Retry-After":{"description":"Number of seconds to wait before making another request. Returned when the rate limit has been reached.","schema":{"type":"number","nullable":false}},"X-RateLimit-Reset":{"description":"Unix timestamp (in seconds) at which the rate limit resets. Returned when the rate limit has been reached.","schema":{"type":"number","nullable":false}}},"schemas":{"ShortFormResource":{"title":"Short Form Resource","required":["id","label","version","provider","archived","updated_at","created_at"],"properties":{"id":{"description":"Form ID.","type":"integer","nullable":false},"label":{"description":"Label of the form.","type":"string","nullable":false},"applies_to":{"description":"Where the form can be used: `internal_forms` for forms completed by the compliance team, or `entities` and `people` for customer-facing forms.","type":"array","items":{"type":"string"}},"reference":{"description":"Reference of the form.","type":"string","nullable":true},"version":{"description":"Latest version of the form.","type":"integer","nullable":false},"provider":{"description":"Form provider.","type":"string","enum":["vueform"],"nullable":false},"archived":{"description":"Whether the form is archived.","type":"boolean","enum":[false,true],"nullable":false},"updated_at":{"description":"Date and time the form was last updated.","type":"string","nullable":false},"created_at":{"description":"Date and time the form was created.","type":"string","nullable":false}},"type":"object"}},"responses":{"401":{"description":"Unauthorized. The access token is missing, invalid or has expired.","content":{"application/json":{"schema":{"properties":{"message":{"description":"A human-readable description of the error.","type":"string"}},"type":"object"}}}},"429":{"description":"Too Many Requests. You have exceeded the rate limit. Wait for the number of seconds given in the `Retry-After` header before trying again.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"properties":{"message":{"description":"A human-readable description of the error.","type":"string"}},"type":"object"}}}}}},"paths":{"/forms":{"get":{"tags":["Forms"],"summary":"List forms","description":"Returns the forms available in your account. Use an internal form's ID to assign it to a profile with **Assign an internal form to a profile** (`PUT /profiles/{uuid}/forms`).","operationId":"8ba10e9d30e909093f72d15d1a310dc8","responses":{"200":{"description":"OK","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"content":{"application/json":{"schema":{"properties":{"data":{"description":"List of forms","type":"array","items":{"$ref":"#/components/schemas/ShortFormResource"}}},"type":"object"}}}},"401":{"$ref":"#/components/responses/401"},"429":{"$ref":"#/components/responses/429"}}}}}}
```

## Retrieve a form

> Returns a single form, including its schema and sections. Use its schema to build the request for \*\*Submit answers to a profile form\*\* (\`POST /profiles/{uuid}/forms/{id}/answers\`).

```json
{"openapi":"3.0.0","info":{"title":"Detected API","version":"v2"},"tags":[{"name":"Forms","description":"Forms collect information that the standard onboarding steps don't cover, and can contain a wide variety of inputs. A form can be internal (completed by the compliance team) or customer-facing (completed in the onboarding or verify portals). This section covers the forms available in your account. For the forms assigned to a profile or a representative, and their answers, see the Forms sub-sections of Profiles and Representatives."}],"servers":[{"url":"https://api.detected.app/api/v2/public","description":"Production"}],"security":[{"AccessToken":[]}],"components":{"securitySchemes":{"AccessToken":{"type":"http","description":"The API uses OAuth 2.0. Request an access token with **Create an access token** (`POST /oauth/token`), sending the client ID and client secret of your integration client, and your account slug. Send the access token in the `Authorization` header of every request, in the format `Authorization: Bearer <access_token>`. The access token carries the scopes set on your integration client in the dashboard. Access tokens expire. When one expires, request a new one.","bearerFormat":"OAuth 2.0 access token","scheme":"bearer"}},"parameters":{"formId":{"name":"id","in":"path","description":"ID of the form.","required":true,"schema":{"type":"integer","nullable":false}}},"headers":{"X-RateLimit-Limit":{"description":"Maximum number of requests allowed in the rate limit window.","schema":{"type":"number","nullable":false}},"X-RateLimit-Remaining":{"description":"Number of requests remaining in the current rate limit window.","schema":{"type":"number","nullable":false}},"Retry-After":{"description":"Number of seconds to wait before making another request. Returned when the rate limit has been reached.","schema":{"type":"number","nullable":false}},"X-RateLimit-Reset":{"description":"Unix timestamp (in seconds) at which the rate limit resets. Returned when the rate limit has been reached.","schema":{"type":"number","nullable":false}}},"schemas":{"FormResource":{"title":"Form Resource","required":["id","label","version","provider","archived","updated_at","created_at"],"properties":{"id":{"description":"Form ID.","type":"integer","nullable":false},"label":{"description":"Label of the form.","type":"string","nullable":false},"applies_to":{"description":"Where the form can be used: `internal_forms` for forms completed by the compliance team, or `entities` and `people` for customer-facing forms.","type":"array","items":{"type":"string"}},"reference":{"description":"Reference of the form.","type":"string","nullable":true},"version":{"description":"Latest version of the form.","type":"integer","nullable":false},"provider":{"description":"Form provider.","type":"string","enum":["vueform"],"nullable":false},"schema":{"description":"The form's fields, keyed by field name, in the provider's (Vueform) format. The structure varies by field type. Use these field names as the keys when you submit answers with **Submit answers to a profile form** (`POST /profiles/{uuid}/forms/{id}/answers`).","type":"object","additionalProperties":true},"sections":{"description":"The form's pages, in the provider's (Vueform) format. Empty when the form has no sections."},"archived":{"description":"Whether the form is archived.","type":"boolean","enum":[false,true],"nullable":false},"updated_at":{"description":"Date and time the form was last updated.","type":"string","nullable":false},"created_at":{"description":"Date and time the form was created.","type":"string","nullable":false}},"type":"object"}},"responses":{"401":{"description":"Unauthorized. The access token is missing, invalid or has expired.","content":{"application/json":{"schema":{"properties":{"message":{"description":"A human-readable description of the error.","type":"string"}},"type":"object"}}}},"404":{"description":"Not Found. The requested resource does not exist, or is not available to your account.","content":{"application/json":{"schema":{"properties":{"message":{"description":"A human-readable description of the error.","type":"string"},"error":{"description":"Machine-readable details of the error.","type":"object","properties":{"key":{"description":"Error code, for example `error.generic`.","type":"string"},"params":{"description":"Values used in the error message, if any.","type":"array","items":{}}}}},"type":"object"}}}},"429":{"description":"Too Many Requests. You have exceeded the rate limit. Wait for the number of seconds given in the `Retry-After` header before trying again.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"properties":{"message":{"description":"A human-readable description of the error.","type":"string"}},"type":"object"}}}}}},"paths":{"/forms/{id}":{"get":{"tags":["Forms"],"summary":"Retrieve a form","description":"Returns a single form, including its schema and sections. Use its schema to build the request for **Submit answers to a profile form** (`POST /profiles/{uuid}/forms/{id}/answers`).","operationId":"bd696dace533bdf31386a45ed00c6b4e","parameters":[{"$ref":"#/components/parameters/formId"}],"responses":{"200":{"description":"OK","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/FormResource"}},"type":"object"}}}},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://detected.gitbook.io/detected-api-docs/api-reference/forms.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.