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

submitters

 "submitters": [
   {
     "firstname":"Quentin",
     "lastname":"Danneville",
     "email":"quentin.test@gmail.com",
     "fields": [
        {
            "document":"2dbaf7dd-982c-423e-be04-c3e76f7ddcfe",
            "type":"signature",
            "name":"signature custom text",
            "area" : {
                "x":200,
                "y":200,
                "w":200,
                "h":200,
                "page":0
            }
        }
     ]
   }
]

fields Array
List of field type

signature
text
date
checkbox
initials
stamp

fields

"fields": [
      {
          "document":"2dbaf7dd-982c-423e-be04-c3e76f7ddcfe",
          "type":"signature",
          "name":"signature custom text",
          "area" : {
              "x":200,
              "y":200,
              "w":200,
              "h":200,
              "page":0
          }
      },
      {
          "document":"2dbaf7dd-982c-423e-be04-c3e76f7ddcfe",
          "type":"signature",
          "name":"signature custom text",
          "area" : {
              "x":400,
              "y":400,
              "w":100,
              "h":100,
              "page":0
          }
      }
   ]

📘

Content-Type : application/json

NodeJS

var axios = require("axios").default;
 
const data = {
 "name":"Test submission",
 "template":"73e135cc-19c0-468e-a218-e6e5062e2af9",
 "send_email":true,
 "custom_message":"Bonjour, je suis un test de signature.nc",
 "submitters": [
   {
     "firstname":"Quentin",
     "lastname":"Danneville",
     "email":"quentin.test@gmail.com",
     "fields": [
        {
            "document":"2dbaf7dd-982c-423e-be04-c3e76f7ddcfe",
            "type":"signature",
            "name":"signature custom text",
            "area" : {
                "x":200,
                "y":200,
                "w":200,
                "h":200,
                "page":0
            }
        }
     ]
   },
   {
     "firstname":"Test",
     "lastname":"Nc",
     "email":"testnc@gmail.com",
     "fields": [
        {
            "document":"2dbaf7dd-982c-423e-be04-c3e76f7ddcfe",
            "type":"signature",
            "name":"signature custom text",
            "area" : {
                "x":200,
                "y":200,
                "w":200,
                "h":200,
                "page":0
            }
        },
        {
            "document":"2dbaf7dd-982c-423e-be04-c3e76f7ddcfe",
            "type":"signature",
            "name":"signature custom text",
            "area" : {
                "x":400,
                "y":400,
                "w":100,
                "h":100,
                "page":0
            }
        }
     ]
   }
]
}
 
var options = {
  method: 'POST',
  url: 'https://api.signature.nc/api/v2/submissions',
  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": "Test submission",
    "locale": "fr",
    "uuid": "6c7de11e-f4cd-4455-87dc-72ec0e37b1f6",
    "sendEmail": true,
    "customMessage": "Bonjour, je suis un test de signature.nc",
    "createdAt": "2025-04-02T02:39:05.638Z",
    "updatedAt": "2025-04-02T02:39:08.321Z",
    "senderInformation": null,
    "template": {
        "name": "API Template updated",
        "createdAt": "2025-04-02T02:07:19.514Z",
        "updatedAt": "2025-04-02T02:39:01.260Z",
        "uuid": "73e135cc-19c0-468e-a218-e6e5062e2af9"
    },
    "createdBy": {
        "firstname": "Quentin",
        "lastname": "Danneville",
        "email": "qdanneville@digit.nc"
    },
    "submitters": [
        {
            "email": "quentin.test@gmail.com",
            "firstname": "Quentin",
            "lastname": "Danneville",
            "signedDocuments": null,
            "signerInformation": null,
            "completedAt": null,
            "signatureLink": "http://localhost:3000/sign/c08f0b15-b17b-48a6-9555-ec2e4adb5229",
            "status": "sent",
            "isOpen": false,
            "uuid": "c08f0b15-b17b-48a6-9555-ec2e4adb5229",
            "openedAt": null,
            "isApprobation": false,
            "isCompleted": false,
            "isRejected": false,
            "rejectionReason": null,
            "isIdentityVerified": false,
            "createdAt": "2025-04-02T02:39:06.699Z",
            "updatedAt": "2025-04-02T02:39:06.699Z"
        },
        {
            "email": "testnc@gmail.com",
            "firstname": "Test",
            "lastname": "Nc",
            "signedDocuments": null,
            "signerInformation": null,
            "completedAt": null,
            "signatureLink": "http://localhost:3000/sign/b8a73e1a-978f-4407-bb22-125960577578",
            "status": "sent",
            "isOpen": false,
            "uuid": "b8a73e1a-978f-4407-bb22-125960577578",
            "openedAt": null,
            "isApprobation": false,
            "isCompleted": false,
            "isRejected": false,
            "rejectionReason": null,
            "isIdentityVerified": false,
            "createdAt": "2025-04-02T02:39:06.727Z",
            "updatedAt": "2025-04-02T02:39:06.727Z"
        }
    ]
}

Get a submission Delete a submission