Documents

How the placed fields divide between the parties the form names

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.

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)

Path parameters

idstring required

Response

keystring required

Stable key for this party, used when assigning it

namestring required
evidencestring required

Why the form was read this way, in words the sender can check against the document in front of them

pagesnumber[] required
fieldCountnumber 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.

signerIdsstring[] required

Signers these fields are currently assigned to

fieldIdsstring[] required

Ids of this party's fields, for highlighting them while the sender decides who fills the section.

Example response

[
  {
    "key": "employer",
    "name": "Employer",
    "evidence": "12 fields on page 2 name the employer",
    "pages": [
      2
    ],
    "fieldCount": 12
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.