Skip to main content

API Access and Developer Hub

Written by Thandolwethu Mbatha

The API documentation provides technical information for teams who would like to connect their own systems to QuicklySign.

This can be useful if your organisation would like to automate parts of the document signing process instead of only preparing and sending documents manually through the user interface.

The API documentation is intended for technical users, such as developers or internal IT teams, who will be responsible for setting up and maintaining the integration.

Requirements

  • You must have access to a QuicklySign account.

  • API access must be enabled for your account.

  • A technical team member or developer should be available to review and implement the API documentation.


What can the API be used for?

The API can assist with workflows such as:

  • Creating document packs through the API.

  • Creating documents from templates.

  • Sending documents for signing.

  • Generating signing links.

  • Retrieving audit trails.

  • Checking document statuses.

  • Using webhooks to receive updates when certain document events occur.


When should I use the API?

The API may be useful if your team would like to connect QuicklySign to another system or reduce the amount of manual work required when preparing, sending, or tracking documents.

For example, your team may want to create documents from an internal system, send documents for signing from another platform, generate signing links, or receive updates when document statuses change.


When should I use the user interface instead?

If you only need to upload, prepare, send, and track documents manually, the user interface is usually the best option.

The API is mainly intended for teams who want to connect QuicklySign to another system or automate parts of their document workflow.


Accessing the API documentation
You may review the API documentation here:

The API documentation includes technical information such as authentication, available endpoints, request examples, and response details.


API access

If you need API access enabled for your account, please contact our Solutions team at [email protected].


Expected Outcome

  • Your technical team can review the API documentation and determine whether the API is suitable for your workflow.

  • Your organisation can identify where the API may assist with document creation, sending, signing links, status checks, audit trails, or webhooks..


FAQs

Do I need to use the API to send documents?

No. If you are preparing and sending documents manually, you can continue using the user interface.

Who should use the API documentation?

The API documentation is mainly intended for developers or technical teams who will be setting up the integration.

Can the API be used with templates?

Yes. The API can be used to create documents from templates.

Can I check document progress through the API?

Yes. The API can be used to check document statuses and retrieve audit trails.

Can the API notify our system when something changes?

Yes. Webhooks can be used to send updates to your system when certain document events occur.


Contact Support

Should you require any further assistance with this, please contact our Solutions team at [email protected].

Did this answer your question?