Home
Developers
Lock required field settlement via REST API airSlate SignNow

Lock required field settlement REST API

Use airSlate SignNow REST API to scale up your document management capabilities & lock required field in settlement with ease

Start API free trial

Tailor airSlate SignNow to fulfill the needs of your company

The airSlate SignNow API allows you to configure and set up eSignature workflows according to your company’s needs in less than ten minutes. No need to contact sales people to get started: create your sandbox account and test the airSlate SignNow API for free.

Brandable workflows

Customize eSignature workflows with your company’s branding.

Competitive & scalable pricing

Our pricing plans accommodate the needs of your business.

Fast setup

Detailed documentation and clear coding examples ensure an excellent developer experience.

High success rate

Superior app performance guaranteed with our 24/7 API monitoring.

Flexible eSignature API for any use case and industry

airSlate SignNow’s eSignature API empowers users to quickly complete entire document lifecycles. Easily send documents for signature, request payments, create reusable templates with fillable fields, and track the status of documents in real-time with airSlate SignNow.

Upload a PDF and create fillable fields

Send a document for signature

Track document completion status

Download and save signed documents

Copy code

curl -X PUT \
    'https://api.signnow.com/document/{{document_id}}' \
    -H 'Authorization: Bearer {{bearer_token}}' \
    -H 'Content-Type: application/json' \
    -d '{
      "fields": [
        {
          "x": 305,
          "y": 18,
          "width": 122,
          "height": 10,
          "page_number": 0,
          "label": "first_name",
          "role": "Signer",
          "required": true,
          "type": "text",
          "prefilled_text": "John"
        },
        {
          "x": 305,
          "y": 38,
          "width": 122,
          "height": 10,
          "page_number": 0,
          "label": "last_name",
          "role": "Signer",
          "required": true,
          "type": "text",
          "prefilled_text": "Doe"
        },
        {
          "x":305,
          "y":67,
          "width":100,
          "height":34,
          "page_number":0,
          "label":"a sample label",
          "role":"Signer",
          "required":true,
          "type":"signature"
        }
      ]
    }'

public static partial class InviteExamples
    {
        /// <summary>
        /// Create a role-based invite to the document for signature.
        /// </summary>
        /// <param name document"">airSlate SignNow document with fields you’d like to have signed
        /// <param name email"">The email of the invitee.
        /// <param name token"">Access token
        /// <returns><see cref InviteResponse""></see> without any Identity of invite request.</returns>
        public static async Task<InviteResponse> CreateRoleBasedInviteToSignTheDocument(SignNowDocument document, string email, Token token)      
        {
            // using token from the Authorization step
            var signNowContext = new SignNowContext(token);
 
            // Create role-based invite
            var invite = new RoleBasedInvite(document)
            {
                Message = $"{email} invited you to sign the document {document.Name}",
                Subject = "The subject of the Email"
            };
 
            // Creates options for signers
            var signer = new SignerOptions(email, invite.DocumentRoles().First())
                {
                    ExpirationDays = 15,
                    RemindAfterDays = 7,
                }
                .SetAuthenticationByPassword("***PASSWORD_TO_OPEN_THE_DOCUMENT***");
 
            // Attach signer to existing roles in the document
            invite.AddRoleBasedInvite(signer);
 
            // Creating Invite request
            return await signNowContext.Invites
                .CreateInviteAsync(document.Id, invite)
                .ConfigureAwait(false);
        }
    }</InviteResponse>

public static partial class DocumentExamples
    {
        /// <summary>
        /// Check the Status of the Document
        /// <para>Can be one of:</para>
        /// <list type bullet"">
        /// <item><description><see cref DocumentStatus.NoInvite""></see></description></item>
        /// <item><description><see cref DocumentStatus.Pending""></see></description></item>
        /// <item><description><see cref DocumentStatus.Completed""></see></description></item>
        /// </list>
        /// </summary>
        /// <param name documentId"">Identity of the document
        /// <param name token"">Access token
        /// <returns><see cref DocumentStatus""></see></returns>
        public static async Task<DocumentStatus> CheckTheStatusOfTheDocument(string documentId, Token token)    
        {
            // using token from the Authorization step
            var signNowContext = new SignNowContext(token);
 
            var document = await signNowContext.Documents
                .GetDocumentAsync(documentId).ConfigureAwait(false);
 
            return document.Status;
        }
    }</DocumentStatus>

