This document is a summary of the API endpoints provided by SignTime.
Please check SignTime API Documentation for additional details regarding the endpoints.
1. E-Signature Document Related (/documents)
Following is a list of endpoints related to e-signature documents.
1.1 Return all documents
GET /api/v1/documents
Returns a list with details of all documents.
Theper_page
parameter specifies the number of documents per page to return. The page
parameter specifies the page to return.
※Default : per_page = 25
page = 1
1.2 Return one document
GET /api/v1/documents/{id}
Returns details of the document specified by {id}(document ID).
1.3 Return URL to document field setup page
GET /api/v1/documents/{id}/builder
Returns the URL of the document field setup page of the document specified by {id}(document ID).
The URL (with token) will allow a user to access the field setup page without having to manually login.
1.4 Return URL to document preview page
GET /api/v1/documents/{id}/preview
Returns the URL of the document preview page of the document specified by {id}(document ID).
The URL (with token) will allow a user to access the preview page without having to manually login.
1.5 Create new document
POST /api/v1/documents/new
Creates a new document to be sent for signatures.
※Default : requests_via_sms = false
requires_pades = false
requires_signer_sequencing = false
parties[][is_cc] = false
expires_at = {+30 days}
1.6 Prepare document to send
POST /api/v1/documents/{id}/annotate
Updates the document specified by {id}(document ID) to a status where the document can be sent out.
1.7 Send document
POST /api/v1/documents/{id}/send
Sends the document specified by {id}(document ID) for signature requests.
1.8 Send reminders to parties
POST /api/v1/documents/{id}/send_reminders
Sends reminders to parties who have not completed their signature for the document specified by {id}(document ID).
1.9 Update document tag list
PATCH /api/v1/documents/{id}/update_tags
Updates tag list of the document specified by {id}(document ID).
Multiple tags can be added by separating the tags with a comma "," for the tag_list
parameter.
1.10 Update document expiration date
PATCH /api/v1/documents/{id}/update_expiration_date
Updates the expiration date of the document specified by {id}(document ID).
1.11 Update document metadata
PATCH /api/v1/documents/{id}/update_metadata
Updates the metadata of the document specified by {id}(document ID).
1.12 Delete document
DELETE /api/v1/documents/{id}
Deletes the document specified by {id}(document ID).
Only documents that have not been sent and documents that have been sent but with no signatures completed can be deleted.
*Documents where the only completed signature is that of the document sender can be deleted.
2 Party Related (/parties)
Following is a list of endpoints related to e-signature document parties.
2.1 Send reminder to party
POST /api/v1/parties/{id}/send_reminder
Sends reminders to the party specified by {id}(party ID).
3 Field Component Related (/components)
Following is a list of endpoints related to e-signature document field components.
3.1 Add field component
POST /api/v1/components/new
Adds a field component to an existing document.
4 Template Related (/templates)
Following is a list of endpoints related to templates.
4.1 Return all templates
GET /api/v1/templates
Returns a list with details of all templates.
The per_page
parameter specifies the number of templates per page to return. The page
parameter specifies the page to return.
※Default : per_page = 10
page = 1
4.2 Return one template
GET /api/v1/templates/{id}
Returns details of the template specified by {id}(template ID).
4.3 Launch template
POST /api/v1/templates/{id}/launch
Launches the template specified by {id}(template ID) and sends documents our for signatures.
※Default : requests_via_sms = false
requires_pades = false
4.4 Update template tag list
PATCH /api/v1/templates/{id}/update_tags
Updates tag list of the template specified by {id}(template ID).
Multiple tags can be added by separating the tags with a comma "," for the tag_list
parameter.
4.5 Clone template
PATCH /api/v1/templates/{id}/clone
Clones the template specified by {id}(template ID).
4.6 Delete template
DELETE /api/v1/templates/{id}
Deletes the template specified by {id}(template ID).
Only templates that have already not been used to send documents can be deleted.
5 Import File Related (/files)
Following is a list of endpoints related to file imports (ScanTime).
5.1 Return all files
GET /api/v1/files
Returns a list with details of all imported files.
The per_page
parameter specifies the number of files per page to return. The page
parameter specifies the page to return.
※Default : per_page = 10
page = 1
includes_trashed = false
5.2 Return one file
GET /api/v1/files/{id}
Returns details of the imported file specified by {id}(file ID).
5.3 Import new file *Additional fees
POST /api/v1/files/new
Imports a new file.
※Default : requires_pades = false
requires_timestamp = false
5.4 Update metadata of file
PATCH /api/v1/files/{id}/update
Updates the metadata of the imported file specified by {id}(file ID).
※Default : requires_pades = false
requires_timestamp = false
5.5 Delete file
DELETE /api/v1/files/{id}
Deletes the imported file specified by {id}(file ID).
6 Document/File Sharing Related (/shares)
Following is a list of endpoints related to document/file sharing (e-signature documents and imported files).
6.1 Return all shares
GET /api/v1/shares
Returns a list with shared documents and imported files.
6.2 Share new document / file
POST /api/v1/shares/new
Shares a document or imported file to the specified email.
6.3 Revoke document/file share
DELETE /api/v1/shares/{id}
Revokes a share for an imported file.
※Only for imported files
※Access to E-Signature documents can be restricted by adding an access code to the document
7 Timestamp Related (/timestamps)
Following is a list of endpoints related to timestamps.
7.1 Add timestamp *Additional fees
POST /api/v1/timestamps/new
Adds a timestamp to a uploaded PDF.
※Timestamped file will not be stored in SignTime
8 Other (/organizations, /users, /me, /ok)
Following is a list of endpoints related to user accounts, organization, etc.
8.1 Return all organizations
GET /api/v1/organizations
Returns a list and details of all organizations the API initiator belongs to.
8.2 Return one organization
GET /api/v1/organizations/{id}
Returns details of the organization specified by {id}(organization ID).
8.2 Return all users
GET /api/v1/users
Returns a list and details of all users belonging to the organization.
8.3 Return one user
GET /api/v1/users/{id}
Returns details of the user specified by {id}(user ID).
8.4 Return oAuth owner
GET /api/v1/me/{id}
Returns details of the API initiator.
8.5 Monitor
GET /api/v1/ok
Read More
For new inquiries about the API, please contact sales@signtime.com.