Get an embedded invite via eSign API

Promptly change the number of signers for a document before sending it out, and instantly delete the ones you no longer need using the airSlate SignNow API. Get total control over your signing order, recipients, and their activity.

Free to test
Fast to deploy
Powerful & secure

Manage roles the way you need and only share documents with required recipients using by deleting signers

Ensure your document will be received, checked, and signed by verified recipients only

Node.js

C#

Java

Python

cURL

Copy code

'use strict';
 
const signnow = require('@signnow/api-client')({
  credentials: 'BASE64_ENCODED_CLIENT_CREDENTIALS',
  production: true, // if false then uses eval server
});
const sendInvite = signnow.template.invite;
 
const id = 'TEMPLATE_ID_GOES_HERE';
const token = 'YOUR_ACCESS_TOKEN';
 
/**
 * @typedef {Object} SignerSettings
 * @property {string} email - signer's email
 * @property {string} role - ole name
 * @property {number} order - role signing order
 * @property {string} reassign - allow reassign signer
 * @property {string} decline_by_signature - signer can decline invite
 * @property {number} reminder - remind via email in days
 * @property {number} expiration_days - expiration of invite in days
 * @property {string} [subject] - specify subject of email
 * @property {string} [message] - specify body of email
 */
 
/**
 * @type {Object}
 * @property {string} document_id
 * @property {SignerSettings[]} to - array of signers
 * @property {string} from - email of sender
 * @property {string[]} [cc] - array with emails
 * @property {string} [subject] - specify subject of email
 * @property {string} [message] - specify body of email
 * @property {string} [on_complete] - on signing complete action
 */
const fieldInvite = {
  document_id: 'TEMPLATE_ID_GOES_HERE',
  to: [
    {
      email: 'EMAIL_OF_SIGNER_1',
      role: 'Signer 1',
      order: 1,
      reassign: '0',
      decline_by_signature: '0',
      reminder: 4,
      expiration_days: 27,
      subject: 'Field invite Signer1',
      message: 'Message1',
    },
    {
      email: 'EMAIL_OF_SIGNER_2',
      role: 'Signer 2',
      order: 1,
      reassign: '0',
      decline_by_signature: '0',
      reminder: 4,
      expiration_days: 27,
      subject: 'Field invite Signer2',
      message: 'Message2',
    },
  ],
  from: 'EMAIL_OF_SENDER',
};
 
/**
 * @param {Object} res
 * @param {string} res.status - e.g. 'success'
 */
const handleResponse = res => {
  console.log(res);
};
 
const handleError = err => {
  console.error(err);
};
 
sendInvite({
  data: {
    ...fieldInvite,
  },
  id,
  token,
}, (err, res) => {
  if (err) {
    handleError(err);
  } else {
    handleResponse(res);
  }
});

public class SendInviteModel
    {
        public IEnumerable<To> to { get; set; }
        public string from { get; set; }
        public object[] cc { get; set; }
        public string subject { get; set; }
        public string message { get; set; }
    }
 
    public class To
    {
        public string email { get; set; }
        public string role_id { get; set; }
        public string role { get; set; }
        public int order { get; set; }
        public string authentication_type { get; set; }
        public string password { get; set; }
        public int expiration_days { get; set; }
        public int reminder { get; set; }
        public string method { get; set; }
        public string phone { get; set; }
    }
public partial class RestSharpSamples
    {
        public static void SignatureInviteFromTemplate(string accessToken, string apiUrl, string templateId, SendInviteModel dataObj, string documentName = "", bool disableEmail = false)
        {
            var client = new RestClient { BaseUrl = new Uri(apiUrl) };
 
            var createDocumentrequest = new RestRequest("/template/" + templateId + "/copy", Method.POST)
                .AddHeader("Accept", "application/json")
                .AddHeader("Authorization", "Bearer " + accessToken);
 
            if (!string.IsNullOrEmpty(documentName))
            {
                createDocumentrequest.RequestFormat = DataFormat.Json;
                createDocumentrequest.AddBody(new { document_name = documentName });
            }
 
            var createDocumentResponse = client.Execute(createDocumentrequest);
 
            if (createDocumentResponse.StatusCode != HttpStatusCode.OK)
            {
                throw new Exception($"Can't create document from template. {createDocumentResponse.Content}");
            }
 
            var document = JsonConvert.DeserializeObject<CreateResponseModel>(createDocumentResponse.Content);
 
            var disable = (disableEmail) ? "?email=disable" : "";
            var request = new RestRequest("/document/" + document.id + "/invite" + disable, Method.POST)
                .AddHeader("Accept", "application/json")
                .AddHeader("Authorization", "Bearer " + accessToken);
 
            request.RequestFormat = DataFormat.Json;
            request.AddBody(dataObj);
 
            var response = client.Execute(request);
            if (response.StatusCode != HttpStatusCode.OK)
            {
                throw new Exception($"Cannot send invite. {response.Content}");
            }
        }
    }

