eSign API Suite

This API allows you to send a document for digital signing to one or more participants.

Q. What is ReferenceId?

referenceId (required) is your unique transaction identifier used to track this workflow end-to-end in your own system. Use letters, numbers, hyphen (-) and underscore (_) only, 1 to 64 characters. A referenceId that was already used is rejected.

Q. What is documentInfo?

documentInfo specifies the primary document that needs to be signed.

• name (required): The display name of the file, for example Agreement.pdf. Maximum 50 characters.

• content (required unless documentId is sent): The entire PDF file converted to a Base64 string. Maximum 20 MB.

• documentId (optional): Use this if the document is already uploaded or stored in the SignCare system. Must be a valid GUID.

Q. What are supportingDocuments?

supportingDocuments is an optional array of additional files (Base64) that signers can view for reference during the signing process. Each item needs name, contentType and content. Accepted formats: PDF (up to 10 MB), PNG and JPEG (up to 1 MB). Note that these documents are not signed.

Q. What does sequentialSigning control?

sequentialSigning determines the order in which signing invitations are sent.

• true: Signers are invited one at a time. The next person is notified only after the previous one has signed. Every userInfo entry needs a unique order, and one must be 1.

• false: All signers receive invitations at the same time and can sign in any order.

Q. Who are the userInfo?

userInfo (required) is an array of participant objects who need to sign the document. At least one must be a Signer. Each object includes:

• name (required): Full legal name of the signer as it should appear in the logs.

• userReferenceId (required): Your own ID for the signer. Letters, numbers, hyphen (-) and underscore (_), 1 to 64 characters.

• emailId: The email address where the signing invitation link will be sent. Required unless mobileNo is sent.

• mobileNo: 10-digit mobile number, digits only. Required unless emailId is sent. If both are sent, the link goes by email and SMS.

• userType (required): Signer or Reviewer (case-sensitive).

• signatureType: Required for a Signer. Values: Aadhaar (OTP/Biometric), Electronic (Email OTP), Digital (Hardware USB token). Case-sensitive.

• expiryDate: Optional. Last date to sign, in MM-DD-YYYY format, in the future.

• order: Required when sequentialSigning is true or a Reviewer is included. Sequence position (1, 2, 3...), unique across the request.

Q. What are electronicOptions?

electronicOptions allows you to enable or disable specific features for the signer during their session:

• canDraw: Allow the signer to draw their signature on the screen.

• canType: Allow the signer to type their name as a stylized signature.

• canUpload: Allow the signer to upload an image of their physical signature.

• captureGPSLocation: Captures the signer's geographic coordinates at the time of signing for the audit trail.

• capturePhoto: Take a live photo of the signer during the session for identity verification.

Q. What is aadhaarInfo and how is it used for verification?

aadhaarInfo is used for pre-verification of the signer against their Aadhaar record before they are allowed to sign:

• verifyInvitee: Set to true to ensure the person signing matches the invited person's details.

• birthYear: Matches the signer's birth year (4 digits, 1900-2099).

• lastFourDigitOfAadhaar: Matches the last 4 digits of their Aadhaar card (4 digits).

• gender: M (Male), F (Female) or T (Transgender).

• verifyName: Set to true if exact name matching against Aadhaar is required.

• smartNameVerify: Enable fuzzy matching to allow minor spelling differences in names.

Q. When should I use aadhaarOptions?

aadhaarOptions configures which Aadhaar authentication methods are allowed for the signer:

• otp: Enable Aadhaar OTP-based signing (Default: true).

• biometricThumbScan: Enable fingerprint/biometric authentication.

• irisScan: Enable eye/iris scan authentication.

• face: Enable face-based authentication.

Q. How do I control where each person signs on the document?

Positioning is handled per signer using:

• signAppearance: Position signature box in a corner. Values: 1 (Top_Left), 2 (Top_Right), 3 (Bottom_Left), 4 (Bottom_Right), 5 (PageCoordinates). Defaults to 3 (Bottom_Left). Value 5 requires pageCoordinates.

• pageToBeSigned: Which pages to sign. Values: 1 (FIRST), 2 (LAST), 3 (EVEN), 4 (ODD), 5 (ALL), 6 (SPECIFY). Defaults to 5 (ALL).

• pageNumber: Required if pageToBeSigned is 6 (SPECIFY). Use hyphen-separated numbers (e.g., "1-2-5").

• pageCoordinates: Manual override for exact (X, Y) coordinates on specific pages. Use pageNumber: 0 in an entry to apply the same coordinates to every page selected by pageToBeSigned (all pages when pageToBeSigned is 5/ALL); entries with a real page number override the 0 entry for that page.

Q. What is signatorySealInfo?

signatorySealInfo adds a company seal/text around the signature box.

• name: Name of the organization (e.g., "ABC Pvt Ltd"). Printed as "For, ABC Pvt Ltd".

• sealType: Label below signature. Values: 1 (Authorised Signatory), 2 (Director), 3 (Company Seal).

Q. When is an eSign request charged?

Creating the request is not charged, so this response shows isBillable: false. Each signer is charged when they complete signing.

Q. What are the workflow settings like responseUrl and uiMode?

• descriptionForInvitee: Custom text instructions displayed in the invitation email.

• finalCopyRecipientsEmailId: Comma-separated email IDs to receive the final signed PDF automatically.

• responseUrl: Your server webhook URL for real-time status notifications. If omitted, the default webhook URL configured for this API on your account is used.

• returnUrl: Optional absolute https URL the signer's browser is redirected to after they sign. Other values are ignored.

