NOTE: SOAP are legacy web services originally developed for the Quik! APIs. At this time, they are deprecated and no longer in use. This guide is here for documentation purposes only.
To have Quik! generate your DocuSign envelopes using the Pass-Thru service, use this URL.
PLEASE VISIT THE URL'S BELOW FOR THE LATEST XML FORMAT
Service URL: https://websvcs.quikforms.com/Docusign/ESignWSVersion/53005500/ESignForPartnersWS.asmx
Service WSDL: https://websvcs.quikforms.com/Docusign/ESignWSVersion/53005500/ESignForPartnersWS.asmx?WSDL
Sample Project
See the DocuSign_PassThroughWS_SamplePartnerProject.zip included with the Quik! Forms EngineQuik! Pass Thru Sample Project on the Downloads page for more information.
Methods:
The following methods are used to generate the PDF and XML data objects to send to DocuSign.
...
This method takes data posted to a partner or customer URL from a Quik! HTML form and then creates an envelope in DocuSign by generating and passing the form data as an XML file and PDF document. This method returns a DocuSign EnvelopeID.
SOAP Request
| Code Block | ||||
|---|---|---|---|---|
| ||||
<?xml version="1.0" encoding="utf-8"?> |
...
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> |
...
<soap:Header> |
...
<DocuSignCredentials xmlns="https://websvcs.quikforms.com/Docusign/ESignWSVersion/5202/"> |
...
<UserName>string</UserName> |
...
<Password>string</Password> |
...
</DocuSignCredentials> |
...
</soap:Header> |
...
<soap:Body> |
...
<GenerateDocusignEnvelope xmlns="https://websvcs.quikforms.com/Docusign/ESignWSVersion/5202/"> |
...
<FormData>string</FormData> |
...
</GenerateDocusignEnvelope> |
...
</soap:Body> |
...
</soap:Envelope> |
SOAP Header Request Parameters
...
Field Name | Data Type | Length | Required? | Description |
UserName | String | YES | The customer's DocuSign API username | |
Password | String | YES | The customer's DocuSign API password |
...
The API username should look something like this:
[Integrator_Key]EmailAddress
For example [EFFI-aabb99cc-aabbcc-aa07bcc-9759-ea43eaa]tsmith@example.com
...
Field Name | Data Type | Length | Required? | Description |
FormData | String | 8000 chars | YES | The form POST data |
SOAP Response
| Code Block | ||||
|---|---|---|---|---|
| ||||
<?xml version="1.0" encoding="utf-8"?> |
...
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> |
...
<soap:Body> |
...
<GenerateDocusignEnvelopeResponse xmlns="https://websvcs.quikforms.com/Docusign/ESignWSVersion/5202/"> |
...
<GenerateDocusignEnvelopeResult> <ErrorCode>int</ErrorCode> <Message>string</Message> <ResultData> <xsd:schema>schema</xsd:schema>xml</ResultData> <File>base64Binary</File> </GenerateDocusignEnvelopeResult> </GenerateDocusignEnvelopeResponse> </soap:Body> |
...
</soap:Envelope> |
Result Fields
This method returns a table containing the DocuSign EnvelopeID.
Field Name | Data Type | Length | Description |
EnvelopeID | String | The DocuSign-EnvelopeID for the newly generated envelope |
...
This method takes data posted to a partner or customer URL from a Quik! HTML form and then creates an envelope in DocuSign by generating and passing the form data as an XML file and PDF document. This method returns a DocuSign EnvelopeID in JSON format.
SOAP Request
| Code Block | ||||
|---|---|---|---|---|
| ||||
<?xml version="1.0" encoding="utf-8"?> |
...
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> |
...
<soap:Header> |
...
<DocuSignCredentials xmlns="https://websvcs.quikforms.com/docusign/esignws/"> |
...
<UserName>string</UserName> |
...
<Password>string</Password> |
...
</DocuSignCredentials> |
...
</soap:Header> |
...
<soap:Body> |
...
<GenerateDocusignEnvelopeJSON xmlns="https://websvcs.quikforms.com/docusign/esignws/"> |
...
<FormData>string</FormData> |
...
</GenerateDocusignEnvelopeJSON> |
...
</soap:Body> |
...
</soap:Envelope> |
SOAP Header Request Parameters
...
Field Name | Data Type | Length | Required? | Description |
UserName | String | YES | The customer's DocuSign API username | |
Password | String | YES | The customer's DocuSign API password |
...
The API username should look something like this:
[Integrator_Key]EmailAddress
For example [EFFI-aabb99cc-aabbcc-aa07bcc-9759-ea43eaa]tsmith@example.com
...
Field Name | Data Type | Length | Required? | Description |
FormData | String | 8000 chars | YES | The form POST data |
SOAP Response
| Code Block | ||||
|---|---|---|---|---|
| ||||
<?xml version="1.0" encoding="utf-8"?> |
...
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> |
...
<soap:Body> |
...
<GenerateDocusignEnvelopeJSONResponse xmlns="https://websvcs.quikforms.com/docusign/esignws/"> |
...
<GenerateDocusignEnvelopeJSONResult>string</GenerateDocusignEnvelopeJSONResult> |
...
</GenerateDocusignEnvelopeJSONResponse> |
...
</soap:Body> |
...
</soap:Envelope> |
Result Fields
This method returns the DocuSign EnvelopeID in JSON format.
Field Name | Data Type | Length | Description |
EnvelopeID | String | The DocuSign-EnvelopeID for the newly generated envelope in JSON format |
...