DocuSign API – Self-Service Web Service

NOTE: GetDocuSignResources and GetDocuSignResourcesJSON no longer exist beginning with version 5.5 of the Quik! Forms Engine. For details on how to implement Self Service with version 5.5 and later, please see the DocuSign Self Service page of this documentation.


If you plan to collect your own envelope information and call the Quik! web service for Docusign directly, then use this URL.

PLEASE VISIT THE URL'S BELOW FOR THE LATEST XML FORMAT

Service URL: https://websvcs.quikforms.com/Docusign/ESignWSVersion/5500/GetDocusignData.asmx
Service WSDL: https://websvcs.quikforms.com/Docusign/ESignWSVersion/5500/GetDocusignData.asmx?WSDL

Methods:

The following methods are used to generate the PDF and XML data objects to send to DocuSign. Only ETI can perform this step – this function cannot be implemented on your own servers.

  • GetDocusignResources – Prepares and returns a PDF and XML file for DocuSign in XML response format
  • GetDocusignResourcesJSON – Prepares and returns a PDF and XML file for DocuSign in JSON response format


GetDocusignResources

This method processes forms to create an XML file and PDF document for use with DocuSign and responds in XML format.

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>
<GetDocusignResources xmlns="https://websvcs.quikforms.com/Docusign/ESignWSVersion/5202/">
<strFormData>string</strFormData>
<strRecipientData>string</strRecipientData>
<strSignFieldData>string</strSignFieldData>
</GetDocusignResources>
</soap:Body>
</soap:Envelope>

SOAP Body Request Parameters

This method accepts the following parameters.

Field Name

Data Type

Length

Required?

Description

strFormData

String

8000 chars

NO

The form POST data

strRecipientData

String

8000 chars

NO

The recipient data used in the DocuSign envelope to determine the signing order

strSignFieldData

String

8000 chars

NO

The signature field data

Sample Request Data

strFormData:

