Documents

Place many fields in one request

Each entry is placed either at coordinates or against text, and each is judged on its own: an entry that cannot be placed is reported with its reason while the rest are placed. The file is read once however many entries are anchored.

post/api/v1/documents/{id}/fields/batch

Request

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

Path parameters

idstring required

Request body

Example request

{
  "fields": [
    {
      "required": true,
      "signingDate": true,
      "label": "Your full name",
      "acroFieldName": "topmostSubform[0].Page1[0].f1_01[0]",
      "acroOptionValue": "married",
      "options": [
        "CA",
        "NY"
      ],
      "maxLength": 11,
      "inputMask": "###-##-####",
      "validationPattern": "^\\d{3}-\\d{2}-\\d{4}$",
      "validationMessage": "Enter your SSN as XXX-XX-XXXX",
      "dateFormat": "MM-DD-YYYY",
      "groupKey": "fed_tax_class",
      "groupRequired": true,
      "requiredWhenValue": "Other",
      "fontSize": 9,
      "textColor": "#000080",
      "fontFamily": "Helvetica-Bold",
      "anchorText": "Tenant signature"
    }
  ]
}

Response

placednumber required
failednumber required

Example response

{
  "placed": 5,
  "failed": 1,
  "results": [
    {
      "success": true,
      "field": {
        "inputMask": "###-##-####",
        "fontSize": 9,
        "textColor": "#000080",
        "fontFamily": "Helvetica-Bold"
      },
      "error": "There is no room above \"Signature\" for a 180 × 40 field."
    }
  ]
}

Changes

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