How to add different signer fields to your recipients?

This section says how to set different types of fields supported in Zoho Sign.

Image category fields

Signature field

  • Signature of the signer can be collected.
  • Signers can draw, upload, type (in the case of guest signer), or fetch their signature from their Zoho Sign profile. Learn more
Copied{
    "requests": {
        "actions": [
            {
                "fields": [
                    {
                        "field_type_name": "Signature",
                        "action_id": "14197000001428004",
                        "document_id": "14197000001427002",
                        "field_name": "Signature",
                        "width": "22.045264",
                        "height": "2.461140",
                        "x_value": "68.499843",
                        "y_value": "84.132124",
                        "page_no": 0,
                        "field_category": "image",
                        "field_label": "Signature"
                    }
                ]
            }
        ]
    }
}

Initial field

You can use initial fields in instances where there is a space constraint for the signature field to be placed.

Copied{
    "requests": {
        "actions": [
            {
                "fields": [
                    {
                        "field_type_name": "Initial",
                        "field_label": "Initial"
                    }
                ]
            }
        ]
    }
}

Image field

Signer can upload an image.

Copied{
    "requests": {
        "actions": [
            {
                "fields": [
                    {
                        "field_type_name": "Image",
                        "field_label": "Image"
                    }
                ]
            }
        ]
    }
}

Stamp field

  • Signer can either drag and drop or upload the document /image containing the company's stamp. 
  • Click here to learn how to add your organization logo to your Zoho Sign profile.
Copied{
    "requests": {
        "actions": [
            {
                "fields": [
                    {
                        "field_type_name": "Stamp",
                        "field_label": "Stamp"
                    }
                ]
            }
        ]
    }
}
Text category fields

Text field

  • Use this to accept any type of character as an input.
  • However, when data validation is enforced, it ensures that the sender gets the right input from the signer. 
Copied{
    "requests": {
        "actions": [
            {
                "fields": [
                    {
                        "field_type_name": "Textfield",
                        "action_id": "14197000001428004",
                        "document_id": "14197000001427002",
                        "field_name": "Text Field",
                        "width": "16.010059",
                        "height": "1.683938",
                        "x_value": "30.779809",
                        "y_value": "17.357513",
                        "page_no": 0,
                        "field_category": "textfield",
                        "field_label": "Text",
                        "text_property": {
                            "font": "Roboto",
                            "font_size": 11,
                            "font_color": "000000",
                            "is_bold": false,
                            "is_italic": false,
                            "max_field_length": 2048
                        }
                    }
                ]
            }
        ]
    }
}

Company field

  • The signer can enter their company details, or if the signer is a Zoho Sign customer, the details can be auto-fetched from their profile. 

Click here to learn how to set up organization details in your Zoho Sign profile.

Copied{
    "requests": {
        "actions": [
            {
                "fields": [
                    {
                        "field_type_name": "Company",
                        "field_label": "Company"
                    }
                ]
            }
        ]
    }
}

Name field

  • Signer's full name/first name/last name can be obtained.
  • The signer's name gets auto-fetched from the recipient details entered by the sender, but can be edited by the signer.
Copied{
    "requests": {
        "actions": [
            {
                "fields": [
                    {
                        "field_type_name": "Name",
                        "name_format": "FULL_NAME",
                        "field_label": "Full Name"
                    }
                ]
            }
        ]
    }
}

Email field

  • Sender can get their signer's email address in the document with this field.
  • Once the signer clicks this field, the email address is auto fetched and cannot be edited.
Copied{
    "requests": {
        "actions": [
            {
                "fields": [
                    {
                        "field_type_name": "Email",
                        "field_label": "Email"
                    }
                ]
            }
        ]
    }
}

Job title field
Similar to text field, but if the signer has added their job title, that information will be auto fetched while document signing.

Copied{
    "requests": {
        "actions": [
            {
                "fields": [
                    {
                        "field_type_name": "Jobtitle",
                        "field_label": "Job title"
                    }
                ]
            }
        ]
    }
}
Date category fields

Date field (Custom date)

  • This can be used wherever the sender wants a value related to date in their document.
  • The entry could be either a past date or a future date.field_category to be set as "datefield" and date_format param to be passed.
Copied{
    "requests": {
        "actions": [
            {
                "fields": [
                    {
                        "field_type_name": "CustomDate",
                        "action_id": "14197000001428004",
                        "document_id": "14197000001427002",
                        "field_name": "Date",
                        "width": "16.010059",
                        "height": "1.683938",
                        "x_value": "19.631444",
                        "y_value": "12.240933",
                        "page_no": 0,
                        "date_format": "MMM-dd-yyyy",
                        "field_category": "datefield",
                        "field_label": "Date",
                        "text_property": {
                            "font": "Roboto",
                            "font_size": 11,
                            "font_color": "000000",
                            "is_bold": false,
                            "is_italic": false
                        }
                    }
                ]
            }
        ]
    }
}
Checkbox category fields