QFECompany=Efficient+Technology%2C+Inc.&QFEProduct=QuikFormsEngine&QFEVersion=5.4.6264.21925&QFETrademark=Efficient+Technology+Inc%2C+Quik!+and+Take+The+Work+Out+Of+Paperwork+are+either+trademarks+or+registered+trademarks+of+Efficient+Technology%2C+Inc.&QFECopyright=Copyright+%C2%A9+2017%2C+Efficient+Technology%2C+Inc.&QFECustomerID=10001126&QFEApplicationID=0&QFEUserID=-1&QFVUNID=UNID%3D4Taqjdesk8M1GFiT9Z5%252f66j3dUD5wNjwUlVM7tOaJxEhQLAoOXXNqzzsAgKZnVUH&Quik.FormID=38002%2C25525%2C25524&BadFormIDs=&FormId-Instance.1=38002&1own.FullName=Smith&1own.H.Addr123=&1own.H.Addr4=&1own.H.City=&1own.H.State=&1own.H.Zip=&1own.H.Country=&1own.H.Email=&1own.SSN=&1own.DOB=&1own.DependentNum=&1own.H.Phone=&1own.O.Phone=&1own.M.Addr123=&1own.M.Addr4=&1own.M.City=&1own.M.State=&1own.M.Zip=&1own.M.Country=&1own.GOV.IDTypeOther=&1own.GOV.ID=&1own.GOV.IDState=&1own.GOV.IDIssueDate=&1own.GOV.IDExpire=&1own.Occupation=&1own.Employer=&1own.O.Addr123=&1own.O.Addr4=&1own.O.City=&1own.O.State=&1own.O.Zip=&1own.O.Country=&1own.PublicCoName=&1own.PublicCoTicker=&1own.ExchangeName=&1cus.FullName=&1cus.H.Addr123=&1cus.H.Addr4=&1cus.H.City=&1cus.H.State=&1cus.H.Zip=&1cus.H.Country=&1cus.H.Email=&1cus.SSN=&1cus.DOB=&1cus.DependentNum=&1cus.H.Phone=&1cus.O.Phone=&1cus.M.Addr123=&1cus.M.Addr4=&1cus.M.City=&1cus.M.State=&1cus.M.Zip=&1cus.M.Country=&1cus.GOV.IDTypeOther=&1cus.GOV.ID=&1cus.GOV.IDState=&1cus.GOV.IDIssueDate=&1cus.GOV.IDExpire=&1cus.Occupation=&1cus.Employer=&1cus.O.Addr123=&1cus.O.Addr4=&1cus.O.City=&1cus.O.State=&1cus.O.Zip=&1cus.O.Country=&1cus.PublicCoName=&1cus.PublicCoTicker=&1cus.ExchangeName=&1acc.FundSrcOther.Desc=&1own.PortObjOtherDesc=&1own.PortTimeHorizOther=&1own.RiskToleranceOther=&txt1.01=&txt1.02=&txt1.03=&1own.InvestExperOther=&txt2.01=&txt2.02=&1ben.FullName=Jason++Statham&1ben.SSN=&1ben.DOB=&1ben.Citizenship=&1ben.BenePerc=&1tte.FullName=&1ben.RelToClient=&2ben.FullName=&2ben.SSN=&2ben.DOB=&2ben.Citizenship=&2ben.BenePerc=&2tte.FullName=&2ben.RelToClient=&3ben.FullName=&3ben.SSN=&3ben.DOB=&3ben.Citizenship=&3ben.BenePerc=&3tte.FullName=&3ben.RelToClient=&4ben.FullName=&4ben.SSN=&4ben.DOB=&4ben.Citizenship=&4ben.BenePerc=&4tte.FullName=&4ben.RelToClient=&5ben.FullName=&5ben.SSN=&5ben.DOB=&5ben.Citizenship=&5ben.BenePerc=&5tte.FullName=&5ben.RelToClient=&1cben.FullName=&1cben.SSN=&1cben.DOB=&1cben.Citizenship=&1cben.BenePerc=&6tte.FullName=&1cben.RelToClient=&2cben.FullName=&2cben.SSN=&2cben.DOB=&2cben.Citizenship=&2cben.BenePerc=&7tte.FullName=&2cben.RelToClient=&3cben.FullName=&3cben.SSN=&3cben.DOB=&3cben.Citizenship=&3cben.BenePerc=&8tte.FullName=&3cben.RelToClient=&4cben.FullName=&4cben.SSN=&4cben.DOB=&4cben.Citizenship=&4cben.BenePerc=&9tte.FullName=&4cben.RelToClient=&5cben.FullName=&5cben.SSN=&5cben.DOB=&5cben.Citizenship=&5cben.BenePerc=&10tte.FullName=&5cben.RelToClient=&1own.38002.1.SignDate=&2own.38002.1.SignDate=&3own.38002.1.SignDate=&1rep.FullName=&1rep.RepNum=&1rep.38002.1.SignDate=&1osj.FullName=&1osj.RepNum=&1osj.38002.1.SignDate=&1own.38002.1.Sign=&2own.38002.1.Sign=&3own.38002.1.Sign=&1rep.38002.1.Sign=&1osj.38002.1.Sign=&FormId-Instance.2=25525&1acc.RegTypeOther=&1own.FullName=Smith&1own.H.Addr123=&1own.H.City=&1own.H.State=&1own.H.Zip=&1own.M.Addr123=&1own.M.City=&1own.M.State=&1own.M.Zip=&1own.SSN=&1own.DOB=&1own.H.Phone=&1own.O.Phone=&1own.H.Email=&1own.DependentsNum=&1own.Employer=&1own.Occupation=&1own.EO.Addr123=&1own.EO.City=&1own.EO.State=&1own.EO.Zip=&1own.Citizenship=&1own.GOV.IDTypeOther=&1own.GOV.ID=&1own.GOV.IDCountry=&1own.GOV.IDIssueDate=&1own.GOV.IDExpire=&2own.FullName=&2own.H.Addr123=&2own.H.City=&2own.H.State=&2own.H.Zip=&2own.M.Addr123=&2own.M.City=&2own.M.State=&2own.M.Zip=&2own.SSN=&2own.DOB=&2own.H.Phone=&2own.O.Phone=&2own.H.Email=&2own.DependentsNum=&2own.Employer=&2own.Occupation=&2own.EO.Addr123=&2own.EO.City=&2own.EO.State=&2own.EO.Zip=&2own.Citizenship=&2own.GOV.IDTypeOther=&2own.GOV.ID=&2own.GOV.IDCountry=&2own.GOV.IDIssueDate=&2own.GOV.IDExpire=&1own.Income.AmtHigh=&1own.LiquidAssets.AmtHigh=&1own.PublicCoName=&1own.PublicCoTicker=&1own.PoliticalOfficialInfo=&1own.InvestExperTypeOtherDesc=&2own.Income.AmtHigh=&2own.LiquidAssets.AmtHigh=&2own.PublicCoName=&2own.PublicCoTicker=&2own.PoliticalOfficialInfo=&2own.InvestExperTypeOtherDesc=&1acc.PortObjCapitalPreservation=&1acc.PortObjIncome=&1acc.PortObjGrowthAndIncome=&1acc.PortObjAggressiveGrowth=&1acc.PortObjGrowth=&1acc.PortObjSpeculation=&1acc.FundSrcOtherDesc=&1own.25525.1.SignDate=&2own.25525.1.SignDate=&1rep.FullName=&1rep.RepNum=&1rep.25525.1.SignDate=&1osj.FullName=&1osj.25525.1.SignDate=&1own.25525.1.Sign=&2own.25525.1.Sign=&1rep.25525.1.Sign=&1osj.25525.1.Sign=&FormId-Instance.3=25524&Group1=&Group1=&1acc.AcctNum=&Quik.Barcode=12345678&calcFields=%7B%221own.LName%22%3A%22Smith%22%2C%221ben.FName%22%3A%22Jason%22%2C%221ben.LName%22%3A%22Statham%22%2C%221ben.H.Addr1%22%3A%22555+State+Street%22%2C%221ben.H.City%22%3A%22Los+Angeles%22%2C%221ben.H.State%22%3A%22CA%22%2C%221ben.H.Zip%22%3A%2290007%22%2C%221ben.H.Addr123%22%3A%22555+State+Street%22%2C%221ins.LName%22%3A%22Smith%22%7D&RoutingRulesOn=FALSE&Quik.CustomFieldMetaData=&MultilineMetaData=%5B%5D&GeoLocationOn=true&ProductLicenseID=0&nativeESign=false&SignEnvironmentID=1