try {
    //Create signature field in document
    Document.Field sign = new Document.Field();
    sign.x = 10;
    sign.y = 10;
    sign.height = 30;
    sign.width = 150;
    sign.type = Document.FieldType.SIGNATURE;
    sign.required = true;
    sign.pageNumber = 0;
    sign.role = "Signer role";
    sign.label = "Your signature here";
 
    Document.Field sign2 = new Document.Field();
    sign2.x = 10;
    sign2.y = 60;
    sign2.height = 30;
    sign2.width = 150;
    sign2.type = Document.FieldType.SIGNATURE;
    sign2.required = true;
    sign2.pageNumber = 0;
    sign2.role = "Another signer role";
    sign2.label = "Your signature here";
     
    //update document with signature field
    cli.documentsService().updateDocumentFields(documentId, Arrays.asList(sign, sign2));
     
    //create signers to roles mapping
    Document.InviteRole role1 = new Document.InviteRole("signer@client.biz", "Another signer role");
    role1.password = "password";
    Document.InviteRole role2 = new Document.InviteRole("signer2@client.biz", "Signer role");
    role2.password = "other_password";
 
    //execute request for invite
    Document.SigningInviteWithRolesRequest request = new Document.SigningInviteWithRolesRequest(
        "author@yourcompany.com",
        Arrays.asList(role1, role2)
    );
    request2.subject = "Document to sign";
    request2.message = "test FFI sign from cli";
    cli.documentsService().sendDocumentSignInvite(documentId, request);
} catch (SNException e) {
    e.printStackTrace();
}

import signnow_python_sdk

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, '*')

to = [{
        "email": "testemail@signnow.com",
        "role_id": "",
        "role": "Signer 1",
        "order": 1
    },
    {
        "email": "testemail1@signnow.com",
        "role_id": "",
        "role": "Signer 2",
        "order": 2

}]

invite_payload = {
        "to": to,
        "from": username
    }

# Create a document from the template
    doc_id = signnow_python_sdk.Template.copy(access_token['access_token'], template_id, "New Doc From Template")

# Get document data
    document_data = signnow_python_sdk.Document.get(access_token['access_token'], doc_id['id'])

# Send signature invite
    invite_response = signnow_python_sdk.Document.invite(access_token['access_token'], doc_id['id'], invite_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 get an embedded invite via esign api

The airSlate SignNow API equips businesses with a distinctive array of features that enhance operational efficiency. Discover the advantages of our get an embedded invite via esign api by signing up for a complimentary Sandbox account.

To set up a Sandbox account, follow these instructions:

Navigate to the airSlate SignNow Developers page. There, you can find additional details about the API and register for your Sandbox account.
Register for a trial. Enter your email address and click the Create API sandbox button to enroll.
Verify your email address. Access the email you receive and click the link provided to verify your email address.
Access Developer Sandbox. Create a password to gain further access to your developer account.
Add an application. Click Add App, provide a name for your app, and click Add to save the changes. The API token for the application will be generated automatically.
Evaluate get an embedded invite via esign api. Investigate all airSlate SignNow features and how they can enhance your business operations.

Follow these instructions to assess airSlate SignNow's functionalities. If you have any inquiries, you can reach out to the support team. Enhance your business workflows with airSlate SignNow today.

How it works

Create an account and get the required tokens

Use code samples to get an embedded invite via eSign 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