Documents

Get all fields for a document

get/api/v1/documents/{id}/fields

Request

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

Path parameters

idstring required

Response

valueKeystring nullable

Repeated text value key, scoped to the owning signer.

idstring required
documentIdstring required
signerIdstring required
fieldType'signature' | 'initials' | 'date' | 'text' | 'checkbox' | 'dropdown' | 'radio' required
pageNumbernumber required
xPositionnumber required
yPositionnumber required
widthnumber required
heightnumber required
labelstring nullable

Human-readable label shown to the signer for this field

requiredstring required
valuestring nullable
editableboolean required

When true, a prefilled value is a suggestion the signer can change before signing.

sharedFillboolean required

One signer owns the field, but until they sign any signer able to act may fill or correct it — the employer preparing a part the employee confirms. Never true on signature or initials fields.

signingDateboolean nullable

Date fields only. True fills the field with the date the signer signs: the signing page shows today and the signer does not type it. False makes it an ordinary date the signer enters. Refused on any other type. Null on a date made before the flag existed: a date on the signer’s own signature line is then the date of signing.

signatureImageUrlstring nullable
filledAtstring date-time nullable
filledBy'sender' | 'signer'

Who wrote the current value: the sender (a non-editable template prefill or a signing-packet lock) or the signer (any fill, including bulk signing on their behalf). Null while unfilled.

signingDateChangedAtstring date-time nullable

When the signer changed the date beside their signature from the automatic date of signing to one of their own. Null otherwise.

acroFieldNamestring nullable

Embedded AcroForm field this field is linked to; values fill the PDF form field at completion instead of being overlay-stamped.

acroOptionValuestring nullable

For radio-group AcroForm fields: the option this field selects.

optionsstring[] nullable

Allowed values for dropdown fields

maxLengthnumber nullable

Maximum characters accepted at fill time

inputMaskstring nullable

Input mask where # represents one digit

validationPatternstring nullable

Regex the filled value must match

validationMessagestring nullable

Signer-facing error when validationPattern does not match

dateFormatstring nullable

Date fields only: format the auto-filled date is rendered in, e.g. 'MM-DD-YYYY'

groupKeystring nullable
groupRequiredboolean required

Whether at least one member of this group must be selected

requiredWhenFieldIdstring uuid nullable

Id of the field whose checked/filled state makes this field required (conditional requirement); null when unconditional

requiredWhenValuestring nullable

Exact controller value the condition triggers on; null means any checked/filled state

fontSizenumber nullable

Point size the value is drawn at, imported from the PDF form field. Null means the size is fitted to the box.

textColorstring nullable

Color the value is drawn in, as #rrggbb

textAlign'left' | 'center' | 'right'

Horizontal alignment of the value inside the field box

fontFamilystring nullable

Base font the value is drawn in, imported from the PDF form field

multilineboolean required

Whether the value may contain line breaks (a multiline form field)

createdAtstring date-time required
updatedAtstring date-time required

Example response

[
  {
    "inputMask": "###-##-####",
    "fontSize": 9,
    "textColor": "#000080",
    "fontFamily": "Helvetica-Bold"
  }
]

Changes

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