E-Signature Services
- Austin Logie (Unlicensed)
- Sarah Zacky
- Ben Cortez
Description
The collection of Quik! Forms Engine E-Signature services are used to implement E-Signature features and capabilities within your environment.
Endpoint URL: https://websvcs.quikforms.com/rest/esignature/
Endpoint Documentation: https://websvcs.quikforms.com/rest/esignature/swagger/index.html
How to Authorize on Swagger
- Retrieve your Quik! token by calling the following service in a tool such as Postman: https://websvcs.quikforms.com/rest_authentication/token
- In the body, enter the correct grant_type for your account: grant_type=password&username=YOUR_USERNAME&password=YOUR_PASSWORD
- Content-type should be: application/x-www-form-urlencoded
- Copy the returned access_token value
- In swagger, click the Authorize button, and in the value field, type Bearer, a space, and paste your token value (e.g. Bearer YOUR_TOKEN_VALUE)
- Now you can select any method on the swagger page, click the Try it out button, enter parameters, and test the method
DocuSign Services
Service | URL | TYPE | Service Description | Parameters |
|---|---|---|---|---|
| Sign with DocuSign | /docusign/sign | POST | The endpoint where the Sign button posts to when the signing process is handled by Quik! rather than the customer. | posted data |
| Revoke DocuSign Token | /docusign/oauthtokens | DELETE | Revokes a DocuSign token for the specified Environment and CustomerUserID | Token, Environment ID, CustomerUserID |
| Get DocuSign Token by CustomerID | /docusign/oauthtokens | GET | Gets the list of DocuSign tokens associated to the given CustomerID | CustomerID |
Create DocuSign Token | /docusign/oauthtokens NOTE: Starting September 30 2024, this method will no longer be accepted by Docusign. Existing tokens using this method will still work, but you will not be able to create new tokens using this method. Please refer to our updated method to create Docusign OAuth tokens: Docusign Authentication (Create OAuth Tokens) | POST | Creates a DocuSign token | { |
| Get DocuSign Token by Environment | /docusign/oauthtokens/environments/{SignEnviromentID} | GET | Gets the list of DocuSign tokens associated to the given CustomerID and SignEnvironmentID | CustomerID, Environment ID |
| Get DocuSign Token by Environment and CustomerUserID | /docusign/oauthtokens/environments/{SignEnviromentID}/customerusers/{customerUserID} | GET | Gets the DocuSign Token for the given SignEnvironmentID and CustomerUserID | SignEnvironmentID, CustomerUserID |
| Get DocuSign Environments | /docusign/environments | GET | Gets the list of available Docusign Environments | |
| Get Envelope Data | /docusign/selfservice/envelopedata | POST | Gets the necessary information for generating a DocuSign envelope. This method is used for implementing the Self Service model only. | PostedDada |
SIGNiX Services
Service | URL | TYPE | Service Description | Parameters |
|---|---|---|---|---|
| Get SIGNiX Environments | /signix/environments | GET | Gets the list of available SIGNiX environments | |
| Delete SIGNiX Credentials | /signix/credentials/{environmentID} | DELETE | Delete credentials for the customer by environment | environmentID |
| Get SIGNiX Credentials | /signix/credentials/{environmentID} | GET | Gets credentials for the customer by environment | environmentID |
| Get SIGNiX Credentials for Customer | /signix/credentials | GET | Gets list of all available credentials for the customer | |
| Add SIGNiX Credentials | /signix/credentials | POST | Add SIGNiX credentials | userData (Username, Password, SignEnviromentID, ClientID, Sponsor) |
For help regarding Quik! Forms and the Quik! API
Email: support@quikforms.com | Phone: (877) 456-QUIK