ShareLinksApi
All URIs are relative to https://api.esignlaunchpad.com
| Method | HTTP request | Description |
|---|---|---|
| listShareLinks | GET /api/v1/share-links | List Share Links |
| mintShareLink | POST /api/v1/packages//share-links | Mint Share Link |
| revokeShareLink | DELETE /api/v1/share-links/ | Manually revoke a share link. |
listShareLinks
ListShareLinksResult listShareLinks(packageGuid, includeRevoked, page, pageSize)
List Share Links
List share links for the caller's tenant, optionally filtered by package. Returns a paginated summary of share links the tenant has minted. Active links by default; pass `includeRevoked=true` to include revoked rows in the listing for audit / admin purposes. Only the recipient email and access metadata are returned - the share token itself is NOT exposed (it's reconstructable only at mint time).
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| packageGuid | UUID | [optional] [default to null] | |
| includeRevoked | Boolean | [optional] [default to false] | |
| page | Integer | [optional] [default to 1] | |
| pageSize | Integer | [optional] [default to 25] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
mintShareLink
MintShareLinkResult mintShareLink(packageGuid, MintShareLinkApiRequest)
Mint Share Link
Mint a recipient-email-gated download link for a package artifact. Creates a single-recipient share link bound to the supplied email address. The recipient receives an email-OTP challenge before being issued a short-lived SAS download URL - possession of the link alone is not sufficient. Supported scopes are `SignedDocument` (one document, requires `scopedDocumentGuid`), `AllSignedDocuments` (every signed PDF in the package, no audit data), `EvidencePack` (full pack with signed docs + certificate of completion + audit JSON/CSV + signature images), and `CertificateOfCompletion` (just the CoC PDF). **Use cases:** - Zapier action: send a signed contract to a contact in your CRM. - MCP tool: AI agent shares an evidence pack with a regulator. - Portal admin: distribute a CoC to internal compliance. **Constraints:** - Package must be in `Completed` status (the artifacts must exist). - `expiresInDays` must be between 1 and the configured maximum (default 365). Default is 30 if omitted. - `maxAccesses` is null (unlimited) or a positive integer (1 = view-once).
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| packageGuid | UUID | [default to null] | |
| MintShareLinkApiRequest | MintShareLinkApiRequest |
Return type
Authorization
HTTP request headers
- Content-Type: application/json, text/json, application/*+json
- Accept: application/json
revokeShareLink
RevokeShareLinkResult revokeShareLink(shareLinkId, RevokeShareLinkApiRequest)
Manually revoke a share link.
Idempotent - already-revoked links return success without re-stamping the revocation timestamp. The recipient sees the same terminal UX (collapsed \"no longer available\" page) as for any other inactive state. The revocation reason supplied here is recorded on the audit trail and emitted as part of the `share_link.revoked` webhook payload for downstream integration awareness.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| shareLinkId | Long | [default to null] | |
| RevokeShareLinkApiRequest | RevokeShareLinkApiRequest | [optional] |
Return type
Authorization
HTTP request headers
- Content-Type: application/json, text/json, application/*+json
- Accept: application/json