Field

Parameters

Name	Type	Description	Requirement
id	Integer	The field identifier	Required
roleId	Integer	The SignRole ID associated with this field	Required
required	Boolean	Whether a field is required for completion	Required
isMasked	Boolean	Whether a field is masked. If TRUE, FieldData will be rendered as a series of asterisks in documents and viewable only by the sender of the sign request.	Required
type	String	The field type. Possible values: text, select, date, displayText, signature, initials, checkbox, zip, city, suite, street, state, signDate, signerName, signerEmail. Fields with type=select accept and return fieldChoiceId property in the FieldData object. Fields with type=checkbox accept and return ”true” or “false” in the value property of the FieldData object. Fields with type signature and initials accept and return imageContent and imageMimetype for signature or initials images or value for text signatures or initials. All other Field types accept and return a string in the value property of the FieldData object.	Required
choices	Array	An array containing a list of FieldChoice objects if the Field type is select	Optional

Example Response

JSON

{
  "id": 6681,
  "roleId": 47,
  "required": false,
  "isMasked": false,
  "type": "select",
  "choices": [
    {
      "id": 379,
      "text": "1"
    },
    {
      "id": 380,
      "text": "2"
    }
  ]
}