Contents

SigField

Fields

  • id required Type: string
  • document_id required Type: string
  • signer_id optional Type: string null

    null when we couldn't tell whose it is.

  • kind required Type: SigFieldKind
  • page required Type: integer
  • x required Type: number

    From the page's left edge

  • y required Type: number

    From the page's top edge

  • width required Type: number
  • height required Type: number
  • found required Type: boolean

    True for a place we found and nobody has moved.

  • label optional Type: string null

    What the signer is asked for, such as Account number; for a note, its words.

  • required optional Type: boolean

    Whether the signer must fill it.

  • options optional Type: string[] null

    A choice's options.

  • value optional Type: string null

    What the signer wrote or picked, once they have signed; yes for a ticked checkbox.

  • attachment optional Type: object null

    The file the signer attached.

Where you'll see it