Templates

How the template fields divide between the parties it names

The template counterpart of the document endpoint: reads the parties the base PDF names so each section can be handed to the right signer role. Empty for a single-party form.

get/api/v1/templates/{id}/form-fields/parties

Request

  • Base URL: https://api.korala.ai
  • URL: https://api.korala.ai/api/v1/templates/{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
namestring required
evidencestring required
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.

signerRoleIdsstring[] required
fieldIdsstring[] required

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

Example response

[
  {
    "key": "landlord",
    "name": "Landlord",
    "evidence": "9 fields on page 2 name the landlord",
    "pages": [
      2
    ],
    "fieldCount": 9
  }
]

Changes

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