DocuSign API – OAuthToken Management
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 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/5500/OAuthToken.asmx
Service WSDL: https://websvcs.quikforms.com/Docusign/ESignWSVersion/5500/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 (note, some of DocuSign's NA# environments may not be live yet but are listed below for future use):
- 1 for DocuSign production accounts on NA1 (www.docusign.net)
- 2 for DocuSign DEMO accounts (demo.docusign.net)
- 3 for DocuSign production accounts on NA2 (na2.docusign.net)
- 4 for DocuSign production accounts in Europe on EU1 (eu1.docusign.net)
- 5 for DocuSign Preview accounts (preview.docusign.net)
- 9 for DocuSign Production NA3 (na3.docusign.net)
- 10 for DocuSign Production NA4 (na4.docusign.net)
- 11 for DocuSign Production NA5 (na5.docusign.net)
- 12 for DocuSign Production NA6 (na6.docusign.net)
- 13 for DocuSign Production NA7 (na7.docusign.net)
- 14 for DocuSign Production NA8 (na8.docusign.net)
- 15 for DocuSign Production NA9 (na9.docusign.net)
- 16 for DocuSign Production NA10 (na10.docusign.net)
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> <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>
SOAP Body Request Parameters
This method accepts the following parameters.
Field Name | Data Type | Length | Required? | Description |
ApplicationID | Integer | YES | Quik! Forms Engine users use ApplicationID = 3 |
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> <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>
Result Fields
This method returns a table containing the list of Sign Environment IDs.
Field Name | Data Type | Length | Description |
1 | String | Environment NA1 (www.docusign.net) | |
2 | String | Environment DEMO (demo.docusign.net) | |
3 | String | Environment NA2 (na2.docusign.net) | |
4 | String | Environment NA3 (na3.docusign.net) - formerly EU1 | |
5 | String | Environment Preview (preview.docusign.net) |
GetDocusignToken
This method retrieves your existing OAuthTokens that have been set up with Quik! by signing environment ID.
SignEnvironmentID Values
- 1 for DocuSign production accounts on NA1 (www.docusign.net)
- 2 for DocuSign DEMO accounts (demo.docusign.net)
- 3 for DocuSign production accounts on NA2 (na2.docusign.net)
- 4 for DocuSign production accounts in Europe on EU1 (eu1.docusign.net)
- 5 for DocuSign Preview accounts (preview.docusign.net)
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> <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>
SOAP Body Request Parameters
This method accepts the following parameters.
Field Name | Data Type | Length | Required? | Description |
ApplicationID | Integer | YES | Quik! Forms Engine users use ApplicationID = 3 | |
SignEnvironmentID | Integer | YES | The DocuSign environment where your OAuthToken will be generated |
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> <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>
Result Fields
This method returns a table containing the DocuSignToken for your account.
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.
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> <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>
SOAP Body Request Parameters
This method accepts the following parameters. NOTE: Quik! does not store your DocuSign username or password, rather it is passed to DocuSign to create an OAuthToken that is then stored by Quik!.
Field Name | Data Type | Length | Required? | Description |
DocusignUsername | String | 8000 chars | YES | Your username at DocuSign for the account that matches the SignEnvironmentID you're passing |
DocusignPassword | String | 8000 chars | YES | Your password at DocuSign for the account that matches the SignEnvironmentID you're passing |
ApplicationID | Integer | YES | Quik! Forms Engine users use ApplicationID = 3 | |
SignEnvironmentID | Integer | YES | The DocuSign environment where your OAuthToken will be generated |
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> <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>
Result Fields
This method returns a table containing the DocuSignToken for your account.
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!.
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> <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>
SOAP Body Request Parameters
This method accepts the following parameters.
Field Name | Data Type | Length | Required? | Description |
DocusignToken | String | 8000 chars | NO | The DocuSign OAuthToken value stored by Quik! |
ApplicationID | Integer | YES | Quik! Forms Engine users use ApplicationID = 3 | |
SignEnvironmentID | Integer | YES | The DocuSign environment where your OAuthToken will be generated |
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> <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>
Result Fields
This method only returns an error code and message indicating success or failure.
Related pages
For help regarding Quik! Forms and the Quik! API
Email: support@quikforms.com | Phone: (877) 456-QUIK