DocuSign API – Callback Web Service
To have Quik! generate your DocuSign envelopes using the Callback service, use this URL.
PLEASE VISIT THE URL'S BELOW FOR THE LATEST XML FORMAT
Service URL: https://websvcs.quikforms.com/Docusign/ESignWSVersion/5500/ESignWithOAuthToken.asmx
Service WSDL: https://websvcs.quikforms.com/Docusign/ESignWSVersion/5500/ESignWithOAuthToken.asmx?WSDL
Sample Project
There is no sample project for this method as it's built into the Quik! Forms Engine's methodology for using a callback URL to report the EnvelopeID to the originating program. This method is similar to the Pass-Thru method except that it uses the DocuSign OAuthToken instead of DocuSign credentials. The OAuthToken allows for the customer's DocuSign credentials to be kept private. To create an OAuthToken see the OAuthToken web service.
Methods:
The following methods are used to generate the PDF and XML data objects to send to DocuSign.
- GenerateDocusignEnvelope – Accepts the raw, posted data from a Quik! HTML form to generate a DocuSign envelope, returning the EnvelopeID
- GenerateDocusignEnvelopeJSON – Accepts the raw, posted data from a Quik! HTML form to generate a DocuSign envelope, returning the EnvelopeID in JSON format.
GenerateDocusignEnvelope
This method takes data posted directly by 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 directly to the form, which can then pass the EnvelopeID via a Callback URL.
SOAP Request
<?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> <GenerateDocusignEnvelope xmlns="https://websvcs.quikforms.com/docusign/esignws/"> <FormData>string</FormData> </GenerateDocusignEnvelope> </soap:Body> </soap:Envelope>
SOAP Body Request Parameters
This method accepts the following parameters.
Field Name | Data Type | Length | Required? | Description |
FormData | String | 8000 chars | YES | The form POST data |
SOAP Response
<?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/esignws/"> <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 |
GenerateDocusignEnvelopeJSON
This method takes data posted directly by 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 directly to the form, which can then pass the EnvelopeID via a Callback URL.
SOAP Request
<?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> <GenerateDocusignEnvelopeJSON xmlns="https://websvcs.quikforms.com/docusign/esignws/"> <FormData>string</FormData> </GenerateDocusignEnvelopeJSON> </soap:Body> </soap:Envelope>
SOAP Body Request Parameters
This method accepts the following parameters.
Field Name | Data Type | Length | Required? | Description |
FormData | String | 8000 chars | YES | The form POST data |
SOAP Response
<?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 |
For help regarding Quik! Forms and the Quik! API
Email: support@quikforms.com | Phone: (877) 456-QUIK