API Endpoints
The jSign API provides support for the following operations:
| Operation (Link) | Description | Call |
|---|---|---|
| Authentication | ||
| Login to the API | Uses the base64 encoded string generated by the user to access the API. | POST /api/v2.0/authorization/token |
| Refresh Token | Generate a new access token when the one in use expires. | POST /api/v2.0/authorization/refresh_token |
| Envelopes | ||
| Upload File | Upload a file (or files) to jSign | POST /api/v2.0/envelopes/upload_file |
| Create with Files | Create an envelope using the documents uploaded using the POST /api/v2.0/envelopes/upload_file call. | POST /api/v2.0/envelopes/create_with_files |
| Create Envelope | Create an envelope in jSign with a base64 file payload. | POST /api/v2.0/envelopes/create |
| Create Envelope with Template | Create an envelope using a template ID and provided parameters. | POST /api/v2.0/envelopes/create_with_template |
| Envelope Details | Get metadata for an envelope. | GET /api/v2.0/envelopes/{envelopeId}/details |
| Envelope History | Get the signing history of a given envelope. | GET /api/v2.0/envelopes/{envelopeId}/history |
| Download Envelope Document | Download a copy of a signed or unsigned document in an envelope. | GET /api/v2.0/envelopes/{envelopeId}/{documentId}/download |
| Decline | Decline to sign an envelope (with a valid reason). | POST /apiv2.0/envelopes/{envelopeId}/decline |
| Cancel | Cancel an envelope. | POST /api/v2.0/envelopes/{envelopeId}/cancel |
| Remind | Send a reminder email to the signer to sign the envelope. | POST /api/v2.0/envelopes/{envelopeId}/remind_signer |
| Audit Logs | Get the audit logs of a signed envelope. | GET /api/v2.0/envelopes/{envelopeId}/audit_logs |
| Embedded Signing | View/sign an envelope on a web application using an iFrame. | GET /api/v2.0/envelopes/{envelopeId}/generate_embedded_url/{signerEmail} |
| Update Envelope Metadata | Update metadata for a specified envelope. | POST /api/v2.0/envelopes/{envelopeId}/update_envelope_metadata |
| Retrieve Envelope Metadata | Obtain envelope metadata using envelope ID. | GET /api/2.0/envelopes/{envelopeId}/retrieve_metadata |
| Create Envelope List | Create a list of envelopes using data filters. | POST /api/v2.0/envelopes/list |
| Delete Envelope |
Delete a signed envelope. |
POST /v2.0/envelopes/{envelopeId}/delete |
| Extend Envelope Signing Due Date | Extend signing due date of expired envelopes. | PUT /v2.0/envelopes/{envelopeId}/extend_signing_due_date |
| Templates | ||
| Upload File | Upload a new file to create an envelope template. | POST /api/v2.0/templates/upload_file |
| Create with Files | Create a template using the file uploaded in the upload_file API call. | POST /api/v2.0/templates/create_with_files |
| Create Template | Create a template with a base64 payload. | POST /api/v2.0/template/create |
| Get List of Available Templates | Get a list of the templates to which you have access rights. | GET /api/v2.0/templates/list?page={{page}}&pageSize={{pageSize}} |
| Template Actions |
This method deletes, activates, or deactivates a template. |
PUT /api/v2.0/templates/{templateId}/action/{action-name} |
| Attachments | ||
| Add Attachments | Add attachments to the document being signed. | POST /api/v2.0/envelopes/{envelopeId}/upload_supporting_document |
| List Attachments | Get a list of attachments by envelope ID. | GET /api/2.0/envelopes/{envelopeId}/list_supporting_document |
| Download Attachments | Download an attachment by envelope ID and attachment ID. | GET /api/2.0/envelopes/{envelopeId}/supportingdocuments/{supportingDocumentId}/download |
| Account | ||
| Account Details | Obtain details about the account. | GET /api/v2.0/account |
| Envelope Statistics | Obtain account envelope statistics. | GET/api/v2.0/account/statistics |