---
title: "How the placed fields divide between the parties the form names"
method: GET
path: "/api/v1/documents/{id}/form-fields/parties"
tags: ["Documents"]
---

# How the placed fields divide between the parties the form names

`GET /api/v1/documents/{id}/form-fields/parties`

## Request

- Base URL: `https://api.korala.ai`
- URL: `https://api.korala.ai/api/v1/documents/{id}/form-fields/parties`
- Auth: one of:
  - API key in header `X-API-Key`
  - `bearer` (a scheme the document does not define)

A fillable PDF says where every box is but never who fills it, so an automatic import assigns the whole form to the first signer. This reads the parties the form itself names — employer and employee, landlord and tenant — from each field's tooltip and its name, so a sender can hand each section to the right signer. A form that names nobody is offered its own layout instead, cut along its widest breaks into as many unlabelled sections as there are signers. Returns an empty list for a single-party form such as a W-9, which is the common case.

## Path parameters

- `id` string, required

## Response `200`

- FormFieldPartyDto[]
  - `key` string, required: Stable key for this party, used when assigning it
  - `name` string, required
  - `evidence` string, required: Why the form was read this way, in words the sender can check against the document in front of them
  - `pages` number[], required
  - `fieldCount` number, required
  - `source` 'named' | 'layout', required: How the split was arrived at. "named" means the form names this party itself — an employer, a tenant — and the fields are its section. "layout" means it does not, or not in a language we read, so the form was cut along its widest visible breaks into as many parts as there are signers: unlabelled, and offered for the sender to assign rather than proposed as fact.
  - `signerIds` string[], required: Signers these fields are currently assigned to
  - `fieldIds` string[], required: Ids of this party's fields, for highlighting them while the sender decides who fills the section.

## Other responses

- `400`: Malformed UUID in path parameter (`id`).

---

[API](https://skmtc.dev/korala/apis/korala-public-api.md) · [All operations](https://skmtc.dev/korala/apis/korala-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/korala/apis/korala-public-api/revisions/5c4d7810c507?raw)