Electronic Signature
Developers
Features
API for eSignature Solutions
Add conditional fields to a document for signature with Python SDK for API

Add conditional fields to a document for signature with Python SDK using the API

Use airSlate SignNow's API to provide your customers with smart and flexible eSignature workflows. Add fields that appear only after certain conditions are met in a document.

Free to test
Fast to deploy
Powerful & secure

Generate documents with conditional fields

Use this sample code to insert conditional fields into your document to ensure fast and accurate document completion.

Node.js

C#

Java

Python

cURL

Copy code

public class DocumentUpdateRequestModel
    {
        public List<FieldRequestBase> fields { get; private set; } = new List<FieldRequestBase>();
    }
 
    public abstract class FieldRequestBase
    {
        public abstract string type { get; }
        public bool required { get; set; }
        public string template_field_id { get; set; }
        public string role { get; set; }
        [JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
        public string name { get; set; }
        public int page_number { get; set; }
        public int x { get; set; }
        public int y { get; set; }
        public int width { get; set; }
        public int height { get; set; }
    }
 
    public abstract class LabelledFieldRequest : FieldRequestBase
    {
        public string label { get; set; }
    }
 
    public abstract class TextFieldRequestBase : LabelledFieldRequest
    {
        public override string type => "text";
 
    }
    public class TextFieldRequest : TextFieldRequestBase
    {
        public string prefilled_text { get; set; }
        public string validator_id { get; set; }
    }
    public class InitialsFieldRequest : LabelledFieldRequest
    {
        public override string type { get { return "initials"; } }
    }
    public class CheckboxFieldRequestModel : LabelledFieldRequest
    {
        public override string type => "checkbox";
        public bool prefilled_text { get; set; }
    }
 
    public class DropdownFieldRequest : LabelledFieldRequest
    {
        public override string type => "enumeration";
        public string[] enumeration_options { get; set; }
        public bool custom_defined_option { get; set; }
    }
 
    public class CalculatedFieldRequest : TextFieldRequestBase
    {
        /// <summary>
        /// Formula that includes field names and operations
        /// </summary>
        public Formula calculation_formula { get; set; }
        /// <summary>
        /// String representation of the formula. Just a text that user will see in the field settings.
        /// </summary>
        public string formula { get; set; }
        public int calculation_precision { get; set; }
    }
 
    public enum FormulaOperator
    {
        add, sub, div, mul
    }
 
    public class Formula
    {
        [JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
        [JsonConverter(typeof(StringEnumConverter))]
        public FormulaOperator? @operator { get; private set; }
        [JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
        public object term { get; private set; }
        [JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
        public Formula left { get; private set; }
        [JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
        public Formula right { get; private set; }
        private Formula(object term)
        {
            this.term = term;
        }
        private Formula(FormulaOperator @operator, Formula leftOperand, Formula rightOperand)
        {
            this.@operator = @operator;
            left = leftOperand;
            right = rightOperand;
        }
        private Formula(FormulaOperator @operator, string leftFieldName, string rightFieldName)
            : this(@operator, new Formula(leftFieldName), new Formula(rightFieldName))
        {
        }
        private Formula(FormulaOperator @operator, string leftFieldName, Formula rightOperand)
            : this(@operator, new Formula(leftFieldName), rightOperand)
        {
        }
        private Formula(FormulaOperator @operator, Formula leftOperand, string rightFieldName)
            : this(@operator, leftOperand, new Formula(rightFieldName))
        {
        }
        public static Formula Add(string leftFieldName, string rightFieldName)
        {
            return new Formula(FormulaOperator.add, leftFieldName, rightFieldName);
        }
        public static Formula Add(string leftFieldName, Formula rightOperand)
        {
            return new Formula(FormulaOperator.add, leftFieldName, new Formula(rightOperand));
        }
        public static Formula Add(Formula leftOperand, string rightFieldName)
        {
            return new Formula(FormulaOperator.add, new Formula(leftOperand), rightFieldName);
        }
        public static Formula Add(Formula leftOperand, Formula rightOperand)
        {
            return new Formula(FormulaOperator.add, new Formula(leftOperand), new Formula(rightOperand));
        }
        public static Formula Sub(string leftFieldName, string rightFieldName)
        {
            return new Formula(FormulaOperator.sub, leftFieldName, rightFieldName);
        }
        public static Formula Sub(string leftFieldName, Formula rightOperand)
        {
            return new Formula(FormulaOperator.sub, leftFieldName, new Formula(rightOperand));
        }
        public static Formula Sub(Formula leftOperand, string rightFieldName)
        {
            return new Formula(FormulaOperator.sub, new Formula(leftOperand), rightFieldName);
        }
        public static Formula Sub(Formula leftOperand, Formula rightOperand)
        {
            return new Formula(FormulaOperator.sub, new Formula(leftOperand), new Formula(rightOperand));
        }
        public static Formula Mul(string leftFieldName, string rightFieldName)
        {
            return new Formula(FormulaOperator.mul, leftFieldName, rightFieldName);
        }
        public static Formula Mul(string leftFieldName, Formula rightOperand)
        {
            return new Formula(FormulaOperator.mul, leftFieldName, new Formula(rightOperand));
        }
        public static Formula Mul(Formula leftOperand, string rightFieldName)
        {
            return new Formula(FormulaOperator.mul, new Formula(leftOperand), rightFieldName);
        }
        public static Formula Mul(Formula leftOperand, Formula rightOperand)
        {
            return new Formula(FormulaOperator.mul, new Formula(leftOperand), new Formula(rightOperand));
        }
        public static Formula Div(string leftFieldName, string rightFieldName)
        {
            return new Formula(FormulaOperator.div, leftFieldName, rightFieldName);
        }
        public static Formula Div(string leftFieldName, Formula rightOperand)
        {
            return new Formula(FormulaOperator.div, leftFieldName, new Formula(rightOperand));
        }
        public static Formula Div(Formula leftOperand, string rightFieldName)
        {
            return new Formula(FormulaOperator.div, new Formula(leftOperand), rightFieldName);
        }
        public static Formula Div(Formula leftOperand, Formula rightOperand)
        {
            return new Formula(FormulaOperator.div, new Formula(leftOperand), new Formula(rightOperand));
        }
    }
 
    public class RadiobuttonFieldRequest : FieldRequestBase
    {
        public override string type { get { return "radiobutton"; } }
        public Radio[] radio { get; set; }
    }
 
    public class SignatureFieldRequest : FieldRequestBase
    {
        public override string type { get { return "signature"; } }
    }
 
    public class AttachmentFieldRequest : LabelledFieldRequest
    {
        public override string type => "attachment";
    }
 
    public class Radio
    {
        public string radio_id { get; set; }
        public int page_number { get; set; }
        public int x { get; set; }
        public int y { get; set; }
        public double width { get; set; }
        public double height { get; set; }
        public int @checked { get; set; }
        public string value { get; set; }
        public int created { get; set; }
        public object[] json_attributes { get; set; }
    }
 
    public static class CalculatableValidatorId
    {
        public const string Number = "1109cfbbb06311a06a4c7f8d04f1f0d5c44103cb";
        public const string UsCurrency = "150662c7221a6a6ebcbb7c50ca46359d19757f81";
        public const string PositiveInteger = "1f9486ae822d30ba3df2cb8e65303ebfb8c803e8";
        public const string PositiveOrNegativeInteger = "23a57c29fa089e22bcf85d601c8091bc9c7da570";
        public const string UsInteger = "f031b8b63127c6915949bfc55e3cc81edbb12ecc";
        public const string UsPositiveInteger = "4cf9dfe7e65eb0a2c0c93e199f1ec1cdc23a267d";
        public const string EuInteger = "e8b7248b323525d1e8d5240ccf87d8c2926622cd";
        public const string EuPositiveInteger = "8937f6d0511167d67c6b21fe07c9ccd3a8116126";
    }
 
    public static class TextFieldValidatorId
    {
        public const string Email = "7cd795fd64ce63b670b52b2e83457d59ac796a39";
        public const string USPhone = "13cc1d661da456d27b249b73056ed4d1f2e72d8e";
        public const string State = "3123849de563f9e14acacc2739467e3d30e426b6";
        public const string Number = "1109cfbbb06311a06a4c7f8d04f1f0d5c44103cb";
        public const string UsCurrency = "150662c7221a6a6ebcbb7c50ca46359d19757f81";
        public const string Alphanumeric = "3859296fffd39cb8efeaffda5899973c014ce42e";
        public const string PositiveInteger = "1f9486ae822d30ba3df2cb8e65303ebfb8c803e8";
        public const string PositiveOrNegativeInteger = "23a57c29fa089e22bcf85d601c8091bc9c7da570";
        public const string Age = "1a203fa91791b0458608be045a454ba90557fb26";
        public const string SSN = "2cd795fd64ce63b670b52b2e83457d59ac796a39";
        public const string CreditCardNumber = "2f1c408bdf2f99fc5d4c342249da88ce5d2a5f02";
        public const string BankRTN = "959b068ef8ee5cc27e09ba79af58f9e805b7c2b3";
        public const string UsInteger = "f031b8b63127c6915949bfc55e3cc81edbb12ecc";
        public const string UsPositiveInteger = "4cf9dfe7e65eb0a2c0c93e199f1ec1cdc23a267d";
        public const string EuInteger = "e8b7248b323525d1e8d5240ccf87d8c2926622cd";
        public const string EuPositiveInteger = "8937f6d0511167d67c6b21fe07c9ccd3a8116126";
    }
 
    public static class DateFieldValidatorId
    {
        public const string DateUS = "13435fa6c2a17f83177fcbb5c4a9376ce85befeb";
        public const string DateEU = "059b068ef8ee5cc27e09ba79af58f9e805b7c2b3";
        public const string TimeOnly = "09d3bb6a5eb6598edb7bfad02b0143d8c68ad788";
        public const string WrittenDate = "0f4827a308018f98b11ae3923104685ff0c03070";
        public const string DateTime = "06448a0d0eb6a71c7c116ec4754bcb04ebf11da5";
    }
     
public partial class RestSharpSamples
    {
        public static void AddFillableFields(string accessToken, string apiUrl, string documentId, DocumentUpdateRequestModel documentUpdateRequest)
        {
            var client = new RestClient { BaseUrl = new Uri(apiUrl) };
            var request = new RestRequest($"/document/{documentId}", Method.PUT)
                .AddHeader("Accept", "application/json")
                .AddHeader("Authorization", $"Bearer {accessToken}");
            request.RequestFormat = DataFormat.Json;
            var requestJson = JsonConvert.SerializeObject(documentUpdateRequest);
            request.AddBody(requestJson);
            var response = client.Execute(request);
 
            if (response.StatusCode != HttpStatusCode.OK)
            {
                throw new Exception(response.Content);
            }
        }
    }  
 
 class Program
    {
        static void Main(string[] args)
        {
            var attachmentField = new AttachmentFieldRequest
            {
                height = 10,
                width = 50,
                label = "AttachMe",
                name = "AttachmentName",
                page_number = 0,
                required = true,
                role = "Signer 1",
                x = 20,
                y = 20
            };
            var checkboxField = new CheckboxFieldRequestModel
            {
                height = 10,
                width = 50,
                label = "Checkbox field",
                name = "Checkbox_field",
                page_number = 0,
                required = true,
                role = "Signer 1",
                x = 20,
                y = 40,
                prefilled_text = true
            };
            var datetimeField = new TextFieldRequest
            {
                height = 10,
                width = 80,
                label = "Datetime field",
                name = "Datetime_field",
                page_number = 0,
                prefilled_text = DateTime.Now.ToLongDateString(),
                required = true,
                role = "Signer 1",
                x = 100,
                y = 40,
                validator_id = DateFieldValidatorId.DateTime
            };
            var dropdownField = new DropdownFieldRequest
            {
                height = 10,
                width = 80,
                label = "Dropdown field",
                name = "Dropdown_field",
                page_number = 0,
                required = true,
                role = "Signer 1",
                x = 20,
                y = 60,
                custom_defined_option = true,
                enumeration_options = new[] { "10", "20", "30" }
            };
            var inititalsField = new InitialsFieldRequest
            {
                height = 40,
                width = 50,
                name = "Init",
                page_number = 0,
                required = true,
                role = "Signer 1",
                label = "Init label",
                x = 20,
                y = 80
            };
            var signatureField = new SignatureFieldRequest
            {
                height = 40,
                width = 50,
                name = "Sign",
                page_number = 0,
                required = true,
                role = "Signer 1",
                x = 120,
                y = 80
            };
            var textField = new TextFieldRequest
            {
                height = 10,
                width = 80,
                label = "Text field",
                name = "Text_field",
                page_number = 0,
                prefilled_text = "Prefilled text",
                required = true,
                role = "Signer 1",
                x = 20,
                y = 150
            };
            var calcField_number1 = new TextFieldRequest
            {
                height = 10,
                width = 50,
                label = "Number 1",
                name = "Number_1",
                page_number = 0,
                prefilled_text = "1",
                required = true,
                role = "Signer 1",
                x = 200,
                y = 20,
                validator_id = CalculatableValidatorId.Number
            };
            var calcField_number2 = new TextFieldRequest
            {
                height = 10,
                width = 50,
                label = "Number 2",
                name = "Number_2",
                page_number = 0,
                prefilled_text = "2",
                required = true,
                role = "Signer 1",
                x = 200,
                y = 40,
                validator_id = CalculatableValidatorId.PositiveInteger
            };
            var calcField_number3 = new TextFieldRequest
            {
                height = 10,
                width = 50,
                label = "Number 3",
                name = "Number_3",
                page_number = 0,
                prefilled_text = "3",
                required = true,
                role = "Signer 1",
                x = 200,
                y = 60,
                validator_id = CalculatableValidatorId.PositiveOrNegativeInteger
            };
            var calcField_number4 = new TextFieldRequest
            {
                height = 10,
                width = 50,
                label = "Number 4",
                name = "Number_4",
                page_number = 0,
                prefilled_text = "4",
                required = true,
                role = "Signer 1",
                x = 200,
                y = 80,
                validator_id = CalculatableValidatorId.EuInteger
            };
 
            var calculatedField = new CalculatedFieldRequest
            {
                height = 10,
                width = 50,
                label = "Calculated field",
                name = "Calculated_field",
                page_number = 0,
                required = true,
                role = "Signer 1",
                x = 300,
                y = 20,
                calculation_precision = 2
            };
            calculatedField.formula = $"({{{calcField_number1.name}}}+{{{calcField_number2.name}}})/{{{calcField_number3.name}}}-{{{calcField_number4.name}}}";
            calculatedField.calculation_formula = Formula.Div(Formula.Add(calcField_number1.name, calcField_number2.name), Formula.Sub(calcField_number3.name, calcField_number4.name));
 
            var documentUpdateRequest = new DocumentUpdateRequestModel();
            documentUpdateRequest.fields.Add(attachmentField);
            documentUpdateRequest.fields.Add(checkboxField);
            documentUpdateRequest.fields.Add(datetimeField);
            documentUpdateRequest.fields.Add(dropdownField);
            documentUpdateRequest.fields.Add(inititalsField);
            documentUpdateRequest.fields.Add(signatureField);
            documentUpdateRequest.fields.Add(textField);
            documentUpdateRequest.fields.Add(calcField_number1);
            documentUpdateRequest.fields.Add(calcField_number2);
            documentUpdateRequest.fields.Add(calcField_number3);
            documentUpdateRequest.fields.Add(calcField_number4);
            documentUpdateRequest.fields.Add(calculatedField);
 
            RestSharpSamples.AddFillableFields(Token.access_token, ApiBaseUrl, id, documentUpdateRequest);
        }
 
    }

import signnow_python_sdk
from datetime import datetime

if __name__ == '__main__':
    signnow_python_sdk.Config(client_id="CLIENT_ID",
                              client_secret="CLIENT_SECRET",
                              environment="production")

# Enter your own credentials
    username = "USER_NAME"
    password = "USER_PASSWORD"
    template_id = "TEMPLATE_ID"

# Create access_token for the user
    access_token = signnow_python_sdk.OAuth2.request_token(username, password, '*')

# Create the PUT /document payload
    doc_payload = {
        "texts": [
            {
                "size": 22,
                "x": 61,
                "y": 72,
                "page_number": 0,
                "font": "Arial",
                "data": "a sample text element",
                "line_height": 9.075,
                "client_timestamp": datetime.now().strftime("%s")
            }
        ],
        "fields": [
            {
                "x": 61,
                "y": 100,
                "width": 120,
                "height": 34,
                "page_number": 0,
                "role": "Signer 1",
                "required": True,
                "type": "signature"
            },
            {
                "x": 61,
                "y": 160,
                "width": 120,
                "height": 12,
                "page_number": 0,
                "label": "New Label",
                "role": "Signer 1",
                "required": True,
                "type": "text"
            },
            {
                "x": 61,
                "y": 178,
                "width": 41,
                "height": 26,
                "page_number": 0,
                "role": "Signer 2",
                "required": True,
                "type": "initials"
            }
        ]
    }

# Update document template with payload
    put_doc_response = signnow_python_sdk.Template.update(access_token['access_token'], template_id, doc_payload)

We provide developers with complete SDKs for all popular languages, allowing them to integrate eSignature workflows without writing a single line of code.
With our detailed documentation, integrating the airSlate SignNow API is a breeze.
The airSlate SignNow API not only provides you with eSignatures: use it to create fillable forms, request payments, and download & archive documents using simple API calls.

View full API reference

airSlate SignNow regularly wins awards for ease of use and setup

Read our reviews on the trusted resources

Tech Data uses airSlate SignNow to improve our internal and external customer service while increasing our speed to revenue.

Bob Dutkowsky | CEO

Select an API package for your business

Integrate eSignatures into your software and get 250 legally-binding signature invites with your API free trial.

Check API pricing

Solution engineers

We are here to help you configure eSignature API to your workflow.

Review airSlate SignNow’s API documentation

The detailed API tutorial will guide you through the entire integration process and provide clear coding examples.

Video guides

Watch our video guides for instructions on how to easily build custom integrations.

Start with any of our SDKs

Get complete SDKs for Node.js, Python,
PHP, Java, C#.

Enterprise-grade security and compliance

airSlate SignNow is committed to protecting your sensitive information by complying with global industry-specific security standards.

Learn more

GDPR compliance

Regulates the use and holding of personal data belonging to EU residents.

SOC 2 Type II Certified

Guarantees the security of your data & the privacy of your clients.

PCI DSS certification

Safeguards credit/debit card data for every monetary transaction a customer makes.

21 CFR Part 11

FDA-backed standards for electronic documentation and electronic signatures.

HIPAA compliance

Protects the private health information of your patients.

CCPA compliance

Enhances the protection of personal data and the privacy of California residents.

Watch the airSlate SignNow API in action

Evaluate airSlate SignNow's add conditional fields to a document with python sdk for api

The airSlate SignNow API provides companies with a distinctive set of functionalities that facilitate enhanced business processes. Discover the benefits of our add conditional fields to a document with python sdk for api by signing up for a complimentary Sandbox account.

Complete the following steps to establish a Sandbox account:

Access the airSlate SignNow Developers page. There you will find additional information about the API and can register your Sandbox account.
Register for a trial. Enter your email address and press the Create API sandbox button to sign up.
Verify your email address. Check the email you receive and click the link provided to verify your email address.
Go to Developer Sandbox. Create a password to allow further access to your developer account.
Add an application. Click Add App, provide a name for your app, and click Add to save changes. The API token for the app will be generated automatically.
Test add conditional fields to a document with python sdk for api. Investigate all airSlate SignNow features and how they can enhance your business operations.

Follow these instructions to assess airSlate SignNow's features. You can reach out to the support team if you have any inquiries. Elevate your business workflows with airSlate SignNow today.

How it works

Create an account and get the required tokens

Use code samples to add conditional fields to a document for signature with Python SDK using the API

Enjoy the power of eSignature in your workflows

Watch our instructions to build custom integrations with ease

airSlate SignNow offers a free testing environment to explore the eSignature.

Trusted eSignature solution — what our customers are saying

Explore how the airSlate SignNow eSignature platform helps businesses succeed. Hear from real users and what they like most about electronic signing.

This service is really great! It has helped...

5

anonymous

This service is really great! It has helped us enormously by ensuring we are fully covered in our agreements. We are on a 100% for collecting on our jobs, from a previous 60-70%. I recommend this to everyone.

Read full review

I've been using airSlate SignNow for years (since it...

5

Susan S

I've been using airSlate SignNow for years (since it was CudaSign). I started using airSlate SignNow for real estate as it was easier for my clients to use. I now use it in my business for employement and onboarding docs.

Read full review

Everything has been great, really easy to incorporate...

5

Liam R

Everything has been great, really easy to incorporate into my business. And the clients who have used your software so far have said it is very easy to complete the necessary signatures.

Read full review