Create a signature request

POST/submissions

The API endpoint provides the functionality to create a signature request.

Request Body Properties

name String
Name of the submission
template String
The unique identifier of the template
send_email Boolean (default true)
Set false to disable signature request emails sending.
customMessage String
The custom message the signer is going to receive on their email invitation
locale String 'en' | 'fr'
The locale used when we're sending the invitation email
submitters Array
List of signers
- firstname String
- lastname String
- email String

📘

Content-Type : application/json

NodeJS

var axios = require("axios").default;
 
const data = {
 "name":"My submission test name",
 "template":"24498f77-761c-4695-8df0-218c84059a95",
 "send_email":true,
 "submitters": [
   {
     "firstname":"Quentin",
     "lastname":"Danneville",
     "email":"quentin.danneville@gmail.com"
   },
   {
     "firstname":"Bob",
     "lastname":"lamoule",
     "email":"qdanneville@digit.nc"
   }
  ]
}
 
var options = {
  method: 'POST',
  url: 'https://api.signature.nc/api/v1/templates',
  headers: {'Authorization': 'Bearer {apiKey}','content-type': 'application/json'},
  body: data
};
 
axios.request(options).then(function (response) {
  console.log(response.data);
}).catch(function (error) {
  console.error(error);
});

json

{
    "name": "My submission test name",
    "createdAt": "2024-05-27T04:54:51.637Z",
    "updatedAt": "2024-05-27T04:54:51.637Z",
    "locale": "fr",
    "uuid": "a54af2ab-2668-44f8-896b-7e16cc6c8c53",
    "sendEmail": true,
    "customMessage": null,
    "template": {
        "name": "API Template v3",
        "createdAt": "API Template v3",
        "updatedAt": "API Template v3",
        "uuid": "24498f77-761c-4695-8df0-218c84059a95"
    },
    "submitters": [
        {
            "email": "marie.curie@test.com",
            "createdAt": "2024-05-27T04:54:51.599Z",
            "updatedAt": "2024-05-27T04:54:51.599Z",
            "firstname": "Marie",
            "lastname": "Curie",
            "uuid": "45319197-5bdf-4ec6-8294-4dcc47b0c67d"
        },
        {
            "email": "john.doe@test.com",
            "createdAt": "2024-05-27T04:54:51.615Z",
            "updatedAt": "2024-05-27T04:54:51.615Z",
            "firstname": "John",
            "lastname": "Doe",
            "uuid": "efc1f9d1-f2b3-4ffa-9602-abbfdf0c03eb"
        }
    ],
    "createdBy": {
        "firstname": "Action",
        "lastname": "Man",
        "email": "action.man@test.com"
    }
}

List all submissions Activate a submission