• skipVerificationCode: Set to true to bypass the unique document password (OTP) for the signer upon opening the link.

• emailTemplateCode: Optional. 1 (Offer Letter) or 2 (Employee Docs); omit or 0 for the default template.

• isAttachRequestSignDocument: If true, the PDF document is attached directly to the invitation email.

• senderName: Custom 'From' name appearing in the signer's email.

• uiMode: Set to true for "Draft Mode" where document is kept in draft so you can manually position signature boxes via UI before sending.

Call this after the borrower's Aadhaar eSign (and your own eNACH flow, which SignCare does not track) are complete.

Q. What is Items?

Required. An array of 1 to 100 { referenceId, documentId } pairs — one entry per document you want the lender's DSC signer completed on. A failure on one item (e.g. the borrower hasn't finished signing yet) never blocks the others; check each entry's status in the response independently.

Q. What certificate does this use?

Your organization's signing certificate, onboarded separately via the SignCare admin portal — never a value you pass in this request.

Use this API to track whether signers have opened, signed, or rejected a document.

Q. What is documentReferenceId?

Required. The referenceId you provided when initiating the signing request (the one you sent in /request). Matching is not case-sensitive.

Q. What is documentId?

Required. The unique document identifier (GUID) returned in the response of the /request API. Both fields must be sent and must belong to the same document.

Use this API to cancel a signing workflow before it is fully completed by all parties.

Q. What is documentId?

Required. The unique identifier (GUID) of the document you wish to revoke. This is the only request field.

Q. When can I revoke?

Only while the document is pending and no signer has signed yet.

This is useful when you need to fix errors in a previous request (e.g., correcting an email address) while reusing the existing document context.

Q. How does this differ from /request?

re-initiate allows you to provide a new PDF (inside documentInfo) or update the list of participants (signers) for an existing transaction.

Q. Which documents can I re-initiate?

Only documents in Revoked status. Revoke the document first, then send documentInfo.documentId (GUID), documentInfo.name and documentInfo.content (all required), plus a full userInfo list where every participant has an emailId.

Use this if a signer's link has expired or they need more time to complete the process.

Q. What is documentId?

Required. The unique identifier (GUID) of the document. The document must be pending or expired.

Q. What is days?

Required. Whole number of days, greater than 0. The new deadline is that many days from now, and applies to every signer on the document.

Use this when a document was sent for sequential signing and waiting on the order has become the bottleneck — the signers still outstanding are released together and invited immediately.

Q. Who gets an invitation?

Every signer still pending. Anyone who has already signed is skipped, so nobody is asked twice.

Q. What if the document has reviewers?

Reviewers keep their order. The switch is applied straight away, but the signers are released together the moment the last reviewer approves — the review-then-sign flow is preserved.

Q. Can I switch back to sequential?

No. Invitations already delivered cannot be recalled, so this endpoint is one-way. Set sequentialSigning when you create the request if you need a signing order.

Q. Does it affect the other documents in the envelope?

Yes. Every document sharing the envelope is switched, because they share one signer list.

Use this when a signer cannot sign the way the request asked (for example, no Aadhaar-linked mobile, or no DSC token), when the wrong person or contact was invited, or to adjust how they sign — after others may already have signed. The document does not need to be revoked and sent again: signatures already done, the signer's position and the signing order stay as they are. Change any combination in one call; send only what changes.

Q. How do I change the person?

Send emailId and/or mobileNo with the new person's full contact, and their

name. The previous person's links stop working immediately, and the new person is invited. userRefId stays the same; the response returns the new person's userId and

esignLink. Sending the same email with a different mobile (or adding/removing the mobile) only changes where SMS links go. A reviewer's name and contact can be changed the same way.

Q. How do I identify the signer?

Send userRefId: the userReferenceId you gave that signer when creating the request, as returned in the create response. It never changes, even when the person changes. Use a different userReferenceId for every signer on a document, or the signer cannot be identified.

Q. Which changes are allowed?

Any type to any type: signatureType is "Electronic", "Aadhaar" or "Digital". Send the signer's current type to update only its options: electronicOptions for Electronic, aadhaarOptions / aadhaarInfo for Aadhaar (Digital has none). Options you leave out keep their current values, or the defaults when the type changes. The signer must not have signed or rejected yet, and the document must be pending. reason (1 to 250 characters) is required and is recorded in the audit trail.

Q. Is the signer notified?

When it is already their turn, the invitation is sent by email and/or SMS. By default this happens when the person, the mobile or the type changes, and not for a name or options update; set notifySigner to override. On a sequential document where the signer's turn has not come yet, nothing is sent now and they are invited normally when it does. The existing signing link keeps working and opens the new signing page.

Q. What if the signer has the signing page open?

The call is rejected with 409 and the time after which to retry, so a signing already in progress is not interrupted.

Q. How is it billed?

The call itself is free. The signer is charged at the price of the type they finally sign with. When the type changes, the wallet is checked for the new type's price.

Q. Does it affect the other documents in the envelope?

Yes. The same signer is changed on every document in the envelope.

Use this if a signer has lost their email or needs a reminder to sign.

Q. Does this create a new link?

No, it resends the same active link to the signer's email or registered mobile number.

Q. What is documentId?

Required. The unique identifier (GUID) of the document. The document must be pending.

The audit trail provides a legally valid, step-by-step history of all document-related activities including opening, OTP generation, and final signing.

Q. What is DocumentId?

Required (path parameter). The unique document identifier (GUID) for which you want to download the trail.