how to upload customized default consent form

Hi Cindy,

To upload customized default consent:

Step1: First you will need to set resource "default.consent.document" as null in backoffice (don't upload any document).

Step2: Then you have below options to upload your own document:
(1)If it's a general consent for all packages, you can directly replace it in above backoffice resource.

(2)If you are using template, I have a "Add Consent Tool" allowing ad-hoc users to replace default consent without extra coding or integration.

(3)For API integration, same payload should work after step1 were performed.

Duo

Hi Duo,

I found your website to add a document as default consent, but I tried and seems not work. could you please advise how to add a document as consent form?

{"approvals":[{"role":"Primary01"}],"index":1,"name":"Sample consent","isConsent":true}

Hi Cindy,

Let me put it another way: you have to create the package and define/replace default consent in separate two calls, that's why the payload you've posted didn't work.

Step1: create a package following the normal flow

{
  "name": "Testing package",
  "roles": [
    {
      "signers": [
        {
          "id": "Primary01",
          "firstName": "john",
          "lastName": "smith",
          "email": "[email protected]"
        }
      ],
      "name": "Primary01",
      "index": 0,
      "id": "Primary01"
    }
  ],
  "documents": [
    {
      "name": "consent",
      "id": "default-consent"
    },
    {
      "name": "doc6249A",
      "index": 1,
      "id": "6249A",
      "approvals": [],
      "extract": true
    }
  ]
}

It will be the same if you were using the Java SDK. Note you don't need to add signature or acceptance, or even the index for the "default-consent" document.

Step2: invoke a PUT call 

PUT /api/packages/{package_id}

with payload {"consent":"default-consent"}

This is a package level flag indicating which document ID will be specified as the default consent. This document's index will be automatically set to 0, and all signatures will be removed and be automatically added acceptance for all signers except the sender.

Duo

Hi Duo,

I see what you mean, for create a package with consent form, I need to create the package, then another call to specify which form is used for consent, right? same as add a consent form to the existing package: 1) add a document via API 2) specify which document is used for consent via another call, correct?

Yes, from my test, seems specifying "isConsent":true in document upload call won't work.

Duo