public String uploadDocumentWithTags(@RequestParam("file") MultipartFile file,
                                       Model model,
                                       RedirectAttributes redirectAttributes
  ) {
      try {
          if (isUserNotAuthorized()) {
              return getLoginRedirectPage(redirectAttributes, "/examples/uploadDocumentWithTags");    
          }
          //upload document with tags to parse
          String documentId = provider.get().getSnClient()
                  .documentsService()
                  .uploadDocumentWithTags(file.getInputStream(), file.getOriginalFilename());
          updateDocumentList();
          model.addAttribute("message", "fileId: " + documentId);
      } catch (IOException | SNException e) {
          model.addAttribute("message", String.format("Couldn't upload document %s because %s %s"    
                  , file.getOriginalFilename(), e.getMessage(), e.getCause())
          );
      }
      return "add_text_tag_on_document";
  }

public String simpleFromInvite(@ModelAttribute SimpleFromInvite simpleFromInvite, Model model, RedirectAttributes redirectAttributes) {     
        if (isUserNotAuthorized()) {
            return getLoginRedirectPage(redirectAttributes, "/examples/simpleFromInvite");
        }
 
        final String fromEmail = simpleFromInvite.getFrom();
        final String toEmail = simpleFromInvite.getTo();
        final String documentId = simpleFromInvite.getDocumentId();
 
        try {
            model.addAttribute("documentList", provider.get().getUserDocuments());
            //create request for invite
            Document.SigningInviteRequest request = new Document.SigningInviteRequest(
                    fromEmail,
                    toEmail
            );
            request.subject = simpleFromInvite.getSubject();
            request.message = simpleFromInvite.getMessage();
 
            //send request for invite
            provider.get().getSnClient()
                    .documentsService()
                    .sendDocumentSignInvite(documentId, request);
 
            model.addAttribute("message",
                    String.format("Invitation for sign document %s already sent to %s from %s",
                            documentId,
                            toEmail,
                            fromEmail
                    )
            );
        } catch (SNException e) {
            String message = String.format("Couldn't send invitation request from %s to %s for sign document %s. %s %s"
                    , fromEmail, toEmail, documentId, e.getMessage(), e.getCause());
            model.addAttribute("message", message);
        }
 
        return "simple_from_invite";
    }

View all API features View full API reference

The founder of SportsForms integrated airSlate SignNow eSignatures with their online registration platform to speed up processes and eliminate paper usage.

Read full story

The airSlate SignNow team has been exceptional, responsive, the API has been great, and we're extremely happy that we chose airSlate SignNow as a company.

Read full story

We found airSlate SignNow to be better priced and exactly the solution we needed. airSlate SignNow has lowered our enrollment completion process by a day or two depending on the member.

Read full story

Ready to get started?

Discover the true potential of airSlate SignNow REST API to lock required field in settlement

How it works

Start with a free sandbox account

With the free Sandbox account, you'll experience firsthand signNow's intelligent capabilities that get the job done without the need of disrupting your existing tech environment.

How it works

Pick the best subscription to meet your needs

We offer flexible rates for enterprises of all sizes. You can pick the one that is both cost-effective and gives the essential tools to cater to your particular requirements, such as the option to lock required field in settlement.

How it works

Get a better strategy to handle your paperwork approvals

Enhance your document management and get super-fast performance, unrivaled efficiency, and output benefits with our REST API.

Kickstart your REST API incorporation to lock required field in settlement

Whether you just began dipping your toes into the world of API for document management or you already have experience utilizing some services, we aim to make your first acquaintance with airSlate SignNow’s REST API as intuitive as possible. Browse through our tutorial for help in starting with airSlate SignNow and lock required field in settlement via REST API.

Look through our documentation. Read about our API’s capabilities and the best practices for using them.
Register for a free Sandbox account. Head to our registration page, enter your email address, and click the activation link we’ll email you.
Log in to your account and add an application. Click the Add app button on your Dashboard and enter the app's name.
Generate your token to authorize access to our API. The token will show up once you've added an app.
Test the option to lock required field settlement via REST API. Paste your code into the testing area.
Explore other functionality airSlate SignNow REST API gives. Use our insightful materials, pieces of code, and other materials developed for a more seamless onboarding experience.

airSlate SignNow makes it easy to start with REST API to lock required field in settlement. Nevertheless, if you have any questions or need support taking complete advantage of what airSlate SignNow gives, our support team is always ready to help. Check out the airSlate SignNow API now!

Industry-compliant eSignature functionalities for your app

Streamline document workflows with airSlate SignNow’s brandable eSignature API: easily manage documents and collect legally-binding eSignatures in a single interface.

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#.

FAQs

Below is a list of the most common airSlate SignNow API questions and answers. Just choose a question to view a detailed answer.

Need help? Contact support

Ready to get started?

It’s time to watch the airSlate SignNow API in action. Create your developer account and upload documents, request signatures, and check the status of your document.

Start API free trial Create a sandbox account

Why choose the airSlate SignNow API?:

Free to test and easy to deploy
SDKs for popular languages
Customizable for any workflow
Industry-leading security & compliance