Documents

Where the document is waiting to be filled in

Reads the printed page and returns every ruled line and labelled blank, each with the words printed against it, the line it sits on and a box to place a field in. It does not decide what any blank is for: the label is returned so the caller can. A rule drawn as a graphic is not in the text layer and is not found here; use the text search to locate its label instead.

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

Request

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

Path parameters

idstring required

Response

pageCountnumber required
hasFormFieldsboolean nullable required

Whether the document is a fillable form. When it is, its own fields say where everything goes and import_form_fields places them; the blanks here are only what the printed text shows. Null when the file was never scanned for them, which is not the same as having none.

Example response

{
  "blanks": [
    {
      "pageNumber": 1,
      "label": "Tenant signature",
      "line": "Tenant signature ______________  Date ____________",
      "xPosition": 120,
      "yPosition": 640,
      "width": 240,
      "height": 28
    }
  ],
  "pages": [
    {
      "pageNumber": 1,
      "width": 612,
      "height": 792
    }
  ],
  "pageCount": 3
}

Changes

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