strRecipientData:

1own_0.Order=1&1own_0.Name=Smith&1own_0.Mail=a%40a.com&1own_0.SendType=ETS&1own_0.AccessCode=&1own_0.IdentityCheck=0&1own_0.PhoneNumber=&EndOfRecord=&2own_0.Order=2&2own_0.Name=&2own_0.Mail=&2own_0.SendType=None&2own_0.AccessCode=&2own_0.IdentityCheck=0&2own_0.PhoneNumber=&EndOfRecord=&3own_0.Order=3&3own_0.Name=&3own_0.Mail=&3own_0.SendType=None&3own_0.AccessCode=&3own_0.IdentityCheck=0&3own_0.PhoneNumber=&EndOfRecord=&1rep_0.Order=4&1rep_0.Name=&1rep_0.Mail=&1rep_0.SendType=None&1rep_0.AccessCode=&1rep_0.IdentityCheck=0&1rep_0.PhoneNumber=&EndOfRecord=&1osj_0.Order=5&1osj_0.Name=&1osj_0.Mail=&1osj_0.SendType=None&1osj_0.AccessCode=&1osj_0.IdentityCheck=0&1osj_0.PhoneNumber=&EndOfRecord=&hostName=&hostEmail=&subject=Sign+Subject+test&message=The+attached+forms+were+completed+and+prepared+for+you+to+sign.%0D%0A%0D%0A-+Trustman+Financial%2C+Inc+-+IRA+Application%0D%0A-+Trustman+Financial%2C+Inc+-+New+Account+Form%0D%0A-+Trustman+Financial%2C+Inc+-+Account+Transfer+Form%0D%0A%0D%0APlease+sign+these+forms+by+clicking+the+link.%0D%0A%0D%0A%0D%0A%0D%0A%0D%0A%0D%0A(FormViewID%3A+4Taqjdesk8M1GFiT9Z5%252f66j3dUD5wNjwUlVM7tOaJxEhQLAoOXXNqzzsAgKZnVUH)&signAllDocsCombined=False&signMultipleDocs=False

strSignFieldData:

