To use the Callback or Turnkey e-sign methods you'll need to set up an OAuthToken with DocuSign. The OAuthToken is a permanent representation of your DocuSign credentials that never expire until revoked by you. By using the OAuthToken you avoid sharing your DocuSign credentials with Quik! and do not have to worry about Quik! breaking if your password changes. This web service is used to set up and revoke OAuthTokens. You only need one OAuthToken per environment that you're using with Quik! (e.g. the DocuSign production or demo environments).
PLEASE VISIT THE URL'S BELOW FOR THE LATEST XML FORMAT
Service URL: https://websvcs.quikforms.com/Docusign/ESignWSVersion/5202/OAuthToken.asmx
Service WSDL: https://websvcs.quikforms.com/Docusign/ESignWSVersion/5202/OAuthToken.asmx?WSDL
Methods:
The following methods are used to manage your OAuthTokens.
- GetDocusignEnvironments – Gets a list of available environments to use with e-signature
- GetDocusignToken – Retrieves your OAuthTokens that have been set up with Quik!
- CreateOAuth2Token – Creates a new OAuthToken for your Quik! CustomerID and DocuSign environment
- RevokeOAuth2Token – Revokes an OAuthToken that is stored by Quik!
GetDocusignEnvironments
This method retrieves the list of available SignEnvironmentID values:
...
<?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>
<AuthenticationHeader xmlns="https://websvcs.quikforms.com/docusign/esignws/">
<CustomerID>string</CustomerID>
<Username>string</Username>
<Password>string</Password>
</AuthenticationHeader>
</soap:Header>
<soap:Body>
<GetDocusignEnvironments xmlns="https://websvcs.quikforms.com/docusign/esignws/">
<ApplicationID>int</ApplicationID>
</GetDocusignEnvironments>
</soap:Body>
</soap:Envelope>
...
<?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>
<GetDocusignEnvironmentsResponse xmlns="https://websvcs.quikforms.com/docusign/esignws/">
<GetDocusignEnvironmentsResult>
<ErrorCode>int</ErrorCode>
<Message>string</Message>
<ResultData>
<xsd:schema>schema</xsd:schema>xml</ResultData>
<File>base64Binary</File>
</GetDocusignEnvironmentsResult>
</GetDocusignEnvironmentsResponse>
</soap:Body>
</soap:Envelope>
...
Field Name | Data Type | Length | Description |
| String |
|
|
| String |
|
|
GetDocusignToken
This method retrieves your existing OAuthTokens that have been set up with Quik! by signing environment ID.
SignEnvironmentID Values
...
<?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>
<AuthenticationHeader xmlns="https://websvcs.quikforms.com/docusign/esignws/">
<CustomerID>string</CustomerID>
<Username>string</Username>
<Password>string</Password>
</AuthenticationHeader>
</soap:Header>
<soap:Body>
<GetDocusignToken xmlns="https://websvcs.quikforms.com/docusign/esignws/">
<ApplicationID>int</ApplicationID>
<SignEnvironmentID>int</SignEnvironmentID>
</GetDocusignToken>
</soap:Body>
</soap:Envelope>
...
<?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>
<GetDocusignTokenResponse xmlns="https://websvcs.quikforms.com/docusign/esignws/">
<GetDocusignTokenResult>
<ErrorCode>int</ErrorCode>
<Message>string</Message>
<ResultData>
<xsd:schema>schema</xsd:schema>xml</ResultData>
<File>base64Binary</File>
</GetDocusignTokenResult>
</GetDocusignTokenResponse>
</soap:Body>
</soap:Envelope>
...
Field Name | Data Type | Length | Description |
DocusignToken | String | 255 | The DocuSign OAuthToken value stored by Quik! |
CreateOAuth2Token
This method creates a new OAuthToken for your Quik! CustomerID and DocuSign environment.
...
<?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>
<AuthenticationHeader xmlns="https://websvcs.quikforms.com/docusign/esignws/">
<CustomerID>string</CustomerID>
<Username>string</Username>
<Password>string</Password>
</AuthenticationHeader>
</soap:Header>
<soap:Body>
<CreateOAuth2Token xmlns="https://websvcs.quikforms.com/docusign/esignws/">
<DocusignUsername>string</DocusignUsername>
<DocusignPassword>string</DocusignPassword>
<ApplicationID>int</ApplicationID>
<SignEnvironmentID>int</SignEnvironmentID>
</CreateOAuth2Token>
</soap:Body>
</soap:Envelope>
...
<?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>
<CreateOAuth2TokenResponse xmlns="https://websvcs.quikforms.com/docusign/esignws/">
<CreateOAuth2TokenResult>
<ErrorCode>int</ErrorCode>
<Message>string</Message>
<ResultData>
<xsd:schema>schema</xsd:schema>xml</ResultData>
<File>base64Binary</File>
</CreateOAuth2TokenResult>
</CreateOAuth2TokenResponse>
</soap:Body>
</soap:Envelope>
...
Field Name | Data Type | Length | Description |
DocusignToken | String | 255 | The DocuSign OAuthToken value stored by Quik! |
RevokeOAuth2Token
This method revokes an OAuthToken that is stored by Quik!.
...
<?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>
<AuthenticationHeader xmlns="https://websvcs.quikforms.com/docusign/esignws/">
<CustomerID>string</CustomerID>
<Username>string</Username>
<Password>string</Password>
</AuthenticationHeader>
</soap:Header>
<soap:Body>
<RevokeOAuth2Token xmlns="https://websvcs.quikforms.com/docusign/esignws/">
<DocusignToken>string</DocusignToken>
<ApplicationID>int</ApplicationID>
<SignEnvironmentID>int</SignEnvironmentID>
</RevokeOAuth2Token>
</soap:Body>
</soap:Envelope>
...
<?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>
<RevokeOAuth2TokenResponse xmlns="https://websvcs.quikforms.com/docusign/esignws/">
<RevokeOAuth2TokenResult>
<ErrorCode>int</ErrorCode>
<Message>string</Message>
<ResultData>
<xsd:schema>schema</xsd:schema>xml</ResultData>
<File>base64Binary</File>
</RevokeOAuth2TokenResult>
</RevokeOAuth2TokenResponse>
</soap:Body>
</soap:Envelope>
...
This method only returns an error code and message indicating success or failure.