Document Group Invite

Document Group Invite is an object for requesting signatures on a Document Group.

POST /documentgroup/{document_group_id}/groupinvite creates a multi-step invite for a document group. This allows the Document Group owner to specify the signing order and assign documents to their recipients correctly.

The Document Group Invite request body consists of two array objects: invite_steps and completion_emails.

In the invite_steps the Document Group owner specifies the following parameters and arrays:

  • ”order” : integer, specifies the step when some signer(s) receive documents (starts with 1)
  • ”invite_emails”: array object, contains the list of signer(s) for this step with an email address + email subject and message (optional parameters here ”reminder”, ”expiration_days”, ”disabled”)
  • ”invite_actions”: array object, specifies who can sign the documents and who can only view them at a particular step by the email addresses mentioned in the ”invite_emails”. The available actions are "sign" and "view". Signer verification is available via a number of authentication methods.

Authentication methods:

      authentication_type: password
      password: 123456

      authentication_type: phone
      method: phone_call
      phone: +11111111111

      authentication_type: phone
      method: sms
      phone: +11111111111

Once all the invite_actions are completed, the next step’s invite emails are sent out. When all steps have been completed, completion emails are sent out.

In the completion_emails the Document Group owner sends confirmation emails to the recipients who have completed their actions.

Document Group Invite example
curl -L -X POST 'https://api-eval.signnow.com//documentgroup/{{document_group_id}}/groupinvite' \
-H 'Authorization: Bearer {{access_token}}' \
-H 'Content-Type: application/json' \
--data-raw '{
  "client_timestamp": 1586533427,
  "invite_steps": [
    {
      "order": 1,
      "invite_emails": [
        {
          "email": "signer1@email.com",
          "subject": "manager@email.com Needs Your Signature",
          "message": "manager@email.com invited you to sign 1",
          "expiration_days": 30,
          "reminder": 0
        },
        {
          "email": "signer2@email.com",
          "subject": "manager@email.com Sent You a Document",
          "message": "manager@email.com sent you 1",
          "expiration_days": 30,
          "reminder": 0
        }
      ],
      "invite_actions": [
        {
          "email": "signer1@email.com",
          "role_name": "Signer 1",
          "action": "sign",
          "document_id": "b89518d373b23d5c1d45d5c9af7953d1a868e4de",
          "allow_reassign": "0",
          "decline_by_signature": "0",
          "authentication": {
            "type": "phone",
            "method": "phone_call",
            "phone": "+1234543454"
          }
        },
        {
          "email": "signer1@email.com",
          "action": "view",
          "document_id": "b89518d373b23d5c1d45d5c9af7953d1a868e4de",
          "allow_reassign": "0",
          "decline_by_signature": "0"
        }
      ]
    },
    {
      "order": 2,
      "invite_emails": [
        {
          "email": "signer2@email.com",
          "subject": "manager@email.com Needs Your Signature",
          "message": "manager@email.com invited you to sign 1",
          "expiration_days": 30,
          "reminder": 0
        }
      ],
      "invite_actions": [
        {
          "email": "signer2@email.com",
          "role_name": "Signer 2",
          "action": "sign",
          "document_id": "b89518d373b23d5c1d45d5c9af7953d1a868e4de",
          "allow_reassign": "0",
          "decline_by_signature": "0"
        }
      ]
    }
  ],
  "completion_emails": []
}'