organizationId once on the plugin or store organization_id on the account.
Things to know before you sign:
- Signing is asynchronous. The three
submitoperations return as soon as SignPath queues the work. PollsigningRequests.getStatusuntilisFinalStatusis true. The plugin declares those three as jobs, soget_jobfollows the same status field.resubmitreturns the new request’s id (read from theLocationheader SignPath answers with); poll it withsigningRequests.getStatus. - Nothing is signed until the policy says so. A signing policy with
numberOfRequiredApprovalsabove zero holds each request inWaitingForApprovaluntil enough approvers callsigningRequests.approve.signingRequests.denyrejects a request permanently, andsigningRequests.cancelstops one that has not finished; neither can be undone. - Creating is not enabling. A new project, signing policy and artifact configuration is inactive. Call the matching
activateoperation, or the configuration will refuse submissions. - Pick the upload route by artifact size.
submitWithArtifactsends the bytes in one multipart request (base64 in the input).submitWithArtifactRetrievalLinkhas SignPath download the artifact from a URL you provide, which is what SignPath documents for large files.submitWithoutArtifactreturns anuploadLinkyou deliver the artifact to afterwards. - Hash and message signing answer immediately.
signingRequests.signHashandsigningRequests.signMessagereturn the signature in the response, with no artifact and no waiting period. Each needs its algorithm’s options object, and the schema rejects the call before sending when it is missing. - Artifact configurations are XML.
artifactConfigurations.getXmlreturns the document as text, andupdateXmlreplaces it wholesale; SignPath does not merge. - Paging.
signingRequests.listreturnspagination.nextLink, a full URL that already contains your filters. Pass it back asnextLinkto read the next page.auditLog.listEventspages withpagination.nextCursorinstead. - Downloads are not wrapped.
signingRequests.getreturnssignedArtifactLink; fetching that link returns the binary itself, which this plugin does not stream. - Preview route. The two audit log operations call
v1-pre, the preview path SignPath keeps them under.
- 34 typed API operations
Setup
1
Install
2
Add the plugin
corsair.ts
multiTenancy: true, scope calls with corsair.withTenant(id). See Quick start for KEK + Hub keys, and Multi-tenancy for account isolation.3
Choose authentication
- API Key (Recommended)
Store the SignPath API key before the first call: More: API Key
pnpm corsair setup --plugin=signpath --tenant=acme api_key=<your-key> (leave out --tenant without multiTenancy), or pass it as key in the plugin options. With Hub, each tenant enters their own key on the connect page. See API key auth.4
Connect a tenant
Mint a connect link and send the tenant to it. Hub hosts the page and delivers the result to your app — see Connect / OAuth.
Example API calls
Check whether a signing request finishedWhat’s next
API reference
Every
signpath.api.* operation with input and output types.Connect / OAuth
createLink, Hub delivery, and tenant connect flows.
Use with agents
Expose this plugin’s operations as MCP tools.