CODEWITHSUNDEEP
docusignapi
so cal cheesehead
so cal cheesehead

Reputation: 2573

Docusign envelope AuthoritativeCopy is always null

I'm using the DocuSign SDK (c#) to retrieve information on an envelope I create and submit in which I set the Authoritative Copy setting. I get the envelope id however when I retrieve the envelope the property AuthoritativeCopy is always set to null.

If I download the API logs from the DocuSign console I can see that it's been set, here's a snippet from the JSON:

"authoritativeCopy": true

So I don't understand why I'm always getting null with the SDK. Am I misunderstanding what this property is supposed to be? Has anyone else run into this or something similar?

I also have the same issue with the field EnforceSignerVisibility, I made sure to turn on Document Visibility to "Must sign to view, unless sender" and I still always get null for the field. Again if I check the API logs I can see that it was enabled so why can't I see it via the Envelope object with the SDK? Could it be a permissions thing? I'm requesting a JWT user token to request envelope information.

Sample Request:

Request Headers:
"X-DocuSign-Authentication", "{"Username":"{{username}}","Password":"{{password}}","IntegratorKey": "{{integratorKey}}"}")

GET https://demo.docusign.net/restapi/v2/accounts/{{account}}/envelopes/{{envelopeId}}?advanced_update=true

Response:

{
"status": "sent",
"documentsUri": "/envelopes/{{envelopeId}}/documents",
"recipientsUri": "/envelopes/{{envelopeId}}/recipients",
"attachmentsUri": "/envelopes/{{envelopeId}}/attachments",
"envelopeUri": "/envelopes/{{envelopeId}}",
"emailSubject": "Document for eSignature",
"envelopeId": "{{envelopeId}}",
"signingLocation": "online",
"customFieldsUri": "/envelopes/{{envelopeId}}/custom_fields",
"autoNavigation": "true",
"envelopeIdStamping": "true",
"notificationUri": "/envelopes/{{envelopeId}}/notification",
"enableWetSign": "true",
"allowMarkup": "false",
"allowReassign": "true",
"createdDateTime": "2019-03-20T19:48:57.6370000Z",
"lastModifiedDateTime": "2019-03-20T19:48:57.6370000Z",
"initialSentDateTime": "2019-03-20T19:48:59.2470000Z",
"sentDateTime": "2019-03-20T19:48:59.2470000Z",
"statusChangedDateTime": "2019-03-20T19:48:59.2470000Z",
"documentsCombinedUri": "/envelopes/{{envelopeId}}/documents/combined",
"certificateUri": "/envelopes/{{envelopeId}}/documents/certificate",
"templatesUri": "/envelopes/{{envelopeId}}/templates",
"brandId": "{{brandId}}",
"purgeState": "unpurged",
"is21CFRPart11": "false",
"signerCanSignOnMobile": "true",
"isSignatureProviderEnvelope": "false",
"allowViewHistory": "true"
}

The response to the above request does not include the property enforceSignerVisibility however if I download the API request logs I can see that it's been set: 

...
...
"enableWetSign": "True",
"enforceSignerVisibility": "True",
"brandId": "",    
...
...

Upvotes: 0

Views: 317

Answers (2)

Amit K Bist
Amit K Bist

Reputation: 6818

If you have set enforceSignerVisibility as true after switching on DocVis under Admin then to fetch the enforceSignerVisibility value, you need to pass query parameter advanced_update=true in the GET /envelopes API call.

Upvotes: 0

Larry K
Larry K

Reputation: 49114

authoritativeCopy is set by DocuSign. You can't set it via the API.

After you want to download an authoritative copy from DocuSign then the envelope will show authoritativeCopy == false.

EnforceSignerVisibility is different. It needs to be first enabled at the account level. See the Admin Tool screen Sending Settings and the settings for Document Visibility. You need to check the box Allow sender to specify document visibility

Upvotes: 0

Related Questions