> **Source:** https://knowledge.leegality.com/document-execution/api/check-document-details > **Site:** Leegality Knowledge Base — https://knowledge.leegality.com > **About:** Leegality is a document execution platform covering eSigning, stamps, NeSL, workflows, and REST API integration. > **Navigation:** Every article on this site has a plain-text version at `.txt` (this format). To get an index of all articles with their `.txt` links, read: https://knowledge.leegality.com/llms.txt > **AI Guide:** For instructions on how to navigate this knowledge base as an AI agent, read: https://knowledge.leegality.com/ai-readable.txt --- # GET /v3.3/document/details — Check document details Returns in-depth details about a document. **Authentication:** `X-Auth-Token` header required on every request. ## Request URL ``` GET https://app1.leegality.com/api/v3.3/document/details?documentId={documentId}&file={file}&auditTrail={auditTrail}&document_scheduledDeletionDate={document_scheduledDeletionDate}&document_customMessage={document_customMessage}&document_deleteOnComplete={document_deleteOnComplete}&document_requestSigningOrder={document_requestSigningOrder}&document_requireSigningOrder={document_requireSigningOrder}&sftp={sftp}&workflow={workflow}&workflow_name={workflow_name}&workflow_type={workflow_type}&workflow_subType={workflow_subType}&template={template}&template_name={template_name}&account={account}&account_name={account_name}&account_label={account_label}&account_brandName={account_brandName}&sender={sender}&sender_name={sender_name}&folder={folder}&folder_name={folder_name}&stampDetails={stampDetails}&stampDetails_groupName={stampDetails_groupName}&stampDetails_groupNumber={stampDetails_groupNumber}&stampDetails_maximumValuePermitted={stampDetails_maximumValuePermitted}&stampDetails_stamps={stampDetails_stamps}&stampDetails_stamps_associatedDocumentId={stampDetails_stamps_associatedDocumentId}&stampDetails_stamps_multipleStampSeries={stampDetails_stamps_multipleStampSeries}&referenceAttachments={referenceAttachments}&neslDocumentDetails={neslDocumentDetails}&neslDocumentDetails_responseCode={neslDocumentDetails_responseCode}&neslDocumentDetails_responseMessage={neslDocumentDetails_responseMessage}&neslDocumentDetails_isRetryAllowed={neslDocumentDetails_isRetryAllowed}&neslDocumentDetails_loanDetails_event={neslDocumentDetails_loanDetails_event}&neslDocumentDetails_loanDetails_expiryDate={neslDocumentDetails_loanDetails_expiryDate}&neslDocumentDetails_loanDetails_claimExpiryDate={neslDocumentDetails_loanDetails_claimExpiryDate}&neslDocumentDetails_loanDetails_currencyOfDebt={neslDocumentDetails_loanDetails_currencyOfDebt}&neslDocumentDetails_loanDetails_docRefNo={neslDocumentDetails_loanDetails_docRefNo}&neslDocumentDetails_loanDetails_contractRefNo={neslDocumentDetails_loanDetails_contractRefNo}&neslDocumentDetails_loanDetails_vendorCode={neslDocumentDetails_loanDetails_vendorCode}&neslDocumentDetails_loanDetails_portalID={neslDocumentDetails_loanDetails_portalID}&neslDocumentDetails_securityDetails={neslDocumentDetails_securityDetails}&neslDocumentDetails_partyDetails={neslDocumentDetails_partyDetails}&neslDocumentDetails_stampDetails={neslDocumentDetails_stampDetails}&neslDocumentDetails_neslEstampStatusDetails={neslDocumentDetails_neslEstampStatusDetails}&refreshNeslDocument={refreshNeslDocument}&cc={cc}&coordinatePicker={coordinatePicker}&invitations_inviteeConfigs={invitations_inviteeConfigs}&invitations_inviteeConfigs_retry={invitations_inviteeConfigs_retry}&invitations_inviteeConfigs_fixedName={invitations_inviteeConfigs_fixedName}&invitations_inviteeConfigs_noName={invitations_inviteeConfigs_noName}&invitations_inviteeConfigs_supportingDocument={invitations_inviteeConfigs_supportingDocument}&invitations_inviteeConfigs_viewSupportingDocument={invitations_inviteeConfigs_viewSupportingDocument}&invitations_inviteeConfigs_organizationConfig={invitations_inviteeConfigs_organizationConfig}&invitations_inviteeConfigs_security={invitations_inviteeConfigs_security}&invitations_inviteeConfigs_security_gpsConfig={invitations_inviteeConfigs_security_gpsConfig}&invitations_inviteeConfigs_security_faceMatch={invitations_inviteeConfigs_security_faceMatch}&invitations_inviteeConfigs_security_smartUserLiveliness={invitations_inviteeConfigs_security_smartUserLiveliness}&invitations_inviteeConfigs_eSignPriorityConfig={invitations_inviteeConfigs_eSignPriorityConfig}&invitations_inviteeConfigs_eSignPriorityConfig_orderLevelRetryCount={invitations_inviteeConfigs_eSignPriorityConfig_orderLevelRetryCount}&invitations_inviteeConfigs_customURL={invitations_inviteeConfigs_customURL}&invitations_inviteeConfigs_customConsent={invitations_inviteeConfigs_customConsent}&invitations_inviteeConfigs_enableRejectDocument={invitations_inviteeConfigs_enableRejectDocument}&invitations_inviteeConfigs_enableRejectMessage={invitations_inviteeConfigs_enableRejectMessage}&invitations_inviteeConfigs_languageDetails={invitations_inviteeConfigs_languageDetails}&invitations_inviteeConfigs_paymentDetails={invitations_inviteeConfigs_paymentDetails}&invitations_inviteeConfigs_maskContactDetails={invitations_inviteeConfigs_maskContactDetails}&invitations_recordReviewerDetails={invitations_recordReviewerDetails}&invitations_inviteeGroup={invitations_inviteeGroup}&invitations_inviteeGroup_name={invitations_inviteeGroup_name}&invitations_inviteeGroup_completionThreshold={invitations_inviteeGroup_completionThreshold}&invitations_inviteeGroup_size={invitations_inviteeGroup_size}&invitations_inviteeGroup_completed={invitations_inviteeGroup_completed}&invitations_signatureOptions={invitations_signatureOptions}&invitations_signatureOptions_quickSign={invitations_signatureOptions_quickSign}&invitations_signatureOptions_visualSign={invitations_signatureOptions_visualSign}&invitations_signatureOptionsUsed={invitations_signatureOptionsUsed}&invitations_neslInvitationDetails={invitations_neslInvitationDetails}&invitations_neslInvitationDetails_participantDetails={invitations_neslInvitationDetails_participantDetails}&invitations_neslInvitationDetails_participantDetails_isIndividual={invitations_neslInvitationDetails_participantDetails_isIndividual}&invitations_neslInvitationDetails_participantDetails_signatoryGender={invitations_neslInvitationDetails_participantDetails_signatoryGender}&invitations_neslInvitationDetails_participantDetails_businessUnit={invitations_neslInvitationDetails_participantDetails_businessUnit}&invitations_invitationStatus_failureReason={invitations_invitationStatus_failureReason}&invitations_invitationStatus_rejectionMessage={invitations_invitationStatus_rejectionMessage}&invitations_invitationStatus_signRejectionMessage={invitations_invitationStatus_signRejectionMessage}&invitations_certificateData={invitations_certificateData}&invitations_certificateData_photoHash={invitations_certificateData_photoHash}&invitations_certificateData_uid={invitations_certificateData_uid}&invitations_certificateData_serialNumber={invitations_certificateData_serialNumber}&invitations_verificationRequest={invitations_verificationRequest}&invitations_verificationResponse={invitations_verificationResponse}&invitations_verificationResponse_smartNameAI={invitations_verificationResponse_smartNameAI}&invitations_verificationResponse_faceMatch={invitations_verificationResponse_faceMatch}&invitations_verificationResponse_smartUserLiveliness={invitations_verificationResponse_smartUserLiveliness}&invitations_verificationResponse_neslVerficationResponse={invitations_verificationResponse_neslVerficationResponse}&invitations_supportingDocuments={invitations_supportingDocuments}&invitations_requiresApproverOtp={invitations_requiresApproverOtp}&invitations_signatureSubOptionUsed={invitations_signatureSubOptionUsed} ``` **Environments:** - Production: `https://app1.leegality.com/api/v3.3/document/details` - Sandbox: `https://sandbox.leegality.com/api/v3.3/document/details` --- ## Parameters | Name | In | Required | Type | Description | Example | |------|----|----------|------|-------------|---------| | `documentId` | query | Yes | string | Unique document ID generated by Leegality. Get from the Create eSigning Request API response or from the dashboard. - **Format:** Alphanumeric string | — | | `file` | query | No | boolean | Pass `true` to receive the signed PDF file as a CDN URL in the response. - **Validity:** CDN URL expires in **15 seconds** — download immediately at server level, not for browser preview. | — | | `auditTrail` | query | No | boolean | Pass `true` to receive the Audit Trail PDF as a CDN URL in the response. Only applicable to completed documents (all signatories have signed). - **Validity:** CDN URL expires in **15 seconds** — download immediately at server level, not for browser preview. - Audit trail for a deleted document can also be fetched. | — | | `document_scheduledDeletionDate` | query | No | boolean | Pass `true` to receive the scheduled document deletion date and time. Applicable when the "Auto delete on complete" is enabled in the **[Department > Document Security](https://knowledge.leegality.com/document-execution/settings/Department/document-security-settings)** setting or while sending the document. | — | | `document_customMessage` | query | No | boolean | Pass `true` to receive the custom message configured on the invitation email. | — | | `document_deleteOnComplete` | query | No | boolean | Pass `true` to receive whether auto-delete on complete was enabled for the document. | — | | `document_requestSigningOrder` | query | No | boolean | Pass `true` to receive whether signing links are activated sequentially. | — | | `document_requireSigningOrder` | query | No | boolean | Pass `true` to receive whether signing order was required for the document. | — | | `sftp` | query | No | boolean | Pass `true` to receive whether SFTP was enabled for the document, and the SFTP server ID configured to receive the completed document and audit trail. | — | | `workflow` | query | No | boolean | Pass `true` to receive workflow ID associated with the document. | — | | `workflow_name` | query | No | boolean | Pass `true` to receive the workflow name. > **Note:** Requires `workflow=true`. | — | | `workflow_type` | query | No | boolean | Pass `true` to receive the workflow type (PDF or Template). > **Note:** Requires `workflow=true`. | — | | `workflow_subType` | query | No | boolean | Pass `true` to receive the workflow sub-type (Single PDF/template or Multiple PDF enabled). > **Note:** Requires `workflow=true`. | — | | `template` | query | No | boolean | Pass `true` to receive template ID associated with the document. | — | | `template_name` | query | No | boolean | Pass `true` to receive the template name used for the document. > **Note:** Requires `template=true`. | — | | `account` | query | No | boolean | Pass `true` to receive account ID associated with the document. | — | | `account_name` | query | No | boolean | Pass `true` to receive the organisation's name. > **Note:** Requires `account=true`. | — | | `account_label` | query | No | boolean | Pass `true` to receive the department name configured in **Settings > Admin > Department**. > **Note:** Requires `account=true`. | — | | `account_brandName` | query | No | boolean | Pass `true` to receive the brand name configured in **Settings > Department > Branding**. > **Note:** Requires `account=true`. | — | | `sender` | query | No | boolean | Pass `true` to receive sender's email address associated with the document. | — | | `sender_name` | query | No | boolean | Pass `true` to receive the sender's name. > **Note:** Requires `sender=true`. | — | | `folder` | query | No | boolean | Pass `true` to receive folder ID associated with the document. | — | | `folder_name` | query | No | boolean | Pass `true` to receive the folder name(s) for the document. > **Note:** Requires `folder=true`. | — | | `stampDetails` | query | No | boolean | Pass `true` to receive stamp paper state and value attached to the document. | — | | `stampDetails_groupName` | query | No | boolean | Pass `true` to receive the group name for the stamp papers attached. Stamp groups are a collection of stamp series for a single state. > **Note:** Requires `stampDetails=true`. | — | | `stampDetails_groupNumber` | query | No | boolean | Pass `true` to receive the group number for the stamp papers attached. > **Note:** Requires `stampDetails=true`. | — | | `stampDetails_maximumValuePermitted` | query | No | boolean | Pass `true` to receive the maximum permitted stamp value configured in the stamp group. Any stamp value above this limit passed in the Create API will be rejected. > **Note:** Requires `stampDetails=true`. | — | | `stampDetails_stamps` | query | No | boolean | Pass `true` to receive an array containing stamp paper details - stamp series number, stamp amount and stamp serial number - for each stamp associated with the document. > **Note:** Requires `stampDetails=true`. | — | | `stampDetails_stamps_associatedDocumentId` | query | No | boolean | Pass `true` to receive the associated document ID physically printed on the stamp paper. > **Note:** Requires `stampDetails_stamps=true`. | — | | `stampDetails_stamps_multipleStampSeries` | query | No | boolean | Pass `true` to receive whether Multiple Stamp Series was used. > **Note:** Requires `stampDetails_stamps=true`. | — | | `referenceAttachments` | query | No | boolean | Pass `true` to receive the array containing reference attachments details - file, name, and type - for each reference attachment sent with the document. These are files uploaded by the document owner while sending the document. | — | | `neslDocumentDetails` | query | No | boolean | Pass `true` to include NeSL transaction details in the response. Only relevant when the document has a NeSL-type signer. | — | | `neslDocumentDetails_responseCode` | query | No | boolean | Pass `true` to receive the response code sent by NeSL. > **Note:** Requires `neslDocumentDetails=true`. | — | | `neslDocumentDetails_responseMessage` | query | No | boolean | Pass `true` to receive the response message associated with the NeSL response code. > **Note:** Requires `neslDocumentDetails=true`. | — | | `neslDocumentDetails_isRetryAllowed` | query | No | boolean | Pass `true` to receive whether retrying is allowed for this NeSL document. Retry is only allowed when the NeSL invitation has failed due to errors other than validation errors. > **Note:** Requires `neslDocumentDetails=true`. | — | | `neslDocumentDetails_loanDetails_event` | query | No | boolean | Pass `true` to receive the selected eBG event for this request. > **Note:** Requires `neslDocumentDetails=true` and `neslDocumentDetails_loanDetails=true`. | — | | `neslDocumentDetails_loanDetails_expiryDate` | query | No | boolean | Pass `true` to receive the specified expiry date of the eBG for this request. > **Note:** Requires `neslDocumentDetails=true` and `neslDocumentDetails_loanDetails=true`. | — | | `neslDocumentDetails_loanDetails_claimExpiryDate` | query | No | boolean | Pass `true` to receive the specified claim expiry date of the eBG for this request. > **Note:** Requires `neslDocumentDetails=true` and `neslDocumentDetails_loanDetails=true`. | — | | `neslDocumentDetails_loanDetails_currencyOfDebt` | query | No | boolean | Pass `true` to receive the specified currency of debt for this request. > **Note:** Requires `neslDocumentDetails=true` and `neslDocumentDetails_loanDetails=true`. | — | | `neslDocumentDetails_loanDetails_docRefNo` | query | No | boolean | Pass `true` to receive the document reference number for this request. > **Note:** Requires `neslDocumentDetails=true` and `neslDocumentDetails_loanDetails=true`. | — | | `neslDocumentDetails_loanDetails_contractRefNo` | query | No | boolean | Pass `true` to receive the contract reference number for this request. > **Note:** Requires `neslDocumentDetails=true` and `neslDocumentDetails_loanDetails=true`. | — | | `neslDocumentDetails_loanDetails_vendorCode` | query | No | boolean | Pass `true` to receive the Vendor Code for this request. > **Note:** Requires `neslDocumentDetails=true` and `neslDocumentDetails_loanDetails=true`. | — | | `neslDocumentDetails_loanDetails_portalID` | query | No | boolean | Pass `true` to receive the Portal ID for this request. > **Note:** Requires `neslDocumentDetails=true` and `neslDocumentDetails_loanDetails=true`. | — | | `neslDocumentDetails_securityDetails` | query | No | boolean | Pass `true` to receive NeSL security details for the document. > **Note:** Requires `neslDocumentDetails=true`. | — | | `neslDocumentDetails_partyDetails` | query | No | boolean | Pass `true` to receive NeSL party details for the document. > **Note:** Requires `neslDocumentDetails=true`. | — | | `neslDocumentDetails_stampDetails` | query | No | boolean | Pass `true` to receive NeSL stamp details for the document. > **Note:** Requires `neslDocumentDetails=true`. | — | | `neslDocumentDetails_neslEstampStatusDetails` | query | No | boolean | Pass this parameter as `TRUE` to receive the NeSL stamp status and certificate details. **Note:** "neslDocumentDetails" parameter also needs to be passed as true to receive this in response. | — | | `refreshNeslDocument` | query | No | boolean | Pass `true` to get the latest status, certificate details, and document from NeSL in the response. **Note:** If the document is stamped but not yet signed, NeSL might not provide the stamped file by default. In such cases, clients may need to enable this setting with NeSL for retrieval of the stamped document. | — | | `cc` | query | No | boolean | Pass `true` to receive an array containing details - name, email, notification types, and more configured for a CC invitees in the document. | — | | `coordinatePicker` | query | No | boolean | Pass `true` to receive the coordinate picker URL and webhook configured in this document. | — | | `invitations_inviteeConfigs` | query | No | boolean | Pass `true` to receive invitee-level configurations associated with each invitation. | — | | `invitations_inviteeConfigs_retry` | query | No | boolean | Pass `true` to receive the number of retry attempts configured for the signer. Only applicable to Aadhaar eSign. > **Note:** Requires `invitations_inviteeConfigs=true`. | — | | `invitations_inviteeConfigs_fixedName` | query | No | boolean | Pass `true` to receive whether the invitee is allowed to edit their name during the signing journey. > **Note:** Requires `invitations_inviteeConfigs=true`. | — | | `invitations_inviteeConfigs_noName` | query | No | boolean | Pass `true` to receive whether the invitee name will appear in the signature appearance. > **Note:** Requires `invitations_inviteeConfigs=true`. | — | | `invitations_inviteeConfigs_supportingDocument` | query | No | boolean | Pass `true` to receive the supporting document requirement configured for the invitee. > **Note:** Requires `invitations_inviteeConfigs=true`. | — | | `invitations_inviteeConfigs_viewSupportingDocument` | query | No | boolean | Pass `true` to receive the view supporting document configuration for the invitee. > **Note:** Requires `invitations_inviteeConfigs=true`. | — | | `invitations_inviteeConfigs_organizationConfig` | query | No | boolean | Pass `true` to receive the organization seal settings configured for this invitation. The organization name appears in the signature box, and the chosen seal forms a digital rubber stamp around it. > **Note:** Requires `invitations_inviteeConfigs=true`. | — | | `invitations_inviteeConfigs_security` | query | No | boolean | Pass `true` to receive the status of all security modules configured for each invitee. > **Note:** Requires `invitations_inviteeConfigs=true`. | — | | `invitations_inviteeConfigs_security_gpsConfig` | query | No | boolean | Pass `true` to receive the GPS configuration for the invitee. > **Note:** Requires `invitations_inviteeConfigs=true` and `invitations_inviteeConfigs_security=true`. | — | | `invitations_inviteeConfigs_security_faceMatch` | query | No | boolean | Pass `true` to receive the Face Match security module configuration for the invitee. > **Note:** Requires `invitations_inviteeConfigs=true` and `invitations_inviteeConfigs_security=true`. | — | | `invitations_inviteeConfigs_security_smartUserLiveliness` | query | No | boolean | Pass `true` to receive the Smart User Liveliness configuration for the invitee. This only reflects the configuration at the time the invitation was created or edited, and does not capture any admin-level changes. > **Note:** Requires `invitations_inviteeConfigs=true` and `invitations_inviteeConfigs_security=true`. | — | | `invitations_inviteeConfigs_eSignPriorityConfig` | query | No | boolean | Pass `true` to receive the eSign priority configuration for the invitee. > **Note:** Requires `invitations_inviteeConfigs=true`. | — | | `invitations_inviteeConfigs_eSignPriorityConfig_orderLevelRetryCount` | query | No | boolean | Pass `true` to receive the order-level retry count configured for the invitee. > **Note:** Requires `invitations_inviteeConfigs=true` and `invitations_inviteeConfigs_eSignPriorityConfig=true`. | — | | `invitations_inviteeConfigs_customURL` | query | No | boolean | Pass `true` to receive the custom URL configuration for each invitee. > **Note:** Requires `invitations_inviteeConfigs=true`. | — | | `invitations_inviteeConfigs_customConsent` | query | No | boolean | Pass `true` to receive the custom consent content configured for the invitee. Custom consent is an additional configurable consent the signer must accept before proceeding to sign. > **Note:** Requires `invitations_inviteeConfigs=true`. | — | | `invitations_inviteeConfigs_enableRejectDocument` | query | No | boolean | Pass `true` to receive whether the signer is allowed to reject the invitation during the signing journey. > **Note:** Requires `invitations_inviteeConfigs=true`. | — | | `invitations_inviteeConfigs_enableRejectMessage` | query | No | boolean | Pass `true` to receive whether the signer is required to provide a message when rejecting the invitation. > **Note:** Requires `invitations_inviteeConfigs=true`. | — | | `invitations_inviteeConfigs_languageDetails` | query | No | boolean | Pass `true` to receive the language configuration details for the signer. > **Note:** Requires `invitations_inviteeConfigs=true`. | — | | `invitations_inviteeConfigs_paymentDetails` | query | No | boolean | Pass `true` to receive the payment collection details configured for the invitee. > **Note:** Requires `invitations_inviteeConfigs=true`. | — | | `invitations_inviteeConfigs_maskContactDetails` | query | No | boolean | Pass `true` to receive whether Contact Details Masking is enabled for the invitee. > **Note:** Requires `invitations_inviteeConfigs=true`. | — | | `invitations_recordReviewerDetails` | query | No | boolean | Pass `true` to receive whether "Record reviewer details" is activated for each invitee in the audit trail. **Note:** This parameter works independently — no parent parameter is required. | — | | `invitations_inviteeGroup` | query | No | boolean | Pass `true` to receive invitee group details. An invitee group is a single invite consisting of multiple signers where a configurable subset (e.g. 2 out of 5) must sign for the invite to be considered complete. | — | | `invitations_inviteeGroup_name` | query | No | boolean | Pass `true` to receive the invitee group name. > **Note:** Requires `invitations_inviteeGroup=true`. | — | | `invitations_inviteeGroup_completionThreshold` | query | No | boolean | Pass `true` to receive the group completion threshold — the number of signatures required in the group invite for it to be considered complete. > **Note:** Requires `invitations_inviteeGroup=true`. | — | | `invitations_inviteeGroup_size` | query | No | boolean | Pass `true` to receive the total number of invitees in the group invite. > **Note:** Requires `invitations_inviteeGroup=true`. | — | | `invitations_inviteeGroup_completed` | query | No | boolean | Pass `true` to receive whether the group signing has been completed. > **Note:** Requires `invitations_inviteeGroup=true`. | — | | `invitations_signatureOptions` | query | No | boolean | Pass `true` to receive the signature options allowed for each invitee. | — | | `invitations_signatureOptions_quickSign` | query | No | boolean | Pass `true` to receive the signature options allowed for Quick Sign. > **Note:** Requires `invitations_signatureOptions=true`. | — | | `invitations_signatureOptions_visualSign` | query | No | boolean | Pass `true` to receive the signature options allowed for Visual Sign. > **Note:** Requires `invitations_signatureOptions=true`. | — | | `invitations_signatureOptionsUsed` | query | No | boolean | Pass `true` to receive the specific signature sub-type used by the invitee during signing. | — | | `invitations_neslInvitationDetails` | query | No | boolean | Pass `true` to receive NeSL invitation details for each invitee. | — | | `invitations_neslInvitationDetails_participantDetails` | query | No | boolean | Pass `true` to receive the participant details of the NeSL invitation. > **Note:** Requires `invitations_neslInvitationDetails=true`. | — | | `invitations_neslInvitationDetails_participantDetails_isIndividual` | query | No | boolean | Pass `true` to receive whether the NeSL participant is an individual. > **Note:** Requires `invitations_neslInvitationDetails_participantDetails=true`. | — | | `invitations_neslInvitationDetails_participantDetails_signatoryGender` | query | No | boolean | Pass `true` to receive the NeSL signatory's gender. > **Note:** Requires `invitations_neslInvitationDetails_participantDetails=true`. | — | | `invitations_neslInvitationDetails_participantDetails_businessUnit` | query | No | boolean | Pass `true` to receive the NeSL participant's business unit. > **Note:** Requires `invitations_neslInvitationDetails_participantDetails=true`. | — | | `invitations_invitationStatus_failureReason` | query | No | boolean | Pass `true` to receive the failure or status reason for the invitation. | — | | `invitations_invitationStatus_rejectionMessage` | query | No | boolean | Pass `true` to receive the reason provided by the approver for rejecting the invitation. | — | | `invitations_invitationStatus_signRejectionMessage` | query | No | boolean | Pass `true` to receive the reason provided by the signer for rejecting the invitation. | — | | `invitations_certificateData` | query | No | boolean | Pass `true` to receive the signing certificate data (excluding photoHash, uid, and serialNumber, which require their own sub-parameters). | — | | `invitations_certificateData_photoHash` | query | No | boolean | Pass `true` to receive the photoHash from the signing certificate. > **Note:** Requires `invitations_certificateData=true`. | — | | `invitations_certificateData_uid` | query | No | boolean | Pass `true` to receive the UID from the signing certificate. > **Note:** Requires `invitations_certificateData=true`. | — | | `invitations_certificateData_serialNumber` | query | No | boolean | Pass `true` to receive the serial number from the signing certificate. > **Note:** Requires `invitations_certificateData=true`. | — | | `invitations_verificationRequest` | query | No | boolean | Pass `true` to receive the verification configuration for each invitee — which certificate parameters have been activated for verification. Only applicable to Aadhaar eSign, Offline Sign (Cloud DSC), DSC, and NeSL. | — | | `invitations_verificationResponse` | query | No | boolean | Pass `true` to receive the results of certificate verification — the actual match outcomes of the configured input values against the signer's certificate data. | — | | `invitations_verificationResponse_smartNameAI` | query | No | boolean | Pass `true` to receive whether Smart Name AI was enabled during verification. > **Note:** Requires `invitations_verificationResponse=true`. | — | | `invitations_verificationResponse_faceMatch` | query | No | boolean | Pass `true` to receive the Face Match verification results for the invitee. > **Note:** Requires `invitations_verificationResponse=true`. | — | | `invitations_verificationResponse_smartUserLiveliness` | query | No | boolean | Pass `true` to receive Smart User Liveliness verification results. > **Note:** Requires `invitations_verificationResponse=true`. | — | | `invitations_verificationResponse_neslVerficationResponse` | query | No | boolean | Pass `true` to receive the NeSL invitee's verification results (Name, Gender, and Year of Birth). > **Note:** Requires `invitations_verificationResponse=true`. | — | | `invitations_supportingDocuments` | query | No | boolean | Pass `true` to receive the supporting documents requested from the signer. | — | | `invitations_requiresApproverOtp` | query | No | boolean | Pass `true` to receive whether the non-OTP approver flow is activated for the invitee. | — | | `invitations_signatureSubOptionUsed` | query | No | boolean | Pass `true` to receive the Signature subtype used by the invitee to sign the document. | — | --- ## Responses ### 200 — Response Data | Field | Type | Required | Description | Example | |-------|------|----------|-------------|---------| | `status` | integer | No | - `1` — success - `0` — failure | — | | `messages` | array\ | No | See **Message** below. | — | | `data` | object | No | See **data** below. | — | #### Message Message object containing a machine-readable code and a human-readable description. Used for success confirmations, errors, and warnings. | Field | Type | Required | Description | Example | |-------|------|----------|-------------|---------| | `code` | string | No | Response message code. | `simpleWorkFlow.success` | | `message` | string | No | Human-readable success or error message. | `Invitations sent successfully.` | #### data | Field | Type | Required | Description | Example | |-------|------|----------|-------------|---------| | `file` | string | No | CDN URL of the signed document PDF. Valid for only **15 seconds** — intended for server-level download only. Returns `null` if the `file` parameter is not `true` in the API call. **Download method:** `curl -output ` | — | | `auditTrail` | string | No | CDN URL of the audit trail PDF. Valid for only **15 seconds** — intended for server-level download only. Returns `null` if the document is not completed or if the `auditTrail` parameter is not enabled in the API call. **Download method:** `curl -output ` | — | | `document` | DocumentDetails3_1ResponseObject | No | See **DocumentDetails3_1ResponseObject** below. | — | | `sftp` | SftpDetails3_1ResponseObject | No | See **SftpDetails3_1ResponseObject** below. | — | | `workflow` | WorkflowDetails3_1ResponseObject | No | See **WorkflowDetails3_1ResponseObject** below. | — | | `template` | TemplateDetails3_1ResponseObject | No | See **TemplateDetails3_1ResponseObject** below. | — | | `account` | AccountDetails3_1ResponseObject | No | See **AccountDetails3_1ResponseObject** below. | — | | `sender` | SenderDetails3_1ResponseObject | No | See **SenderDetails3_1ResponseObject** below. | — | | `folders` | array\ | No | Array containing the full hierarchy of folders. The last child folder appears as the first element of the array, with parent folders following. See **FolderArrayResponseObject** below. | — | | `stampDetails` | StampDetails3_1ResponseObject | No | See **StampDetails3_1ResponseObject** below. | — | | `referenceAttachments` | array\ | No | Array of reference attachments uploaded by the sender of the document, visible to invitees during the signing journey. See **AttachmentsArrayResponseObjectWithURL** below. | — | | `neslDocumentDetails` | NeslDetails3_1ResponseObject | No | See **NeslDetails3_1ResponseObject** below. | — | | `cc` | array\ | No | See **CCArrayResponseObject** below. | — | | `coordinatePicker` | CoordinatePickerDetails3_1ResponseObject | No | See **CoordinatePickerDetails3_1ResponseObject** below. | — | | `invitations` | array\ | No | Array containing details of all invitees (signers, reviewers, coordinate pickers) associated with this document. See **InvitationsArray3_1ResponseObject** below. | — | ##### DocumentDetails3_1ResponseObject | Field | Type | Required | Description | Example | |-------|------|----------|-------------|---------| | `id` | string | No | Unique Document ID generated by Leegality for every document. | — | | `name` | string | No | Document name as configured during creation. | — | | `irn` | string | No | Internal Reference Number (IRN) assigned to the document during creation. | — | | `status` | string | No | Current status of the document. - `DRAFT` — Document created but not yet sent for signing - `SENT` — Document sent for signing, signing in progress - `COMPLETED` — All required signers have signed the document | — | | `coordinatePicker` | boolean | No | Indicates whether coordinate picker is enabled for this document. | — | | `deleted` | boolean | No | Indicates whether the document has been deleted. `true` if deleted, `false` otherwise. | — | | `creationDate` | string | No | Document creation date. - **Format:** `DD-MM-YYYY HH:MM:SS` | — | | `completionDate` | string | No | Document completion date — when all signers have completed their signatures. - **Format:** `DD-MM-YYYY HH:MM:SS` | — | | `scheduledDeletionDate` | string | No | Scheduled deletion date for the document. - **Format:** `DD-MM-YYYY HH:MM:SS` Once completed, calculated as `completionDate + retention period` configured in the "Auto Delete on Complete" settings. | — | | `customMessage` | string | No | Custom message configured for the invitation email sent to signers. Returns `null` if no custom message was configured. | — | | `deleteOnComplete` | boolean | No | Indicates whether the document is set for automatic deletion after completion. - `true` — deletion enabled - `false` — deletion not enabled | — | | `requestSigningOrder` | boolean | No | Indicates whether the signature links are activated sequentially. - `true` — sequential signing enabled; next signer receives link only after previous signer has signed - `false` — sequential signing disabled | — | | `requireSigningOrder` | boolean | No | Indicates whether signing order is strictly required. - `true` — signing order required - `false` — signing order not required | — | ##### SftpDetails3_1ResponseObject | Field | Type | Required | Description | Example | |-------|------|----------|-------------|---------| | `sftpEnabled` | boolean | No | Indicates whether SFTP was enabled for this document. - `true` — SFTP was configured - `false` — SFTP was not configured | — | | `profileId` | string | No | SFTP Profile ID of the server where the completed document and audit trail will be sent. Returns `null` if SFTP is not configured. | — | ##### WorkflowDetails3_1ResponseObject | Field | Type | Required | Description | Example | |-------|------|----------|-------------|---------| | `id` | string | No | Unique Workflow ID through which the document was created. | — | | `name` | string | No | Workflow name for the corresponding Workflow ID. | — | | `type` | string | No | Workflow type. - `Pdf` — PDF-based workflow - `Template` - Template-based workflow | — | | `subtype` | string | No | Workflow sub-type. - `Single PDF` — No additional PDFs are appended to the template - `Multiple PDF` — Additional PDFs are appended to the template - `null` — Workflow not used to send this document | — | ##### TemplateDetails3_1ResponseObject | Field | Type | Required | Description | Example | |-------|------|----------|-------------|---------| | `id` | string | No | Unique Template ID. Returns `null` if no template was used. This response may be sent in case of a deleted document, subject to availability. | — | | `name` | string | No | Template name for the corresponding Template ID. | — | ##### AccountDetails3_1ResponseObject | Field | Type | Required | Description | Example | |-------|------|----------|-------------|---------| | `id` | string | No | Unique Account ID generated by Leegality. This response may be sent in case of a deleted document, subject to availability. | — | | `name` | string | No | Organisation name configured. | — | | `label` | string | No | Department name configured in the Leegality dashboard. | — | | `brandName` | string | No | Brand name configured in the Leegality dashboard. | — | ##### SenderDetails3_1ResponseObject | Field | Type | Required | Description | Example | |-------|------|----------|-------------|---------| | `name` | string | No | Name of the user who sent/created the document. | — | | `username` | string | No | Username (email or phone number) of the sender. | — | ##### FolderArrayResponseObject | Field | Type | Required | Description | Example | |-------|------|----------|-------------|---------| | `id` | string | No | Unique Folder ID. Returns `null` if the document is not saved in any folder. | — | | `name` | string | No | Folder name. Returns `null` if the document is not saved in any folder. | — | ##### StampDetails3_1ResponseObject | Field | Type | Required | Description | Example | |-------|------|----------|-------------|---------| | `groupName` | string | No | Name of the stamp group from which the stamp paper was procured. | — | | `groupNumber` | string | No | Number of the stamp group. | — | | `stampValue` | string | No | Total Stamp value (denomination) attached to this document, as a numeric string. | — | | `maximumValuePermitted` | string | No | Maximum stamp value permitted for this stamp group, as a numeric string. | — | | `state` | string | No | Indian state associated with the stamp group (e.g., Delhi, Maharashtra, Karnataka). | — | | `stamps` | array\ | No | See **StampArray3_1ResponseObject** below. | — | | `multipleStampSeriesUsed` | boolean | No | Indicates whether multiple stamp series were used for this document. `true` if multiple series were used, `false` otherwise. | — | ###### StampArray3_1ResponseObject Array of stamps containing details of each stamp attached to the document. | Field | Type | Required | Description | Example | |-------|------|----------|-------------|---------| | `series` | string | No | Stamp series number | `03` | | `amount` | string | No | Denomination/value of the stamp paper attached to the document. - **Format:** Numeric string (e.g., `"53.0"`) | — | | `serialNumber` | string | No | Serial number affixed on the stamp paper by the issuing authority. | — | | `associatedDocumentId` | string | No | Document ID physically printed on the stamp paper. This links the stamp paper to the document. | — | ##### AttachmentsArrayResponseObjectWithURL | Field | Type | Required | Description | Example | |-------|------|----------|-------------|---------| | `file` | string | No | CDN URL for the reference attachment file. Valid for only **15 seconds**. Use this URL for downloading at the server level only, not for previewing in the host application. **Download method:** `curl -output ` | — | | `name` | string | No | Name of the reference attachment file. | — | | `type` | string | No | MIME type of the reference attachment file. **Possible values:** `application/pdf`, `image/png`, `image/jpg`, `image/jpeg` | — | ##### NeslDetails3_1ResponseObject | Field | Type | Required | Description | Example | |-------|------|----------|-------------|---------| | `transactionId` | string | No | Transaction ID received during NESL transaction. | — | | `responseCode` | string | No | Response Code sent by NeSL. | — | | `responseMessage` | string | No | Response message for the code received. | — | | `isRetryAllowed` | string | No | Indicates whether retry is allowed for this NeSL document. - `true` — retry is allowed; call the Retry NeSL API - `false` — retry is not allowed | — | | `loanDetails` | NeslLoanDetails3_1ResponseObject | No | See **NeslLoanDetails3_1ResponseObject** below. | — | | `securityDetails` | array\ | No | See **NeslSecurityDetails3_1ResponseObject** below. | — | | `stampDetails` | NeslStampDetails3_1ResponseObject | No | See **NeslStampDetails3_1ResponseObject** below. | — | | `partyDetails` | NeslPartyDetails3_1ResponseObject | No | See **NeslPartyDetails3_1ResponseObject** below. | — | | `neslEstampStatus` | string | No | - `SUCCESS` — Stamping is completed at NeSL - `PENDING` — Stamping is not yet completed at NeSL | — | | `neslEstampCertificates` | array\ | No | A list of the Stamp ID(s) that have been stamped by NeSL. | — | ###### NeslLoanDetails3_1ResponseObject | Field | Type | Required | Description | Example | |-------|------|----------|-------------|---------| | `loanNumber` | string | No | The loan number associated with the debt. | — | | `sanctionNumber` | string | No | The sanction number associated with the debt. | — | | `registrationType` | string | No | Type of debt (Individual Loan or Non-Individual Loan). | — | | `state` | string | No | The state in which stamp duty is being paid. | — | | `branchName` | string | No | The name of the branch granting the loan. | — | | `branchAddress` | string | No | The address of the branch granting the loan. | — | | `dateOfSanction` | string | No | The date on which the loan was sanctioned as per the lender's CBS. | — | | `emiAmount` | string | No | Interest installment amount payable on the loan. | — | | `rateOfInterest` | string | No | Rate of Interest on the loan. | — | | `sanctionAmount` | string | No | The amount sanctioned by the financial creditor. | — | | `tenure` | string | No | The tenure of the loan. | — | | `typeOfDebt` | string | No | The type of loan (financial debt or operational debt). | — | | `accountClosedFlag` | string | No | Whether the account is closed (yes, no, or assigned debt). | — | | `fundType` | string | No | Whether the credit facility is funded or non funded. | — | | `sanctionCurrency` | string | No | The currency in which the loan is denominated (INR or USD). | — | | `creditSubtype` | string | No | Whether the financial debt is created pursuant to a credit facility or the purchase of a property. | — | | `facilityName` | string | No | The name of the loan facility. | — | | `amountOverdue` | string | No | The amount overdue on the loan. | — | | `otherChargeAmount` | string | No | Any other charges (if applicable). | — | | `debtStartDate` | string | No | The date on which the financial debt started. | — | | `interestAmount` | string | No | The amount of interest. | — | | `oldDebtRefNo` | string | No | The old debt reference number (applicable in case there is a change in the debt reference number). | — | | `principalOutstanding` | string | No | The outstanding principal amount. | — | | `loanRemark` | string | No | Loan remarks (if any). | — | | `totalOutstandingAmount` | string | No | Total outstanding amount. | — | | `creditorBusinessUnit` | string | No | The business unit of the creditor providing the debt (such as SME, Retail etc). | — | | `drawingPower` | string | No | The drawing power of the loan. | — | | `daysPastDue` | string | No | The number of days past due date. | — | | `event` | string | No | The type of eBG event. **Note:** Valid values for eBG document creation: `INVOCATION`, `AMENDMENT`, `CANCELLATION`, `RENEWAL`, `CLOSURE`, `PARTIAL_INVOCATION`. `EXTEND_OR_PAY` is not valid for document creation but may be received as a notification event type. Allowed: `INVOCATION`, `AMENDMENT`, `CANCELLATION`, `RENEWAL`, `CLOSURE`, `PARTIAL_INVOCATION`. | — | | `expiryDate` | string | No | The expiry date of eBG | — | | `claimExpiryDate` | string | No | The claim expiry date of eBG | — | | `currencyOfDebt` | string | No | The currency of the debt | — | ###### NeslSecurityDetails3_1ResponseObject | Field | Type | Required | Description | Example | |-------|------|----------|-------------|---------| | `securityDescription` | string | No | Description of security. | — | | `assetsType` | string | No | Type of asset forming security (Movable, Immovable, Intangible, Not Classified). | — | | `chargeType` | string | No | Type of charge created (Mortgage, Hypothecation, Charge, Assignment, Pledge, Lien, Negative Lien, Guarantee, Others, Not Classified). | — | | `assetId` | string | No | Asset ID of the Security (used internally by the lender). | — | | `doc` | string | No | Date of creation of security. | — | | `dov` | string | No | Date of valuation of security. | — | | `cersaiId` | string | No | CERSAI ID of security created. | — | | `rocChargeId` | string | No | ROC ID for security created. | — | | `securityValue` | string | No | Value of security. | — | ###### NeslStampDetails3_1ResponseObject | Field | Type | Required | Description | Example | |-------|------|----------|-------------|---------| | `firstParty` | string | No | The name of the first party (for the stamp paper). | — | | `secondParty` | string | No | The name of the second party (for the stamp paper). | — | | `stampDutyAmount` | string | No | The stamp duty amount. | — | | `considerationPrice` | string | No | The consideration price for the purposes of stamp duty. | — | | `descriptionOfDocument` | string | No | The description of the document for the purposes of stamp duty. | — | | `stampDutyPaidBy` | string | No | The name of the party paying the stamp duty. `firstParty` or `secondParty` | — | | `articleCode` | string | No | Article code used in the document. | — | | `articleSubCode` | string | No | Article Sub-code used in the document. | — | | `firstPartyPin` | string | No | The pin of the first party (for the stamp paper). | — | | `secondPartyPin` | string | No | The pin of the second party (for the stamp paper). | — | | `firstPartyOVDType` | string | No | The OVD Type of the first party (for the stamp paper). | — | | `firstPartyOVDValue` | string | No | The OVD Value of the first party (for the stamp paper). | — | | `secondPartyOVDType` | string | No | The OVD Type of the second party (for the stamp paper). | — | | `secondPartyOVDValue` | string | No | The OVD Value of the second party (for the stamp paper). | — | ###### NeslPartyDetails3_1ResponseObject | Field | Type | Required | Description | Example | |-------|------|----------|-------------|---------| | `fullName` | string | No | Full name of the Party. | — | | `contactPersonName` | string | No | Full name of the contact person of the Party. | — | | `contactRelation` | string | No | Relation of the party to the debt (Debtor, Guarantor, Co-obligant). | — | | `emailId` | string | No | Email ID of the signer. | — | | `mobileNumber` | string | No | Mobile Number of the signer. | — | | `dob` | string | No | Date of Birth/Incorporation. | — | | `legalConstitution` | string | No | Legal constitution of the signer (Resident Individual, Private Limited, Public Limited, LLP, Proprietorship, Partnership, Entity created by Statute, Trust, HUF, Coop Society, Association of Persons, Government, Self Help Groups, Non-Resident, Foreign Company). | — | | `alternateEmailId` | string | No | Alternate email ID of the signer. | — | | `alternateMobileNumber` | string | No | Alternate mobile of the signer. | — | | `officialDocType` | string | No | Official Document Type (Pan Card, Driving License, Voter ID, Passport, Others). | — | | `officialDocId` | string | No | Official Document ID. | — | | `registeredAddress` | string | No | Registered address of the signer. | — | | `registeredPinCode` | string | No | PIN code of the registered address of the signer. | — | | `designation` | string | No | Designation of the signer (relevant in case of corporate entities). | — | | `communicationAddress` | string | No | Communication address of the signer. | — | | `communicationAddressPinCode` | string | No | PIN code of the communication address of the signer. | — | | `cin` | string | No | Corporate Identification Number (relevant in case of corporate entities). | — | | `kin` | string | No | KYC Identification Number of signer. | — | | `partyType` | string | No | Type of Party (Indian entity/ Resident Individual/ Foreign Entity/ NRI/Foreign Individual. | — | | `isIndividual` | string | No | If the party is individual or not. **Note:** Valid values are `YES` or `NO` (case-insensitive, full words). Allowed: `YES`, `NO`. | — | | `signatoryGender` | string | No | Gender of the signatory | — | | `businessUnit` | string | No | Business Unit | — | ##### CCArrayResponseObject | Field | Type | Required | Description | Example | |-------|------|----------|-------------|---------| | `id` | string | No | Unique identifier for this CC recipient. | — | | `name` | string | No | Name of the CC recipient. | — | | `email` | string | No | Email address of the CC recipient. | — | | `invitationNotification` | boolean | No | Indicates whether invitation notifications are enabled for this CC. | — | | `signingNotification` | boolean | No | Indicates whether signing notifications (sent when a signer signs) are enabled for this CC. | — | | `completionNotification` | boolean | No | Indicates whether completion notifications (sent when all signers have signed) are enabled for this CC. | — | | `failureNotification` | boolean | No | Indicates whether failure notifications are enabled for this CC. | — | | `sendInvitationUrl` | boolean | No | Indicates whether the signing invitation URL is shared with this CC. | — | | `shareDocAuditTrail` | boolean | No | Indicates whether the audit trail are shared with this CC. | — | | `enforceOneFactorAuthentication` | boolean | No | Indicates whether one-factor authentication (OTP) is required for this CC to access the document. | — | | `recordAuditTrail` | boolean | No | Indicates whether this CC's notification events are recorded in the audit trail. | — | ##### CoordinatePickerDetails3_1ResponseObject | Field | Type | Required | Description | Example | |-------|------|----------|-------------|---------| | `coordinatePickerUrl` | string | No | URL for the coordinate picker to set eSign coordinates on the document. | — | | `coordinatePickerWebhook` | string | No | Webhook URL on which a response is sent when eSign coordinates are set by the coordinate picker. | — | ##### InvitationsArray3_1ResponseObject | Field | Type | Required | Description | Example | |-------|------|----------|-------------|---------| | `name` | string | No | Name of the invitee (signer/reviewer). | — | | `email` | string | No | Email address of the invitee. | — | | `phone` | string | No | Phone number of the invitee (10-digit format without country code). | — | | `inviteeType` | string | No | Type of the invitee. - `APPROVER` — A reviewer who reviews and approves the document before signers can proceed - `SIGNER` — A signer who applies a signature to the document | — | | `inviteeConfigs` | InviteeConfigDetails3_1ResponseObject | No | See **InviteeConfigDetails3_1ResponseObject** below. | — | | `recordReviewerDetails` | boolean | No | Indicates whether the reviewer's details are captured in the audit trail. Applicable only for reviewer invitee type. | — | | `inviteeGroup` | InviteeGroupDetails3_1ResponseObject | No | See **InviteeGroupDetails3_1ResponseObject** below. | — | | `invitationUrl` | string | No | Signing/reviewing URL generated for this invitee. The invitee uses this URL to access and sign/review the document. | — | | `allowedSignatures` | array\ | No | List of signature types allowed for this invitee. - **Possible values:** `Virtual Sign`, `Visual Sign`, `Quick Sign`, `Aadhaar eSign`, `DSC Token`, `NeSL`, `Doc Signer` | — | | `usedSignatureType` | string | No | The signature type actually used by the invitee to sign. Returns `null` if the invitee has not yet signed. - **Possible values:** `Virtual Sign`, `Visual Sign`, `Quick Sign`, `Aadhaar eSign`, `DSC Token`, `Nesl_eSign`, `Doc Signer` | — | | `signatureSubOptionUsed` | string | No | The signature sub-type actually used by the invitee to sign. Returns `null` if the invitee has not yet signed. Possible values are - **NeSL eSign:** `OTP`, `BIO`, `FACE`, `IRIS`, `ETOKEN` | — | | `signatureOptions` | InviteeSignatureOptionDetails3_1ResponseObject | No | See **InviteeSignatureOptionDetails3_1ResponseObject** below. | — | | `signatureOptionUsed` | string | No | The specific signature option (sub-type) used under the selected signature type. Returns `null` if not yet signed. - **Aadhaar eSign:** `One Time Password`, `Bio-Metric`, `Iris`, `Face` - **Virtual Sign:** `Allow Draw`, `Allow Choose`, `Affix Fingerprint` - **Visual Sign:** `Allow Draw`, `Allow Choose`, `Physical Signature` - **Quick Sign:** `Allow Draw`, `Allow Choose`, `Affix Fingerprint`, `Physical Signature` | — | | `neslInvitationDetails` | InviteeNESLParticipantDetails3_1ResponseObject | No | See **InviteeNESLParticipantDetails3_1ResponseObject** below. | — | | `offlineSignDetails` | InviteeOfflineSignDetails3_1ResponseObject | No | See **InviteeOfflineSignDetails3_1ResponseObject** below. | — | | `invitationStatus` | InviteeStatusDetails3_1ResponseObject | No | See **InviteeStatusDetails3_1ResponseObject** below. | — | | `certificateData` | InviteeCertificateDetails3_1ResponseObject | No | See **InviteeCertificateDetails3_1ResponseObject** below. | — | | `verificationRequest` | InviteeVerificationRequestDetails3_1ResponseObject | No | See **InviteeVerificationRequestDetails3_1ResponseObject** below. | — | | `verificationResponse` | object | No | Verification results for this invitee. Returned only when the `invitations_verificationResponse` query parameter is set to `true`. Contains the outcome of each configured verification check (name, pincode, state, title, YOB, gender) as well as face match and smart user liveliness results. See **verificationResponse** below. | — | | `supportingDocuments` | array\ | No | Supporting documents uploaded by the invitee during the signing journey. > **Note:** The response field name is `attachments` (not `supportingDocuments`). See **AttachmentsArrayResponseObject** below. | — | ###### InviteeConfigDetails3_1ResponseObject | Field | Type | Required | Description | Example | |-------|------|----------|-------------|---------| | `emailNotification` | boolean | No | Indicates whether email notifications are enabled for this invitee. | — | | `phoneNotification` | boolean | No | Indicates whether phone/SMS notifications are enabled for this invitee. | — | | `whatsappEnabled` | boolean | No | Indicates whether WhatsApp notifications for completion are enabled for this invitee. | — | | `whatsAppNotification` | boolean | No | Indicates whether WhatsApp notifications for eSigning invitation, reminders, and all others are enabled. Only applicable if `whatsappEnabled` is `true`. | — | | `retry` | integer | No | Number of retry attempts configured for this invitee (applicable only for Aadhaar eSign). This is the number of additional attempts allowed after the first attempt. | — | | `fixedName` | boolean | No | If `true`, the invitee will NOT be able to edit their name in the signing journey. If `false`, the invitee can edit their name. | — | | `noName` | boolean | No | If `true`, the invitee's name will not appear in the signature appearance. | — | | `supportingDocument` | array\ | No | Array of supporting document names requested from the invitee during the signing journey. | — | | `viewSupportingDocument` | boolean | No | If `true`, the invitee can view the supporting documents uploaded by all other invitees in the signing journey. | — | | `organizationConfig` | InviteeOrganisationConfigDetails3_1ArrayResponseObject | No | See **InviteeOrganisationConfigDetails3_1ArrayResponseObject** below. | — | | `security` | InviteeSecurityDetails3_1ArrayResponseObject | No | See **InviteeSecurityDetails3_1ArrayResponseObject** below. | — | | `eSignPriority` | InviteeESignPriorityDetails3_1ArrayResponseObject | No | See **InviteeESignPriorityDetails3_1ArrayResponseObject** below. | — | | `customURL` | InviteeCustomURLDetails3_1ArrayResponseObject | No | See **InviteeCustomURLDetails3_1ArrayResponseObject** below. | — | | `customConsent` | string | No | Custom consent content displayed to the invitee during the signing journey. Returns `null` if no custom consent is configured. | — | | `enableRejectDocument` | boolean | No | If `true`, the signer is allowed to reject this invitation in the signing journey. | — | | `enableRejectMessage` | boolean | No | If `true`, the signer is required to provide a message when rejecting the invitation. | — | | `maskContactDetails` | boolean | No | If `true`, the invitee is restricted from viewing the contact details of other invitees during and after the signing journey. If `false`, the invitee can view other invitees' contact details. | — | | `languageDetails` | object | No | Language configuration for the invitee's signing journey. See **languageDetails** below. | — | | `paymentDetails` | InviteePaymentDetails | No | See **InviteePaymentDetails** below. | — | ###### InviteeOrganisationConfigDetails3_1ArrayResponseObject | Field | Type | Required | Description | Example | |-------|------|----------|-------------|---------| | `nameRequired` | boolean | No | Indicates whether an organization name is required. The organization name appears on the rubber seal and signature appearance. | — | | `fixedName` | boolean | No | If `true`, the invitee cannot edit the organization name that was pre-set. If `false`, the invitee can modify it. | — | | `name` | string | No | Organization name. If `fixedName` is `false`, this is the name the invitee entered during the signing journey. | — | | `requireSeal` | boolean | No | Indicates whether a rubber seal is required for this invitee. | — | | `sealType` | string | No | Type of rubber seal configured for this invitee. - **Possible values:** `Authorized signatory seal`, `Director Seal`, `Custom Seal` | — | ###### InviteeSecurityDetails3_1ArrayResponseObject | Field | Type | Required | Description | Example | |-------|------|----------|-------------|---------| | `enforceAuthentication` | boolean | No | Indicates whether OTP verification is required before the invitee can access the document. | — | | `twoFactorAuthentication` | boolean | No | Indicates whether two-factor authentication (both Email and Phone OTP) is enabled for this invitee. | — | | `sendDocumentRawUrl` | boolean | No | Indicates whether the raw document PDF URL is sent along with OTP emails/SMS messages. | — | | `captureLocation` | boolean | No | Indicates whether geolocation capture is enabled during the signing journey. | — | | `capturePhoto` | boolean | No | Indicates whether face/photo capture is enabled during the signing journey. | — | | `gpsConfig` | gpsConfigResponse | No | GPS location restriction and accuracy configuration set by the sender for this invitee. See **gpsConfigResponse** below. | — | | `faceMatch` | faceMatch | No | See **faceMatch** below. | — | | `userLiveliness` | boolean | No | Indicates whether User Liveliness (Live OTP verification) is enabled. | — | | `smartUserLiveliness` | smartUserLiveliness | No | See **smartUserLiveliness** below. | — | ###### gpsConfigResponse GPS location restriction and accuracy configuration set by the sender for this invitee. | Field | Type | Required | Description | Example | |-------|------|----------|-------------|---------| | `applyLocationRestriction` | boolean | No | `true` indicates location-based signing restriction is enabled for this invitee. The invitee can only sign from within the area defined by `allowedLatitude`, `allowedLongitude`, and `permissibleRadius`. | — | | `allowedLatitude` | number | No | Latitude of the permitted signing location configured by the sender. | `28.50950813247034` | | `allowedLongitude` | number | No | Longitude of the permitted signing location configured by the sender. | `77.08920288142689` | | `permissibleRadius` | integer | No | Radius (in meters) around the permitted location within which the invitee is allowed to sign. | `5000` | | `applyLocationAccuracy` | boolean | No | `true` indicates GPS accuracy validation is enabled. The invitee's device GPS accuracy must meet the `accuracyThreshold` to proceed with signing. | — | | `accuracyThreshold` | integer | No | Maximum allowed GPS accuracy in meters configured by the sender. Signing is blocked if the invitee's device accuracy exceeds this value. | `10000` | ###### faceMatch | Field | Type | Required | Description | Example | |-------|------|----------|-------------|---------| | `faceMatchEnabled` | boolean | No | Indicates whether Face Match is enabled (true) or disabled (false). | — | | `faceMatchRetriesConfigured` | integer | No | Number of additional retry attempts configured beyond the first attempt. For example, a value of `3` means the invitee gets 1 original attempt + 3 retries = 4 total face match attempts. Returns `null` if face match is not enabled. | — | ###### smartUserLiveliness | Field | Type | Required | Description | Example | |-------|------|----------|-------------|---------| | `smartUserLivelinessEnabled` | boolean | No | Indicates whether Smart User Liveliness is enabled for this invitee. `true` if enabled, `false` if not. Returns `false` when not configured. | — | | `smartUserLivelinessRetriesConfigured` | integer | No | Number of additional retry attempts configured beyond the first attempt for Smart User Liveliness. Returns `null` if Smart User Liveliness is not enabled. | — | ###### InviteeESignPriorityDetails3_1ArrayResponseObject | Field | Type | Required | Description | Example | |-------|------|----------|-------------|---------| | `eSignPriorityEnabled` | boolean | No | Priority sequence is enabled for eSign types like Aadhaar | — | | `eSignPriorityConfig` | array\ | No | Configurations like retry attempt and order for eSign types (e.g., AADHAAR) and subtypes (e.g., OTP, BIO, IRIS) See **InviteeESignPriorityESignPriorityConfig3_1ArrayResponseObject** below. | — | ###### InviteeESignPriorityESignPriorityConfig3_1ArrayResponseObject | Field | Type | Required | Description | Example | |-------|------|----------|-------------|---------| | `signatureType` | string | No | Type eSign selected for the invitee like AADHAAR | — | | `eSignSubType` | string | No | Subtype of eSign selected for the invitee. - **Possible values:** `OTP`, `BIO`, `IRIS`, `FACE` | — | | `retryAttempts` | integer | No | Number of retry attempts assigned to this eSign subtype before the nextin order eSign subtype is shown to the signer | — | | `eSignOrder` | integer | No | The sequence in which this eSign subtype will appear in the signing journey | — | ###### InviteeCustomURLDetails3_1ArrayResponseObject | Field | Type | Required | Description | Example | |-------|------|----------|-------------|---------| | `webhookURL` | string | No | The configured webhook URL for this invitee. Leegality sends a POST request to this URL after the invitee successfully signs. Returns `null` if no webhook URL is configured. | — | | `redirectURL` | string | No | URL where you want the user to be redirected on completion of the transaction (Not applicable if you are using our Front-end SDKs). documentId will be appended to the URL on redirection. | — | | `errorWebhookURL` | string | No | The configured error webhook URL for this invitee. Leegality sends a POST request to this URL after expiry, failure, or rejection of the signature. Returns `null` if no error webhook URL is configured for this invitee. | — | | `baseURL` | string | No | URL where you want the user to be redirected on rejection/failure of the transaction (Not applicable if you are using our Front-end SDKs). documentId will be appended to the URL on redirection. | — | | `webhookVersion` | string | No | The webhook version configured for this invitee, which determines the webhook payload format. - **Possible values:** `V2.1` (default), `V2.5` | — | ###### languageDetails Language configuration for the invitee's signing journey. | Field | Type | Required | Description | Example | |-------|------|----------|-------------|---------| | `enableLanguage` | boolean | No | Whether language selection is enabled for this invitee. Returns `null` if not configured. | — | | `defaultLanguage` | boolean | No | Whether a default language has been set. Returns `null` if not configured. | — | | `defaultLanguageSelect` | string | No | The default language configured for this invitee's signing journey. - **Example values:** `HINDI`, `MARATHI`, `TAMIL` | — | ###### InviteePaymentDetails | Field | Type | Required | Description | Example | |-------|------|----------|-------------|---------| | `paymentCollectionEnabled` | boolean | No | Indicates whether payment collection is enabled for this invitee. `true` if enabled, `false` if not. | — | | `paymentProfileId` | string | No | Profile ID of the selected payment profile. Refer to the Account Tab in the Leegality dashboard to see details of the payment profile. | — | | `paymentCollectionAmount` | string | No | The configured payment amount to be collected from the invitee, as a string. | — | | `paymentCollectionMessage` | string | No | Message displayed to the invitee during payment collection. Returns `null` if no message was configured. | — | | `paymentCollectStatus` | string | No | Current status of payment collection for this invitee. - **Razorpay:** `notPaid`, `Authorised`, `Captured`, `Refunded` - **Billdesk:** `notPaid`, `Completed`, `Refunded` | — | | `paymentId` | string | No | Payment transaction ID. Available when `paymentCollectStatus` is `Authorised` or `Captured` (Razorpay), or `Completed` (Billdesk). Returns `null` otherwise. | — | | `paymentEventDate` | string | No | Payment transaction date. Available when `paymentCollectStatus` is `Authorised` or `Captured` (Razorpay), or `Completed` (Billdesk). Returns `null` otherwise. | — | ###### InviteeGroupDetails3_1ResponseObject | Field | Type | Required | Description | Example | |-------|------|----------|-------------|---------| | `id` | string | No | Unique identifier for the invitee group. | — | | `name` | string | No | Name of the invitee group. | — | | `completionThreshold` | integer | No | Number of people required to sign in the group for the group signature to be considered complete. For example, if a group has 5 members and the threshold is 3, only 3 out of 5 need to sign. Returns `null` for invitees not in a group. | — | | `completionStatus` | string | No | Completion status of the group signing process as a fraction string. - **Format:** `"signed/total"` (e.g., `"1/2"` means 1 out of 2 members have signed) | — | | `size` | integer | No | Total number of invitations/members in the group. | — | | `completed` | boolean | No | Indicates whether the group signature requirement has been met (i.e., the number of signers has reached the `completionThreshold`). | — | ###### InviteeSignatureOptionDetails3_1ResponseObject | Field | Type | Required | Description | Example | |-------|------|----------|-------------|---------| | `aadhaar` | array\ | No | Aadhaar authentication method(s) configured for this invitee. - **Possible values:** `OTP`, `BIO`, `IRIS`, `FACE` | — | | `virtual` | array\ | No | Virtual sign type(s) configured for this invitee. - **Possible values:** `Allow Choose`, `Allow Draw`, `Affix Fingerprint` | — | | `visualSign` | array\ | No | Visual Sign type(s) configured for this invitee. Only present when `invitations_signatureOptions_visualSign` is passed as `true`. - **Possible values:** `Allow Choose`, `Allow Draw`, `Physical Signature` | — | | `quickSign` | array\ | No | Quick Sign option(s) configured for this invitee. Only present when `invitations_signatureOptions_quickSign` is passed as `true`. - **Possible values:** `Allow Choose`, `Allow Draw`, `Affix Fingerprint`, `Physical Signature` | — | ###### InviteeNESLParticipantDetails3_1ResponseObject | Field | Type | Required | Description | Example | |-------|------|----------|-------------|---------| | `type` | string | No | NeSL participant type. - `F2F` — invitee receives sign URL from Leegality via mail/SMS - `Non F2F` — sign URL is sent directly by NeSL | — | | `participantDetails` | NeslparticipantDetails3_1ResponseObject | No | See **NeslparticipantDetails3_1ResponseObject** below. | — | ###### NeslparticipantDetails3_1ResponseObject | Field | Type | Required | Description | Example | |-------|------|----------|-------------|---------| | `fullName` | string | No | Full name of the Party. | — | | `contactPersonName` | string | No | Full name of the contact person of the Party. | — | | `contactRelation` | string | No | Relation of the party to the debt (Debtor, Guarantor, Co-obligant). **Note:** For EBG, only `DEBTOR` (first participant) and `BENEFICIARY` are accepted. | — | | `emailId` | string | No | Email ID of the signer. | — | | `mobileNumber` | string | No | Mobile Number of the signer. | — | | `dob` | string | No | Date of Birth/Incorporation. | — | | `legalConstitution` | string | No | Legal constitution of the signer (Resident Individual, Private Limited, Public Limited, LLP, Proprietorship, Partnership, Entity created by Statute, Trust, HUF, Coop Society, Association of Persons, Government, Self Help Groups, Non-Resident, Foreign Company). | — | | `alternateEmailId` | string | No | Alternate email ID of the signer. | — | | `alternateMobileNumber` | string | No | Alternate mobile of the signer. | — | | `officialDocType` | string | No | Official Document Type (Pan Card, Driving License, Voter ID, Passport, Others). | — | | `officialDocId` | string | No | Official Document ID. | — | | `registeredAddress` | string | No | Registered address of the signer. | — | | `registeredPinCode` | string | No | PIN code of the registered address of the signer. | — | | `designation` | string | No | Designation of the signer (relevant in case of corporate entities). | — | | `communicationAddress` | string | No | Communication address of the signer. | — | | `communicationAddressPinCode` | string | No | PIN code of the communication address of the signer. | — | | `cin` | string | No | Corporate Identification Number (relevant in case of corporate entities). | — | | `kin` | string | No | KYC Identification Number of signer. | — | | `partyType` | string | No | Type of Party (Indian entity/ Resident Individual/ Foreign Entity/ NRI/Foreign Individual. | — | | `isIndividual` | string | No | If the participant is individual or not. **Note:** Valid values are `YES` or `NO` (case-insensitive, full words). Required for EBG registrationType. Allowed: `YES`, `NO`. | — | | `signatoryGender` | string | No | Gender of the signatory | — | | `businessUnit` | string | No | Business Unit | — | ###### InviteeOfflineSignDetails3_1ResponseObject | Field | Type | Required | Description | Example | |-------|------|----------|-------------|---------| | `fixSignerId` | boolean | No | Parameter to find out if signerID is fixed for the invitation. | — | | `mobileNumber` | string | No | Mobile number corresponding to the signerID fixed for the invitation. | — | | `pan` | string | No | PAN corresponding to the signerID fixed for the invitation. | — | | `signerId` | string | No | SignerID corresponding to the signerID fixed for the invitation. | — | ###### InviteeStatusDetails3_1ResponseObject | Field | Type | Required | Description | Example | |-------|------|----------|-------------|---------| | `active` | boolean | No | Indicates it is the invitee's turn to act (sign/review). - `true` — invitee can currently access and act on the document - `false` — not the invitee's turn yet When signing order is enabled, only the current invitee(s) in the sequence will have `active=true`. > **Note:** `active` remains `true` even after the invitee has signed/approved. | — | | `signed` | boolean | No | Indicates the invitation has been signed successfully by the invitee. | — | | `reviewed` | boolean | No | Applicable only for Reviewer invitee type. Indicates the invitation has been reviewed (either approved or rejected). | — | | `approved` | boolean | No | Applicable only for Reviewer invitee type. Indicates the reviewer has approved the document. | — | | `rejected` | boolean | No | Applicable only for Signer invitee type. Indicates the signer has rejected the invitation. Resets to `false` if the invitation is re-sent and the signer subsequently signs. | — | | `expired` | boolean | No | Indicates the invitation has expired. The invitee can no longer access the signing URL. **Note:** Also set to `true` when a group signing threshold is met and this invitee was a non-signing member of the group. In that case, `failureReason` will contain `"Group Minimum Signature Completed."`. | — | | `recordApproverResponse` | boolean | No | Indicates whether the reviewer/approver's actions are recorded in the audit trail. | — | | `creationDate` | string | No | Creation date of the signing invitation. **Format:** `DD-MM-YYYY HH:MM:SS` | — | | `expiryDate` | string | No | Expiry date of the signing invitation. **Format:** `DD-MM-YYYY HH:MM:SS` If `null`, the default expiry is 45 minutes from creation. | — | | `signDate` | string | No | Date when the invitee signed the document. Returns `null` if not yet signed. **Format:** `DD-MM-YYYY HH:MM:SS` | — | | `failureReason` | string | No | Reason for failure or special status. Not limited to error scenarios — also contains informational messages. - `"Group Minimum Signature Completed."` — Group threshold was met; remaining group members' invitations closed - `"Signed but Verification Failed."` — Invitee signed but certificate verification failed - `null` — No failure or special status | — | | `rejectionMessage` | string | No | The message sent by the approver/reviewer at the time of rejecting the invitation. Returns `null` if no rejection occurred or no message was provided. | — | | `signRejectionMessage` | string | No | The message sent by the signer/invitee at the time of rejecting the invitation. Returns `null` if no rejection occurred or no message was provided. **Note:** This value persists even if the invitee later signs the document (after re-sending). The `rejected` field resets to `false` after signing, but this message remains. | — | ###### InviteeCertificateDetails3_1ResponseObject | Field | Type | Required | Description | Example | |-------|------|----------|-------------|---------| | `name` | string | No | Name of the signer as recorded in the digital signature certificate. Returns `null` if not available. | — | | `yob` | string | No | Year of birth of the signer from the digital signature certificate. - **Format:** `YYYY` (e.g., `"1998"`) | — | | `gender` | string | No | Gender of the signer from the digital signature certificate. - `M` — Male - `F` — Female - `T` — Transgender | — | | `pincode` | string | No | PIN code of the signer from the digital signature certificate (6-digit string). Returns `null` if not available. | — | | `title` | string | No | Last 4 digits of the Aadhaar number of the signer, as recorded in the digital signature certificate. Returns `null` if not available. | — | | `state` | string | No | State of the signer from the digital signature certificate. Returns `null` if not available. | — | | `photoHash` | string | No | SHA-256 hash of the signer's photo from the digital signature certificate. - **Format:** 64-character hexadecimal string | — | | `uid` | string | No | UID from the digital signature certificate. **Note:** This field is typically `null` (masked/not returned) even after Aadhaar-based signing, due to privacy restrictions. | — | | `serialNumber` | string | No | Serial number of the digital signature certificate used for signing. Returns `null` if not available. | — | ###### InviteeVerificationRequestDetails3_1ResponseObject | Field | Type | Required | Description | Example | |-------|------|----------|-------------|---------| | `aadhaarConfig` | InviteeAadhaarVerificationRequestDetails3_1ResponseObject | No | Verification request configuration for this invitee. These fields contain the **input values** provided when creating the document — not boolean flags. **Note:** `smartNamePercentage` is a boolean toggle (`true`/`null`). All other fields contain the actual input values to verify against (e.g., pincode string, state name, year of birth integer). See **InviteeAadhaarVerificationRequestDetails3_1ResponseObject** below. | — | | `offlineConfig` | InviteeAadhaarVerificationRequestDetails3_1ResponseObject | No | Verification request configuration for this invitee. These fields contain the **input values** provided when creating the document — not boolean flags. **Note:** `smartNamePercentage` is a boolean toggle (`true`/`null`). All other fields contain the actual input values to verify against (e.g., pincode string, state name, year of birth integer). See **InviteeAadhaarVerificationRequestDetails3_1ResponseObject** below. | — | | `dscConfig` | InviteeDSCVerificationRequestDetails3_1ResponseObject | No | See **InviteeDSCVerificationRequestDetails3_1ResponseObject** below. | — | | `neslConfig` | InviteeAadhaarVerificationRequestDetails3_1ResponseObject | No | Verification request configuration for this invitee. These fields contain the **input values** provided when creating the document — not boolean flags. **Note:** `smartNamePercentage` is a boolean toggle (`true`/`null`). All other fields contain the actual input values to verify against (e.g., pincode string, state name, year of birth integer). See **InviteeAadhaarVerificationRequestDetails3_1ResponseObject** below. | — | ###### InviteeAadhaarVerificationRequestDetails3_1ResponseObject Verification request configuration for this invitee. These fields contain the **input values** provided when creating the document — not boolean flags. **Note:** `smartNamePercentage` is a boolean toggle (`true`/`null`). All other fields contain the actual input values to verify against (e.g., pincode string, state name, year of birth integer). | Field | Type | Required | Description | Example | |-------|------|----------|-------------|---------| | `smartNamePercentage` | boolean | No | Whether smart name percentage matching is enabled for this invitee. Returns `true` if enabled, `null` if not configured. | — | | `nameVerification` | boolean | No | Whether exact name verification is enabled for this invitee. Returns `true` if enabled, `null` if not configured. | — | | `pincodeVerification` | string | No | The pincode value to verify against the signer's certificate. **Example:** `"247667"` Returns `null` if pincode verification is not configured. | — | | `stateVerification` | string | No | The state name to verify against the signer's certificate. **Example:** `"Uttarakhand"` Returns `null` if state verification is not configured. | — | | `titleVerification` | string | No | The last 4 digits of the Aadhaar number to verify against the signer's certificate. **Example:** `"3870"` Returns `null` if title verification is not configured. | — | | `yobVerification` | integer | No | The year of birth to verify against the signer's certificate. **Example:** `1998` Returns `null` if YOB verification is not configured. | — | | `genderVerification` | string | No | The gender value to verify against the signer's certificate. - `M` — Male - `F` — Female - `T` — Transgender | — | ###### InviteeAadhaarVerificationRequestDetails3_1ResponseObject Verification request configuration for this invitee. These fields contain the **input values** provided when creating the document — not boolean flags. **Note:** `smartNamePercentage` is a boolean toggle (`true`/`null`). All other fields contain the actual input values to verify against (e.g., pincode string, state name, year of birth integer). | Field | Type | Required | Description | Example | |-------|------|----------|-------------|---------| | `smartNamePercentage` | boolean | No | Whether smart name percentage matching is enabled for this invitee. Returns `true` if enabled, `null` if not configured. | — | | `nameVerification` | boolean | No | Whether exact name verification is enabled for this invitee. Returns `true` if enabled, `null` if not configured. | — | | `pincodeVerification` | string | No | The pincode value to verify against the signer's certificate. **Example:** `"247667"` Returns `null` if pincode verification is not configured. | — | | `stateVerification` | string | No | The state name to verify against the signer's certificate. **Example:** `"Uttarakhand"` Returns `null` if state verification is not configured. | — | | `titleVerification` | string | No | The last 4 digits of the Aadhaar number to verify against the signer's certificate. **Example:** `"3870"` Returns `null` if title verification is not configured. | — | | `yobVerification` | integer | No | The year of birth to verify against the signer's certificate. **Example:** `1998` Returns `null` if YOB verification is not configured. | — | | `genderVerification` | string | No | The gender value to verify against the signer's certificate. - `M` — Male - `F` — Female - `T` — Transgender | — | ###### InviteeDSCVerificationRequestDetails3_1ResponseObject | Field | Type | Required | Description | Example | |-------|------|----------|-------------|---------| | `smartNamePercentage` | boolean | No | Whether smart name verification is turned on or not. | — | | `nameVerification` | boolean | No | Whether name verification is turned on or not. | — | | `pincodeVerification` | boolean | No | Whether pincode verification is turned on or not. | — | | `stateVerification` | boolean | No | Whether state verification is turned on or not. | — | ###### InviteeAadhaarVerificationRequestDetails3_1ResponseObject Verification request configuration for this invitee. These fields contain the **input values** provided when creating the document — not boolean flags. **Note:** `smartNamePercentage` is a boolean toggle (`true`/`null`). All other fields contain the actual input values to verify against (e.g., pincode string, state name, year of birth integer). | Field | Type | Required | Description | Example | |-------|------|----------|-------------|---------| | `smartNamePercentage` | boolean | No | Whether smart name percentage matching is enabled for this invitee. Returns `true` if enabled, `null` if not configured. | — | | `nameVerification` | boolean | No | Whether exact name verification is enabled for this invitee. Returns `true` if enabled, `null` if not configured. | — | | `pincodeVerification` | string | No | The pincode value to verify against the signer's certificate. **Example:** `"247667"` Returns `null` if pincode verification is not configured. | — | | `stateVerification` | string | No | The state name to verify against the signer's certificate. **Example:** `"Uttarakhand"` Returns `null` if state verification is not configured. | — | | `titleVerification` | string | No | The last 4 digits of the Aadhaar number to verify against the signer's certificate. **Example:** `"3870"` Returns `null` if title verification is not configured. | — | | `yobVerification` | integer | No | The year of birth to verify against the signer's certificate. **Example:** `1998` Returns `null` if YOB verification is not configured. | — | | `genderVerification` | string | No | The gender value to verify against the signer's certificate. - `M` — Male - `F` — Female - `T` — Transgender | — | ###### verificationResponse Verification results for this invitee. Returned only when the `invitations_verificationResponse` query parameter is set to `true`. Contains the outcome of each configured verification check (name, pincode, state, title, YOB, gender) as well as face match and smart user liveliness results. | Field | Type | Required | Description | Example | |-------|------|----------|-------------|---------| | `smartNamePercentage` | integer | No | Name matching percentage between the provided name and the name from the CA authority certificate. **Example:** `45` (means 45% match) Returns `null` if smart name verification is not configured. | — | | `smartNameAI` | boolean | No | Whether Smart Name AI matching was enabled for this invitee. `true` = enabled, `false` = disabled, `null` = not configured. | — | | `signatureVerification` | boolean | No | Whether signature certificate verification was enabled for this invitee. `true` = enabled, `false` = disabled, `null` = not configured. | — | | `nameVerification` | boolean | No | Result of name verification against the signer's certificate. `true` = verification passed, `false` = verification failed, `null` = not configured. | — | | `pincodeVerification` | boolean | No | Result of pincode verification against the signer's certificate. `true` = verification passed, `false` = verification failed, `null` = not configured. | — | | `stateVerification` | boolean | No | Result of state verification against the signer's certificate. `true` = verification passed, `false` = verification failed, `null` = not configured. | — | | `titleVerification` | boolean | No | Result of title (last 4 digits of Aadhaar) verification against the signer's certificate. `true` = verification passed, `false` = verification failed, `null` = not configured. | — | | `yobVerification` | boolean | No | Result of year of birth verification against the signer's certificate. `true` = verification passed, `false` = verification failed, `null` = not configured. | — | | `genderVerification` | boolean | No | Result of gender verification against the signer's certificate. `true` = verification passed, `false` = verification failed, `null` = not configured. | — | | `neslNameVerification` | boolean | No | Indicates whether the invitee's name has been successfully verified. true means the verification succeeded, and false means it failed. | — | | `neslNameVerificationPercentage` | integer | No | The percentage of accuracy achieved during the invitee's name verification. | — | | `neslGenderVerification` | boolean | No | Indicates whether the invitee's gender has been successfully verified. true means the verification succeeded, and false means it failed. | — | | `neslYobVerification` | boolean | No | Indicates whether the invitee's Year of Birth (YOB) has been successfully verified. true means the verification succeeded, and false means it failed. | — | | `faceMatch` | FaceMatchArrayResponseObject | No | See **FaceMatchArrayResponseObject** below. | — | | `smartUserLiveliness` | SmartUserLivelinessArrayResponseObject | No | See **SmartUserLivelinessArrayResponseObject** below. | — | ###### FaceMatchArrayResponseObject | Field | Type | Required | Description | Example | |-------|------|----------|-------------|---------| | `faceMatchPercentage` | integer | No | Percentage of similarity between the source image and the image captured by the signer during face match. **Type:** Integer (e.g., `99`) Returns `null` if face match is not enabled or if the invitee has not yet completed signing. Only populated after the invitee has signed the document. | — | | `faceMatchAttemptsLeft` | integer | No | Number of remaining face match retry attempts. Decrements with **every** attempt (both successful and failed matches). Starts at the value of `faceMatchRetriesConfigured` and counts down. Returns `null` if face match is not enabled for this invitee. | — | | `faceMatchError` | string | No | Error message from the face matching process, if any. Returns `null` when face match is not enabled, when no error has occurred, or when attempts are still remaining. | — | ###### SmartUserLivelinessArrayResponseObject | Field | Type | Required | Description | Example | |-------|------|----------|-------------|---------| | `smartUserLivelinessPercentage` | integer | No | The percentage achieved by the invitee during Smart User Liveliness verification. Only the percentage of the invitee's most recent verification attempt is displayed. > **Note:** This percentage is only available after the invitee has either signed the document or the invitation has expired. Otherwise, it will return a `null` value. | — | | `smartUserLivelinessAttemptsLeft` | integer | No | Number of remaining attempts for the invitee to complete Smart User Liveliness. This value updates with each attempt. | — | ###### AttachmentsArrayResponseObject | Field | Type | Required | Description | Example | |-------|------|----------|-------------|---------| | `file` | string | No | CDN download URL for the attachment file. This is a signed URL with an expiration time — not a base64-encoded string. | — | | `name` | string | No | Filename of the attachment. **Example:** `"Invoice-6814F2DA-0024.pdf"` | — | | `type` | string | No | MIME type of the attachment. **Possible values:** `application/pdf`, `image/png`, `image/jpg`, `image/jpeg` | — | ### Sample Response (200) ```json { "status": 0, "messages": [ { "code": "simpleWorkFlow.success", "message": "Invitations sent successfully." } ], "data": { "file": "string", "auditTrail": "string", "document": { "id": "string", "name": "string", "irn": "string", "status": "string", "coordinatePicker": false, "deleted": false, "creationDate": "string", "completionDate": "string", "scheduledDeletionDate": "string", "customMessage": "string", "deleteOnComplete": false, "requestSigningOrder": false, "requireSigningOrder": false }, "sftp": { "sftpEnabled": false, "profileId": "string" }, "workflow": { "id": "string", "name": "string", "type": "string", "subtype": "string" }, "template": { "id": "string", "name": "string" }, "account": { "id": "string", "name": "string", "label": "string", "brandName": "string" }, "sender": { "name": "string", "username": "string" }, "folders": [ { "id": "string", "name": "string" } ], "stampDetails": { "groupName": "string", "groupNumber": "string", "stampValue": "string", "maximumValuePermitted": "string", "state": "string", "stamps": [ { "series": "03", "amount": "string", "serialNumber": "string", "associatedDocumentId": "string" } ], "multipleStampSeriesUsed": false }, "referenceAttachments": [ { "file": "string", "name": "string", "type": "string" } ], "neslDocumentDetails": { "transactionId": "string", "responseCode": "string", "responseMessage": "string", "isRetryAllowed": "string", "loanDetails": { "loanNumber": "string", "sanctionNumber": "string", "registrationType": "string", "state": "string", "branchName": "string", "branchAddress": "string", "dateOfSanction": "string", "emiAmount": "string", "rateOfInterest": "string", "sanctionAmount": "string", "tenure": "string", "typeOfDebt": "string", "accountClosedFlag": "string", "fundType": "string", "sanctionCurrency": "string", "creditSubtype": "string", "facilityName": "string", "amountOverdue": "string", "otherChargeAmount": "string", "debtStartDate": "string", "interestAmount": "string", "oldDebtRefNo": "string", "principalOutstanding": "string", "loanRemark": "string", "totalOutstandingAmount": "string", "creditorBusinessUnit": "string", "drawingPower": "string", "daysPastDue": "string", "event": "INVOCATION", "expiryDate": "string", "claimExpiryDate": "string", "currencyOfDebt": "string" }, "securityDetails": [ { "securityDescription": "string", "assetsType": "string", "chargeType": "string", "assetId": "string", "doc": "string", "dov": "string", "cersaiId": "string", "rocChargeId": "string", "securityValue": "string" } ], "stampDetails": { "firstParty": "string", "secondParty": "string", "stampDutyAmount": "string", "considerationPrice": "string", "descriptionOfDocument": "string", "stampDutyPaidBy": "string", "articleCode": "string", "articleSubCode": "string", "firstPartyPin": "string", "secondPartyPin": "string", "firstPartyOVDType": "string", "firstPartyOVDValue": "string", "secondPartyOVDType": "string", "secondPartyOVDValue": "string" }, "partyDetails": { "fullName": "string", "contactPersonName": "string", "contactRelation": "string", "emailId": "string", "mobileNumber": "string", "dob": "string", "legalConstitution": "string", "alternateEmailId": "string", "alternateMobileNumber": "string", "officialDocType": "string", "officialDocId": "string", "registeredAddress": "string", "registeredPinCode": "string", "designation": "string", "communicationAddress": "string", "communicationAddressPinCode": "string", "cin": "string", "kin": "string", "partyType": "string", "isIndividual": "YES", "signatoryGender": "string", "businessUnit": "string" }, "neslEstampStatus": "string", "neslEstampCertificates": [ "string" ] }, "cc": [ { "id": "string", "name": "string", "email": "string", "invitationNotification": false, "signingNotification": false, "completionNotification": false, "failureNotification": false, "sendInvitationUrl": false, "shareDocAuditTrail": false, "enforceOneFactorAuthentication": false, "recordAuditTrail": false } ], "coordinatePicker": { "coordinatePickerUrl": "string", "coordinatePickerWebhook": "string" }, "invitations": [ { "name": "string", "email": "string", "phone": "string", "inviteeType": "string", "inviteeConfigs": { "emailNotification": false, "phoneNotification": false, "whatsappEnabled": false, "whatsAppNotification": false, "retry": 0, "fixedName": false, "noName": false, "supportingDocument": [ "string" ], "viewSupportingDocument": false, "organizationConfig": { "nameRequired": false, "fixedName": false, "name": "string", "requireSeal": false, "sealType": "string" }, "security": { "enforceAuthentication": false, "twoFactorAuthentication": false, "sendDocumentRawUrl": false, "captureLocation": false, "capturePhoto": false, "gpsConfig": { "applyLocationRestriction": false, "allowedLatitude": 28.50950813247034, "allowedLongitude": 77.08920288142689, "permissibleRadius": 5000, "applyLocationAccuracy": false, "accuracyThreshold": 10000 }, "faceMatch": { "faceMatchEnabled": false, "faceMatchRetriesConfigured": 0 }, "userLiveliness": false, "smartUserLiveliness": { "smartUserLivelinessEnabled": false, "smartUserLivelinessRetriesConfigured": 0 } }, "eSignPriority": { "eSignPriorityEnabled": false, "eSignPriorityConfig": [ { "signatureType": "string", "eSignSubType": "string", "retryAttempts": 0, "eSignOrder": 0 } ] }, "customURL": { "webhookURL": "string", "redirectURL": "string", "errorWebhookURL": "string", "baseURL": "string", "webhookVersion": "string" }, "customConsent": "string", "enableRejectDocument": false, "enableRejectMessage": false, "maskContactDetails": false, "languageDetails": { "enableLanguage": false, "defaultLanguage": false, "defaultLanguageSelect": "string" }, "paymentDetails": { "paymentCollectionEnabled": false, "paymentProfileId": "string", "paymentCollectionAmount": "string", "paymentCollectionMessage": "string", "paymentCollectStatus": "string", "paymentId": "string", "paymentEventDate": "string" } }, "recordReviewerDetails": false, "inviteeGroup": { "id": "string", "name": "string", "completionThreshold": 0, "completionStatus": "string", "size": 0, "completed": false }, "invitationUrl": "string", "allowedSignatures": [ "string" ], "usedSignatureType": "string", "signatureSubOptionUsed": "string", "signatureOptions": { "aadhaar": [ "string" ], "virtual": [ "string" ], "visualSign": [ "string" ], "quickSign": [ "string" ] }, "signatureOptionUsed": "string", "neslInvitationDetails": { "type": "string", "participantDetails": { "fullName": "string", "contactPersonName": "string", "contactRelation": "string", "emailId": "string", "mobileNumber": "string", "dob": "string", "legalConstitution": "string", "alternateEmailId": "string", "alternateMobileNumber": "string", "officialDocType": "string", "officialDocId": "string", "registeredAddress": "string", "registeredPinCode": "string", "designation": "string", "communicationAddress": "string", "communicationAddressPinCode": "string", "cin": "string", "kin": "string", "partyType": "string", "isIndividual": "YES", "signatoryGender": "string", "businessUnit": "string" } }, "offlineSignDetails": { "fixSignerId": false, "mobileNumber": "string", "pan": "string", "signerId": "string" }, "invitationStatus": { "active": false, "signed": false, "reviewed": false, "approved": false, "rejected": false, "expired": false, "recordApproverResponse": false, "creationDate": "string", "expiryDate": "string", "signDate": "string", "failureReason": "string", "rejectionMessage": "string", "signRejectionMessage": "string" }, "certificateData": { "name": "string", "yob": "string", "gender": "string", "pincode": "string", "title": "string", "state": "string", "photoHash": "string", "uid": "string", "serialNumber": "string" }, "verificationRequest": { "aadhaarConfig": { "smartNamePercentage": false, "nameVerification": false, "pincodeVerification": "string", "stateVerification": "string", "titleVerification": "string", "yobVerification": 0, "genderVerification": "string" }, "offlineConfig": { "smartNamePercentage": false, "nameVerification": false, "pincodeVerification": "string", "stateVerification": "string", "titleVerification": "string", "yobVerification": 0, "genderVerification": "string" }, "dscConfig": { "smartNamePercentage": false, "nameVerification": false, "pincodeVerification": false, "stateVerification": false }, "neslConfig": { "smartNamePercentage": false, "nameVerification": false, "pincodeVerification": "string", "stateVerification": "string", "titleVerification": "string", "yobVerification": 0, "genderVerification": "string" } }, "verificationResponse": { "smartNamePercentage": 0, "smartNameAI": false, "signatureVerification": false, "nameVerification": false, "pincodeVerification": false, "stateVerification": false, "titleVerification": false, "yobVerification": false, "genderVerification": false, "neslNameVerification": false, "neslNameVerificationPercentage": 0, "neslGenderVerification": false, "neslYobVerification": false, "faceMatch": { "faceMatchPercentage": 0, "faceMatchAttemptsLeft": 0, "faceMatchError": "string" }, "smartUserLiveliness": { "smartUserLivelinessPercentage": 0, "smartUserLivelinessAttemptsLeft": 0 } }, "supportingDocuments": [ { "file": "string", "name": "string", "type": "string" } ] } ] } } ```