Specifically, we get these errors: "Validation error: The 'http://www.docusign.net/API/3.0:UserName' element is invalid ... The actual length is greater than the MaxLength value." But I have not been able to find any documentation about what the maximum length of this field is. I'd like to warn users of this value so they don't have to do trial and error to get it to work. Specs on all the field limitations would be useful. Or if the error message message said something along the line of "...is greater than the MaxLength value of 50."
The XSD provides this type of information, but I'm not sure whether or not DocuSign makes the XSD available for public consumption. I'll leave it to #Ergin (DocuSign) to comment on that, and to provide the link to the XSD if appropriate. Regarding specifically the UserName field, Max Length seems to be 100.
The API Documentation has info on field limits. You go the DocuSign API Documentation page, open either the Online SOAP API guide or the SOAP PDF guide, and do a search for CreateAndSendEnvelope. See page 40 of the PDF guide for instance.
The guide lists the schema of the call, and if you read the descriptions they state the maximum limits. For instance, it states the email subject is maximum 100 characters, email blurb is maximum 2000 characters, etc.
For envelope recipients you'll see a link that leads you to the Recipients schema (see page 53 of the PDF). On there, you can see that UserName is maximum 100 characters.
Related
Let's say I'm getting payouts information https://stripe.com/docs/api/payouts/list
I want to get the destination info, so if we take the example from the docs:
I want the details from that destination, I don't mean the specific details like the exact credit card number, but the info when going on the page itself, this one:
It's not working listing the banks accounts https://stripe.com/docs/api/customer_bank_accounts/list , I'm getting zero results when list them all
I'm using Golang library but I think this solution can be solved by others programming languages
I'm also using expandable fields but I get blank results on bank_account and card details
what is interesting however, is when debugging the page, they make request to v1/payouts/{id} with expand[]: balance_transaction and the returned data contains the bank information, but when I do it with their API, that info is not returned back
The Payout destination is expandable, meaning you can have it replaced with the full object by sending you request with expand[]=destination or for a list command data.destination.
Is there a way that I can provide any custom document metadata when adding documents to my DocuSign envelopes when using the REST API?
DocuSign appear to enforce the use of a positive integer for the DocumentId's we provide in the envelope. Whilst we are indeed using a positive integer, sometimes, there is some additional info that we need to supply, which we would like to come back in the DocuSign webhook events for specific documents.
I've had a look at the Document object but can't see anything obvious that I could use. An example would be simply providing a true/false along with a specific document, which I can inspect when I receive the DS webhook events.
At the moment, the only workaround I can think of is to add an Envelope Custom Field which contains any of my DocumentId's where 'true' is applicable, which feels like a bit of a shoddy solution, and I don't know if there's a character limit in those Envelope Custom Fields, which could break such a workaround.
Custom envelope text fields give you complete flexibility on providing meta-data that you can get back from the webhook. Here is some information about this:
This is how you create a custom field for an envelope:
https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeCustomFields/create/
This article shows code examples in 7 languagues on how to get the custom fields values :
https://developers.docusign.com/docs/esign-rest-api/how-to/get-envelope-custom-field-values/
The DocuSign REST API has some descriptions that include the width for string fields. But many string fields don't have a width in the description. I have found references here and their site to some of those being 100 characters. Is there a Docusign default max length for these string fields that don't have widths defined?
The reason for this is that some data is going to be extracted, and stored in a database table for analysis.
I've gone over the Swagger, the DocuSign REST API documentation pages, and a bunch of the Stackoverflow pages.
100 is probably a good default maximum length if you don't have any documentation saying otherwise for this specific field.
If you have a need to confirm a specific field maximum length - I can inquire about this for you. I do know this limit (100) as the right maximum for several specific fields.
The DocuSign SOAP API lists various limits on API fields, e.g. Username can be a maximum of 100 chars, Email can be a maximum of 100 chars. Does this mean that together, the "friendly name" and the email address can be 200 chars?
For Example, would this be okay (i.e. only an email):
ThisIsAReallyLongUserNameWhichWillBeAbout58CharactersLong#gmail.com ?
And this would NOT be okay:
ThisIsAReallyLongUserNameWhichWillBeAbout58CharactersLong [ThisIsAReallyLongUserNameWhichWillBeAbout58CharactersLong#gmail.com] ?
And what happens if those (or other) string limits are exceeded? Is an error thrown or is it just truncated? If an error, what kind of error?
Using the Visual Studio debugger, I modified input fields, and checked the results of the fields in the Envelope which are the the most important to our application (which uses the SOAP API):
Document Name: This gets truncated to 100 characters by the DocuSign System. No error is generated.
Recipients -> UserName: if this is greater than 100 characters, the DocuSign SOAP API throws an "Unspecified Error"
Recipients -> Email: This would be truncated to 100 characters by the DocuSign System ... and therefore the above sample would become something like this "ThisIsAReallyLongUserNameWhichWillBeAbout58CharactersLong [ThisIsAReallyLongUserNameWhichWillBeAbou". No error was generated, but it would fail if used as an email address.
Email Subject: This gets truncated to 100 characters by the DocuSign System. No error is generated.
Background: We use the DocuSign SOAP API method CreateEnvelopeFromTemplatesAndForms for a very clear reason (mainly, we don't want to keep track of page numbers and X/Y coordinates) and we do not want to stop using this api method (unless there is another method that doesn't force us to keep track of page numbers and X/Y coordinates). I mention this before someone happily suggests I use another method.
Problem: We've recently been asked to send large envelopes through the DocuSign api (could exceed 100 mb). I know that DocuSign doesn't place a limit on envelope size, but rather on size of payload per api call when the envelope is created. I think what we need to do is the following, but I am having trouble:
Step 1: load up to 50 mb in the templates
Step 2: call CreateEnvelopeFromTemplatesAndForms but set the ActivateEnvelope parameter to False
Step 3: load up to another 50 mb in the a new set of templates
Step 4: call CreateEnvelopeFromTemplatesAndForms again but this time set the ActivateEnvelope parameter to True.
Is what I'm trying to do possible? I keep getting an error that says the "TransactionID has already been used." If what I'm trying to do (in general) is possible, any code samples would be much appreciated.
I believe Anchor Tags is a viable and easy to use feature that should solve your issue here. With anchor tags you can still use the CreateEnvelopeFromTemplateAndForms() API call but you won't have to specify page numbers or (x,y) coordinates for your DocuSign Stick-eTabs. Instead, those tabs will get "anchored" to your documents based on content that it finds in the document itself.
For instance, let's say you have a document that needs to be signed and in the document where the signature should go you have the text "Sign Here". You can have the system place a signature tab close to this "Sign Here" text. You could have it place it X amount of pixels to the right, or Y inches or cms to the right, etc.
You can add these tabs at the account level, which means they will get applied whenever their corresponding text is found in ANY envelope you create in your account, OR you could add them in your API request so that they are only used on that particular envelope.
For more info please see the following links:
Previous Stack Overflow Question
Explanation on Dev Center - look at Tab Positioning section