Documents

Fill fields on behalf of the sender

Writes the data the sender already knows, so the signer is left with the signature. Works while the document is a draft and while it is out for signature. A signature or initials field belongs to the person who signs and is refused here, as is a field the signer has already filled. Each value is judged on its own and validated the same way a signer's fill is.

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

Request

  • Base URL: https://api.korala.ai
  • URL: https://api.korala.ai/api/v1/documents/{id}/fields/values
  • 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

{
  "values": [
    {
      "value": "Korala LLC"
    }
  ]
}

Response

fillednumber required
failednumber required
blockingIssuestring

What would still stop the signer completing, judged by the same check the signing step runs, with the signatures taken as drawn. Absent when nothing but the signatures is left.

Example response

{
  "filled": 12,
  "failed": 1,
  "results": [
    {
      "success": true,
      "error": "The signer has already filled this field"
    }
  ],
  "stillToFill": [
    {
      "label": "Line 7b: SSN, ITIN, or EIN",
      "fieldType": "text"
    }
  ],
  "blockingIssue": "Choose one of \"Line 9a: Entity type\""
}

Changes

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