Change Package owner

Scenario 1 : Packages are in status 'completed' or 'in progress'

Prerequisites:

  • API Url
  • Signinghub Username & Password
  • Signinghub Client ID and Secret
  • Current Package owner email adress
  • Package ID's of the packages that need to be changed (you can use the 'Get Packages' api call to retrieve the package ID's Get Packages Manual)
  • Email address of new package owner


API calls to execute:

  1. Authenticate (Authenticate Manual)
  2. Change Document Package Owner (Change Document Package Owner Manual)
    • Fill in the user email in the request body

       Example Body

      {
          "owner": "sh2@keysign.site"
      }


Scenario 2 : Packages are in status 'pending'

Prerequisites:

  • API Url
  • Signinghub Username & Password
  • Signinghub Client ID and Secret (link to info)
  • Current Package owner email adress
  • Package ID's of the packages that need to be changed (you can use the 'Get Packages' api call to retrieve the package ID's)
  • Email address of new package owner


API calls to execute:

  1. Authenticate (Authenticate Manual)
  2. Get Workflow Details (Get Workflow Details Manual)
    • in the body of the response you will be able to see which order the current signer is in , note this value for the following request

       example response

         "users": [
              {
                  "order": 1,
                  "user_name": "KeySign",
                  "user_email": "sh@keysign.site",
                  "group_name": null,
                  "group_members": null,
                  "delegator": null,
                  "role": "SIGNER",
                  "process_status": "IN_PROGRESS",
                  "processed_on": null,
                  "processed_as": null,
                  "processed_by": null,
                  "reason": null,
                  "placeholder": null,
                  "permission": {
                      "print": true,
                      "download": true,
                      "add_text": true,
                      "change_recipients": true,
                      "add_attachment": true,
                      "legal_notice": {
                          "enabled": false,
                          "allowed_notices": [],
                          "default_notice": null
                      }
                  },

  3. Update Workflow User (Update Workflow User Manual)
    • fill in the user email and user name in the body of the request

       Example body

      {
          "user_email": "sh2@keysign.site",
          "user_name": "Keysign User 2",
          "role": "SIGNER"
      }

  4. Change Document Package Owner (Change Document Package Owner Manual)
    • Fill in the user email in the request body

       Example Body

      {
          "owner": "sh2@keysign.site"
      }