SequrSign API
Integrate programmatic document signing into your own product. Authenticate with an API key and hand signers off to the SequrSign signing flow.
Authentication
To access the SequrSign API endpoints, authenticate your requests using an API key. Generate your API key from the Settings screen, then send it as the X-API-Key header on every request to /app/sign.
The key identifies your account, so treat it as a credential. Keep it server-side, out of source control and out of anything that ships to a browser. If a key is exposed, generate a replacement from the Settings screen.
Send the key on every request. There is no session to establish first and no short-lived token to exchange it for.
API Endpoints
Initiate a programmatic signing request by directing the signer to the following deep link. Parameters are read by name from the query string:
https://app.seqursign.ai/pdfPreviewApp?docName=<docName>&id=<id>&firstName=<firstName>&lastName=<lastName>&emailId=<emailId>&companyName=<companyName>&jobTitle=<jobTitle>&selfSign=<true>&serialOrder=<true>&name=<name1,name2>&email=<email1,email2>&url=<url>&docId=<docId>| Parameter | Description |
|---|---|
docName | Name of the document to sign. |
id | Initiator user id. |
firstName / lastName | Initiator name. |
emailId | Initiator email. |
companyName / jobTitle | Initiator organization details. |
selfSign | true to include the initiator as a signer. |
serialOrder | true for serial signing order, else parallel. |
name / email | Comma-separated recipient names and emails. |
url | Source document URL. |
docId | Document id. |
Recipient names and emails are positional: the first name in name pairs with the first address in email, and so on. Set serialOrder to true when each signer must wait for the previous one, and leave it off when everyone can sign at the same time.
Building the link
Every value above is a query-string parameter, so URL-encode each one before concatenating. Document names with spaces, email addresses and job titles all need it, and an unencoded & anywhere in a value will truncate everything after it. The comma-separated name and email lists are single parameter values — encode the whole list, not each entry separately.
Credits and limits
API-initiated signing draws on the same credit balance as the dashboard: 5 credit points per signature request, 1 per identity verification. A request will not go out if the initiating account does not have the balance to cover it, so check the balance before you queue a batch. Packs and validity periods are on the pricing page.
Signers reached through the API get the same experience as everyone else: their own link, no account, and the same SHA-256 fingerprint recorded against the completed document. See how we verify document integrity for what that record proves. For anything not covered here, get in touch.