Signer can choose from multiple options provided by the sender.

Copied{
    "requests": {
        "actions": [
            {
                "fields": [
                    {
                        "field_type_name": "Checkbox",
                        "action_id": "14197000001428004",
                        "document_id": "14197000001427002",
                        "field_name": "Checkbox",
                        "width": "1.927913",
                        "height": "1.489637",
                        "x_value": "69.338066",
                        "y_value": "11.917098",
                        "page_no": 0,
                        "field_category": "checkbox",
                        "field_label": "Checkbox"
                    }
                ]
            }
        ]
    }
}
Dropdown category fields

You can have your signer choose an option from the list of options provided by the sender.

Copied{
    "requests": {
        "actions": [
            {
                "fields": [
                    {
                        "field_type_name": "Dropdown",
                        "action_id": "14197000001428004",
                        "document_id": "14197000001427002",
                        "field_name": "Dropdown",
                        "width": "16.010059",
                        "height": "1.683938",
                        "x_value": "80.431423",
                        "y_value": "11.595288",
                        "page_no": 0,
                        "field_category": "dropdown",
                        "field_label": "Dropdown",
                        "dropdown_values": [
                            {
                                "dropdown_value": "Dropdown Value 0",
                                "dropdown_order": 0
                            },
                            {
                                "dropdown_value": "Dropdown Value 1",
                                "dropdown_order": 1
                            },
                            {
                                "dropdown_value": "Dropdown Value 2",
                                "dropdown_order": 2
                            }
                        ],
                        "text_property": {
                            "font": "Roboto",
                            "font_size": 11,
                            "font_color": "000000",
                            "is_bold": false,
                            "is_italic": false
                        }
                    }
                ]
            }
        ]
    }
}
Radio group category fields

The signer can choose only one option from the options provided by the sender.

Copied{
    "requests": {
        "actions": [
            {
                "fields": [
                    {
                        "field_type_name": "Radiogroup",
                        "action_id": "14197000001428004",
                        "document_id": "14197000001427002",
                        "field_name": "Radiogroup",
                        "field_category": "radiofield",
                        "field_label": "Radiogroup",
                        "sub_fields": [
                            {
                                "sub_field_name": "Option+1",
                                "width": "1.960784",
                                "height": "1.515036",
                                "x_value": "91.412144",
                                "y_value": "17.098446",
                                "page_no": 0
                            },
                            {
                                "sub_field_name": "Option+2",
                                "width": "1.960784",
                                "height": "1.515036",
                                "x_value": "91.412144",
                                "y_value": "19.113482",
                                "page_no": 0
                            },
                            {
                                "sub_field_name": "Option+3",
                                "width": "1.960784",
                                "height": "1.515036",
                                "x_value": "91.440905",
                                "y_value": "21.606995",
                                "page_no": 0
                            }
                        ]
                    }
                ]
            }
        ]
    }
}
Attachment category fields

You can have your recipient add attachments upto 10 MB. The attachment will be present at the end of the document.

Copied{
    "requests": {
        "actions": [
            {
                "fields": [
                    {
                        "field_type_name": "Attachment",
                        "action_id": "14197000001428004",
                        "document_id": "14197000001427002",
                        "field_name": "Attachment",
                        "width": "16.010059",
                        "height": "2.137306",
                        "x_value": "19.04468",
                        "y_value": "8.031088",
                        "page_no": 0,
                        "field_category": "filefield",
                        "field_label": "Attachment"
                    }
                ]
            }
        ]
    }
}
Payment category fields

You must have integrated with Zoho Checkout and must have sent the document with payment field from Zoho Sign's UI before using this API.

Copied{
    "requests": {
        "actions": [
            {
                "fields": [
                    {
                        "field_type_name": "Checkout",
                        "action_id": "14197000001428004",
                        "document_id": "14197000001427002",
                        "field_name": "Payment",
                        "width": "16.010059",
                        "height": "1.683938",
                        "x_value": "48.717781",
                        "y_value": "38.147668",
                        "page_no": 0,
                        "date_format": "MMM-dd-yyyy",
                        "field_category": "payment",
                        "field_label": "Payment",
                        "amount": "100",
                        "currency_code": "INR",
                        "form_id": "102660000000104380",
                        "org_id": "68019648",
                        "text_property": {
                            "font": "Roboto",
                            "font_size": 11,
                            "font_color": "000000",
                            "is_bold": false,
                            "is_italic": false
                        }
                    }
                ]
            }
        ]
    }
}