---
title: "Form data"
method: GET
path: "/v1/form"
tags: ["Capture"]
---

# Form data

`GET /v1/form`

## Request

- Base URL: `https://api.ocrolus.com`
- URL: `https://api.ocrolus.com/v1/form`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://auth.ocrolus.com/oauth/token`

Retrieve field data for a <<glossary:Form>>.

---

A detailed description of the response can be found on the [Form data](https://docs.ocrolus.com/docs/form-data) data type definition.

## Query parameters

- `uuid` string
- `pk` integer

## Response `200`

Success

- object
  - `status` integer: A numerical code that indicates the status of the request.
  - `response` object: A single Form object.
    - `pk` integer: Unique primary key of the Form.
    - `id` integer: Same value as `pk`.
    - `uuid` string, uuid: Universally unique identifier (UUID) of the Form.
    - `form_type` string: The <<glossary:Document>> type of the Form.
    - `raw_fields` object: An object containing the data captured from the Form. The structure varies by form type.
      - `examplefield:field_name` object: Information recorded from the uploaded Document.
        - `value` string: The recorded value found in the field.
        - `is_empty` boolean: Describes if the field contains information.
        - `alias_used` string: Alias used for the field.
        - `source_filename` string: The source of the information recorded in the field.
        - `confidence` number: The confidence score associated with this field.
    - `other_frauds` unknown[]: Fraud signals detected for this Form, if any.
      - unknown
    - `doc_validations` object: A summary of validation results for the form. Present only when the validation summaries option is configured for your account. If not configured, this field is omitted.
  - `message` string: A textual description that indicates details about this response's status.

## Other responses

- `400`: Client Errors
- `500`: Internal Server Error

---

[API](https://skmtc.dev/ocrolus/apis/capture.md) - [All operations](https://skmtc.dev/ocrolus/apis/capture/llms.txt) - [OpenAPI document](https://skmtc.dev/ocrolus/apis/capture/revisions/4bc747954163?raw)