[{"Rol":"1-1_38002","FieldName":"1own.38002.1.Sign","Page":"5","XCoord":"41","YCoord":"341","XDateCoord":"229","YDateCoord":"369","FormID":"38002","SignInitials":"0"},{"Rol":"2-1_38002","FieldName":"2own.38002.1.Sign","Page":"5","XCoord":"40","YCoord":"380","XDateCoord":"228","YDateCoord":"408","FormID":"38002","SignInitials":"0"},{"Rol":"3-1_38002","FieldName":"3own.38002.1.Sign","Page":"5","XCoord":"41","YCoord":"420","XDateCoord":"229","YDateCoord":"448","FormID":"38002","SignInitials":"0"},{"Rol":"1-14_38002","FieldName":"1rep.38002.1.Sign","Page":"5","XCoord":"294","YCoord":"500","XDateCoord":"482","YDateCoord":"529","FormID":"38002","SignInitials":"0"},{"Rol":"1-66_38002","FieldName":"1osj.38002.1.Sign","Page":"5","XCoord":"293","YCoord":"545","XDateCoord":"481","YDateCoord":"573","FormID":"38002","SignInitials":"0"},{"Rol":"1-1_25525","FieldName":"1own.25525.1.Sign","Page":"8","XCoord":"33","YCoord":"164","XDateCoord":"218","YDateCoord":"194","FormID":"25525","SignInitials":"0"},{"Rol":"2-1_25525","FieldName":"2own.25525.1.Sign","Page":"8","XCoord":"301","YCoord":"164","XDateCoord":"509","YDateCoord":"195","FormID":"25525","SignInitials":"0"},{"Rol":"1-14_25525","FieldName":"1rep.25525.1.Sign","Page":"8","XCoord":"301","YCoord":"200","XDateCoord":"508","YDateCoord":"231","FormID":"25525","SignInitials":"0"},{"Rol":"1-66_25525","FieldName":"1osj.25525.1.Sign","Page":"8","XCoord":"301","YCoord":"256","XDateCoord":"510","YDateCoord":"286","FormID":"25525","SignInitials":"0"}]


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>
<GetDocusignResourcesResponse xmlns="https://websvcs.quikforms.com/Docusign/ESignWSVersion/5202/">
<GetDocusignResourcesResult>
<ErrorCode>int</ErrorCode>
<Message>string</Message>
<ResultData>
<xsd:schema>schema</xsd:schema>xml</ResultData>
<File>base64Binary</File>
</GetDocusignResourcesResult>
</GetDocusignResourcesResponse>
</soap:Body>
</soap:Envelope>

Result Fields

This method returns a table containing the PDF and the DocuSign-ready XML.

Field Name

Data Type

Length

Description

PDF

Base64 String


Returns the PDF file in a Base64 string that can be converted back to a Byte array

DSignXML

String


The DocuSign-ready XML with envelope information (e.g. recipients, field locations, etc.)


GetDocusignResourcesJSON

This method processes forms to create an XML file and PDF document for use with DocuSign and responds in JSON format (instead of XML format).

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>
<GetDocusignResourcesJSON xmlns="https://websvcs.quikforms.com/Docusign/ESignWSVersion/5202/">
<strFormData>string</strFormData>
<strRecipientData>string</strRecipientData>
<strSignFieldData>string</strSignFieldData>
</GetDocusignResourcesJSON>
</soap:Body>
</soap:Envelope>

SOAP Body Request Parameters

This method accepts the following parameters.

Field Name

Data Type

Length

Required?

Description

strFormData

String

8000 chars

NO

The form POST data

strRecipientData

String

8000 chars

NO

The recipient data used in the DocuSign envelope to determine the signing order

strSignFieldData

String

8000 chars

NO

The signature field 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>
<GetDocusignResourcesJSONResponse xmlns="https://websvcs.quikforms.com/Docusign/ESignWSVersion/5202/">
<GetDocusignResourcesJSONResult>string</GetDocusignResourcesJSONResult>
</GetDocusignResourcesJSONResponse>
</soap:Body>
</soap:Envelope>

Result Fields

This method returns a table containing the PDF and the DocuSign-ready XML.

Field Name

Data Type

Length

Description

PDF

Base64 String


Returns the PDF file in a Base64 string that can be converted back to a Byte array

DSignXML

String


The DocuSign-ready XML with envelope information (e.g. recipients, field locations, etc.)

Related pages

For help regarding Quik! Forms and the Quik! API
Email: support@quikforms.com | Phone: (877) 456-QUIK