Advanced Signi API call examples

Modified on Thu, 13 Jun at 10:19 AM

When submitting files or template documents via the Signi API, a crucial part of the JSON is the signing scenario that determines who will sign, in what order, how they will sign, approve, etc.

OBSAH

UI vs. API signing scenarios
Advanced examples of using Signi API
Examples of JSON files
Basic examples of Signi API calls

UI vs. API signing scenarios

In order to send documents for signing, a signing scenario is essential information that tells who should sign the document(s). "How" means e.g.

in which language the communication about the document is conducted,
the order in which the signatories are to be addressed,
how the signatories are to be identified,
what signature they will be able to sign with, etc.

The script is entered:

in the Signi user interface as one of the steps in preparing a document for signature,
Similarly, in the Signi API when calling endpoints to sign a file or when passing parameters for a pattern as part of JSON.

{
"contract_name":"Signi-PBI-OrganzationOverview",
"number": "",
"locale": "cs",
"settings": {
  "signing_order": "proposers_before_counterparties",
  "autosign_proposers": "V Praze"
},
"people": [
  {
    "is_proposer": true,
    "email": "demo@signi.com",
    "contract_role": "sign"
  },
  {
    "is_proposer": false,
    "party_order": 1,
    "email": "demo+API@signi.com",
    "contract_role": "sign",
  "person_type": "nature",
        "first_name": "John",
        "last_name": "Doe#2"
  }
],

Signing scenario entered via UI on the signature scenario page

A signing scenario specified via API in a JSON file sent as part of a request

Advanced examples of using Signi API

Examples of JSON files

Examples of JSON files for different situations can be found in the folder below. You can download them, try them against the Demo API workspace with API key - "71c4123d242bdd38047bee838d17e3367dc3ea6748d0975217ce501e834a224c83cab8afd35c9b0e6ade806b7987fae80f97f5c8253cfbb9089cf21f" and then modify them according to your needs.

Basic examples of Signi API calls

You can find these and more context at Signi API Call Examples.