Use this api to create the sign request. The sign request can be created using multipart or json based. Multipart takes pdf and images as an input. JSON based takes base64 pdf as input.
Note : signature_type should be passed as external_sign
Getting started with Digio Rest Apis
|
HTTP Basic
Send
Authorization in header containing the word Basic followed by a space and a base64 encoded string of username:password.
|
Create Signature Request Multipart
|
file*
binary
|
||
|
Pass right content-type eg. application/pdf |
||
|
request*
object
|
object
Single line description
text (content-type text/plain)
{
file_name:
string
Optional. File downloaded post signing name.
will_self_sign:
boolean
Enable Delegate Signing.
signatory:
string
Email address of authorized signatory of business, will_self_sign should to true to delegate sign.
expire_in_days:
integer
➔ Request expiry in days Constraints: Min 1┃Max 90
Default: 10
callback:
string
Unique ID to be passed by you for the document (for idempotency). Note: Please use this with Unique Callback Id per document. If same callback Id is passed in the request, it’ll be considered duplicate request and information about previous document will be returned.
comment:
string
Message/Notes to be sent to the signing parties
display_on_page:
enum
➔ Signature display on page - first/last/all/custom (default is first). Pass “custom” if you are using sign_coordinates Default: first
Allowed: first┃last┃all┃custom
sign_coordinates:
{
Customized placing of signature.
Sample input :
"sign_coordinates":{ "xyz@abc.com":{ "1":[{ "llx":315,"lly":20, "urx":455,"ury":60}]}}
Map of signer identifiers. Each identifier points to a map of page no. Each page no. points to array of signature coordinates
[any-key]:
{
Customized placing of signature.
Sample input :
"sign_coordinates":{ "xyz@abc.com":{ "1":[{ "llx":315,"lly":20, "urx":455,"ury":60}]}}
Map of signer identifiers. Each identifier points to a map of page no. Each page no. points to array of signature coordinates
[any-key]:
[{
Customized placing of signature.
Sample input :
"sign_coordinates":{ "xyz@abc.com":{ "1":[{ "llx":315,"lly":20, "urx":455,"ury":60}]}}
Map of signer identifiers. Each identifier points to a map of page no. Each page no. points to array of signature coordinates
llx:
integer
lly:
integer
urx:
integer
ury:
integer
}]
}
}
notify_signers:
boolean
Sends an email/SMS to signers once document uploaded & signature request is created for signers
customer_notification_mode:
enum
➔ Sends an SMS/Whatsapp notification if the identifier is mobile number Default: SMS
Allowed: SMS┃WHATSAPP┃ALL┃EMAIL
signature_type:
enum
Allowed: dsc┃aadhaar┃external┃external_sign┃aadhaar_with_dependents┃electronic_with_dependents┃electronic┃document_review
estamp_request:
{
Details of Estamps, Quantities to be consumed and other merge details like
tags:
{
Map of tag names and quantities to be attached. Tag names should be without spaces
Note : Do not pass any special character or space in E-stamp tag name. Available tag names can be checked on dashboard -> E-Stamping section
[any-key]:
integer
Map of tag names and quantities to be attached. Tag names should be without spaces Note : Do not pass any special character or space in E-stamp tag name. Available tag names can be checked on dashboard -> E-Stamping section }
note_content:
string
➔ note on estamp page Constraints: Max 250 chars
Pattern: ^[^<>";=%!\*+?]*$
note_on_page:
enum
Default: last
Allowed: first┃last┃all┃custom
sign_on_page:
enum
Default: all
Allowed: first┃last┃all┃custom
}
custom_reference:
string
Custom reference text to be printed on document instead of the default stamp reference. If not provided, defaults to 'Stamp Reference#
reference_position:
enum
➔ Position of the reference text on the document. TOP prints horizontally at the top; LEFT and RIGHT print vertically along the respective side. Defaults to TOP. Default: TOP
Allowed: TOP┃LEFT┃RIGHT
generate_access_token:
boolean
➔ If true, will receive an access_token object in response. access_token used to bypass first factor authentication in SDKs. Default: false
post_signing_receivers:
[{
Signed document needs to be shared other than signer's email/mobile no or organization email.
identifier*:
string
Email address or mobile of user }]
signature_verification:
{
(Optional) Represents the overall signature verification configuration
[any-key]:
{
(Optional) Represents the overall signature verification configuration
abortOnFail*:
boolean
Determines whether to abort the signature attachment process if the conditions are not met for the associated signer. If false, it will continue to attach the signature.
maxAttempt*:
integer
➔ Specifies the maximum number of attempts allowed for the signature verification process for the associated signer. Constraints: Max 3
rules*:
[{
Represents a collection of rules for the signature verification process.
operation*:
enum
➔ Specifies the logical operation (AND/OR) to be performed on the conditions within a rule Allowed: AND┃OR
conditions*:
[{
Represents a collection of conditions that must be satisfied for the associated rule.
field*:
enum
➔ Specifies the field to be checked in the condition. Allowed: NAME┃YOB┃AADHAAR┃GENDER
matchType*:
enum
➔ Specifies the type of matching to be performed on the field (e.g., exact, fuzzy). Allowed: EXACT┃FUZZY
value*:
string
Specifies the value to be compared against the field in the condition.
threshold:
integer
(Optional) Specifies the threshold value for fuzzy matching.
inputValue:
string
Specifies the value to be compared against the field in the condition
fuzzyScore:
integer
Fuzzy score representing the similarity in case of fuzzy matching. Null if not applicable
multiPropertyRule:
{
multi property rule
[any-key]:
[string]
multi property rule }
}]
}]
}
}
signing_condition_request:
{
(Optional) Represents the overall signature conditional configuration
conditions:
[{
signingCondition:
[{
type:
enum
Allowed: AT_LEAST_N_ACTIONERS┃REQUIRED_UNITS
signers:
[{
signingPartyId:
string
identifier:
string
name:
string
signingStatus:
string
signedAt:
string
}]
identifiers:
[string]
value:
integer
conditionPassed:
boolean
}]
}]
}
include_authentication_url:
boolean
Pass True if authentication link is required in response payload based on above customer’s identifier
reference_id:
string
signers:
[{
Array of signer objects
identifier*:
string
Email address or mobile of user
reason:
string
➔ Signing reason for user from whom signature is requested Constraints: Max 250 chars
sign_type:
enum
➔ 'aadhaar' : sign using aadhaar. [default] 'dsc' : sign using DSC 'electronic' : Screen pad based signature (slate signature) Default: aadhaar
Allowed: dsc┃aadhaar┃external┃external_sign┃aadhaar_with_dependents┃electronic_with_dependents┃electronic┃document_review
signature_mode:
enum
➔ mode of signature, if sign_type is electronic Allowed: otp┃slate┃kyc┃otp_certified┃slate_certified┃esign_3┃esign_3s┃nesl_aadhaar_sign
name:
string
➔ Name of signer Constraints: 1 to 100 chars
Pattern: ^[^<>";=%!\*+?]*$
signer_tag:
string
Signer tag as mentioned in the template created over dashboard.
signing_addons:
[{
Additional sign features added upon document signing
type*:
enum
➔ geo_location: if geolocation is required Allowed: geo_location┃consent
performEnrichment:
boolean
➔ geo location with address Default: false
optional:
boolean
➔ pass true if geo location is optional Default: false
}]
index:
integer
}]
sequential:
boolean
➔ In multiparty signing, sequence outlines the order in which each involved party should sign the document. Default: false
send_sign_link:
boolean
Send direct signing link over email or sms. Default false. }
|
|
curl -X POST "https://api.digio.in/v2/client/document/upload" \
-H 'accept: application/json' Unique ID to identify documents provided by Digio. This has to be passed for directly landing on this document within the website
true/false
➔ 'outbound': Sent request to sign 'inbound': Received request to sign
➔ 'requested': pending signature from at least one signing party 'completed': all signing parties have signed 'expired': at least one signing party did n’t sign prior to request expiry
(Note: Documents that “expired” without any signature, and hasn’t been accessed in a month will be archived. Documents successfully signed archived after an year audit trail is available for downloading)
Name of the file as provided by you
'yyyy-mm-dd hh:mm:ss': Timestamp of Document upload in IST
true/false
➔ 'Aadhaar','Electronic','DSC'
➔
Array of signing parties
Name of the signing party
➔ 'requested': pending signature from user 'signed': signed by user 'expired': user did not sign prior to request expiry
➔ 'self': Requested from self 'org': Requested from an Organization and signatory not assigned 'signatory': Requested from an Organization and signatory has been assigned
➔ 'aadhaar': signed to be signed using aadhaar 'dsc': signed to be signed using dsc 'electronic' : signed using slate
➔ 'slate' 'slate_certified' 'otp' (can be viewed for electronic signature only)
Email or mobile of the signing party
Reason to sign the document
'yyyy-mm-dd hh:mm:ss': Timestamp of Sign Request expiry in IST, if set. Default: 10 days from requested_on
(Optional) Represents the overall signature verification configuration.
Overall result of the document validation. Possible values: "FAIL" or "PASS."
Array of rule results, each representing the outcome of an individual validation rule applied to the document.
⮕ [ Array of rule results, each representing the outcome of an individual validation rule applied to the document. ]
Unique identifier of the validation rule
Result of the validation rule. Possible values: "FAIL" or "PASS."
➔ Specifies the logical operation (AND/OR) to be performed on the conditions within a rule.
Represents a collection of conditions that must be satisfied for the associated rule.
⮕ [ Represents a collection of conditions that must be satisfied for the associated rule. ]
Specifies the field to be checked in the condition.
Type of matching being performed for the field in the condition. Possible values: "EXACT" or "FUZZY."
Actual value of the field being evaluated in the condition.
Expected value for the field being evaluated in the condition.
Fuzzy score representing the similarity in case of fuzzy matching. Null if not applicable
Result of the condition evaluation. Possible values: "FAIL" or "PASS."
If include_authentication_url was true in the request object then this object is populated.
Sign features added upon document signing
⮕ [ Sign features added upon document signing ]
➔
➔
➔ Either SEEDING | USER_INPUT
Flag indicating whether seeding is required or not
Existing User Name
Number of pages in document
Array of signing parties
⮕ [ Array of signing parties ]
Name of the signing party
➔ 'requested': pending signature from user 'signed': signed by user 'expired': user did not sign prior to request expiry
➔ 'self': Requested from self 'org': Requested from an Organization and signatory not assigned 'signatory': Requested from an Organization and signatory has been assigned
➔ 'aadhaar': signed to be signed using aadhaar 'dsc': signed to be signed using dsc 'electronic' : signed using slate
➔ 'slate' 'slate_certified' 'otp' (can be viewed for electronic signature only)
Email or mobile of the signing party
Reason to sign the document
'yyyy-mm-dd hh:mm:ss': Timestamp of Sign Request expiry in IST, if set. Default: 10 days from requested_on
(Optional) Represents the overall signature verification configuration.
Overall result of the document validation. Possible values: "FAIL" or "PASS."
Array of rule results, each representing the outcome of an individual validation rule applied to the document.
⮕ [ Array of rule results, each representing the outcome of an individual validation rule applied to the document. ]
Unique identifier of the validation rule
Result of the validation rule. Possible values: "FAIL" or "PASS."
➔ Specifies the logical operation (AND/OR) to be performed on the conditions within a rule.
Represents a collection of conditions that must be satisfied for the associated rule.
⮕ [ Represents a collection of conditions that must be satisfied for the associated rule. ]
Specifies the field to be checked in the condition.
Type of matching being performed for the field in the condition. Possible values: "EXACT" or "FUZZY."
Actual value of the field being evaluated in the condition.
Expected value for the field being evaluated in the condition.
Fuzzy score representing the similarity in case of fuzzy matching. Null if not applicable
Result of the condition evaluation. Possible values: "FAIL" or "PASS."
If include_authentication_url was true in the request object then this object is populated.
Sign features added upon document signing
⮕ [ Sign features added upon document signing ]
➔
➔
➔ Either SEEDING | USER_INPUT
Flag indicating whether seeding is required or not
Existing User Name
Organization name registered with Digio account
'yyyy-mm-dd hh:mm:ss': Timestamp of Sign Request origination in IST
'yyyy-mm-dd hh:mm:ss': Timestamp of Sign Request expiry in IST, if set. Default: 10 days from requested_on
Organization email address registered with Digio account
➔ org
➔ api
true/false
Only applicable while creating sign request when generate access token value is passes as “true”
Unique identifier of the parent entity the access token belongs to
Unique identifier referencing an access token
DateTime at which the access token expires. New token can be generated when expired with the access token generation API mentioned in the document.
'yyyy-mm-dd hh:mm:ss': Timestamp of generation
E Stamp Certificate ID consumed during document creation
E Stamp Certificate ID consumed during document creation
➔
➔
⮕ [ Additional sign features added upon document signing ]
➔ geo_location: if geolocation is required
➔ geo location with address
➔ pass true if geo location is optional
➔
➔
➔
Details of Estamps, Quantities to be consumed and other merge details like
Map of tag names and quantities to be attached. Tag names should be without spaces
Note : Do not pass any special character or space in E-stamp tag name. Available tag names can be checked on dashboard -> E-Stamping section
Map of tag names and quantities to be attached. Tag names should be without spaces Note : Do not pass any special character or space in E-stamp tag name. Available tag names can be checked on dashboard -> E-Stamping section
➔ note on estamp page
➔
➔
(Optional) Represents the overall signature verification configuration
Determines whether to abort the signature attachment process if the conditions are not met for the associated signer. If false, it will continue to attach the signature.
➔ Specifies the maximum number of attempts allowed for the signature verification process for the associated signer.
Represents a collection of rules for the signature verification process.
⮕ [ Represents a collection of rules for the signature verification process. ]
➔ Specifies the logical operation (AND/OR) to be performed on the conditions within a rule
Represents a collection of conditions that must be satisfied for the associated rule.
⮕ [ Represents a collection of conditions that must be satisfied for the associated rule. ]
➔ Specifies the field to be checked in the condition.
➔ Specifies the type of matching to be performed on the field (e.g., exact, fuzzy).
Specifies the value to be compared against the field in the condition.
(Optional) Specifies the threshold value for fuzzy matching.
Specifies the value to be compared against the field in the condition
Fuzzy score representing the similarity in case of fuzzy matching. Null if not applicable
multi property rule
multi property rule
(Optional) Represents the overall signature conditional configuration
➔
Details about the exception. Usually contains the exception id for reference.
Error code
Description of the error
Custom errors
Getting started with Digio Rest Apis
|
HTTP Basic
Send
Authorization in header containing the word Basic followed by a space and a base64 encoded string of username:password.
|
Create Signature Request JSON
{
"signers": [
{
"identifier": "email/mobile",
"name": "Signer Name",
"sign_type": "aadhaar",
"reason": "Reason for signing"
}
],
"expire_in_days": 10,
"display_on_page": "custom",
"notify_signers": true,
"send_sign_link": true,
"generate_access_token": true,
"file_name": "Test.pdf",
"file_data": "<base64 encoded pdf content>",
"sign_coordinates": {
"email/mobile": {
"1": [
{
"llx": 376.55510204081634,
"lly": 67.89677419354838,
"urx": 535.8943577430973,
"ury": 129.36122241086588
}
]
}
},
"estamp_request": {
"tags": {
"estamp_tag_name": "quantity"
},
"sign_on_page": "ALL",
"note_content": "This is dummy content",
"note_on_page": "ALL"
}
}
Optional. File downloaded post signing name.
Enable Delegate Signing.
Email address of authorized signatory of business, will_self_sign should to true to delegate sign.
➔ Request expiry in days
Unique ID to be passed by you for the document (for idempotency). Note: Please use this with Unique Callback Id per document. If same callback Id is passed in the request, it’ll be considered duplicate request and information about previous document will be returned.
Message/Notes to be sent to the signing parties
➔ Signature display on page - first/last/all/custom (default is first). Pass “custom” if you are using sign_coordinates
Customized placing of signature.
Sample input :
"sign_coordinates":{ "xyz@abc.com":{ "1":[{ "llx":315,"lly":20, "urx":455,"ury":60}]}}
Map of signer identifiers. Each identifier points to a map of page no. Each page no. points to array of signature coordinates
Customized placing of signature.
Sample input :
"sign_coordinates":{ "xyz@abc.com":{ "1":[{ "llx":315,"lly":20, "urx":455,"ury":60}]}}
Map of signer identifiers. Each identifier points to a map of page no. Each page no. points to array of signature coordinates
Customized placing of signature.
Sample input :
"sign_coordinates":{ "xyz@abc.com":{ "1":[{ "llx":315,"lly":20, "urx":455,"ury":60}]}}
Map of signer identifiers. Each identifier points to a map of page no. Each page no. points to array of signature coordinates
Sends an email/SMS to signers once document uploaded & signature request is created for signers
➔ Sends an SMS/Whatsapp notification if the identifier is mobile number
➔
Details of Estamps, Quantities to be consumed and other merge details like
Map of tag names and quantities to be attached. Tag names should be without spaces
Note : Do not pass any special character or space in E-stamp tag name. Available tag names can be checked on dashboard -> E-Stamping section
Map of tag names and quantities to be attached. Tag names should be without spaces Note : Do not pass any special character or space in E-stamp tag name. Available tag names can be checked on dashboard -> E-Stamping section
➔ note on estamp page
➔
➔
Custom reference text to be printed on document instead of the default stamp reference. If not provided, defaults to 'Stamp Reference#
➔ Position of the reference text on the document. TOP prints horizontally at the top; LEFT and RIGHT print vertically along the respective side. Defaults to TOP.
➔ If true, will receive an access_token object in response. access_token used to bypass first factor authentication in SDKs.
Signed document needs to be shared other than signer's email/mobile no or organization email.
⮕ [ Signed document needs to be shared other than signer's email/mobile no or organization email. ]
Email address or mobile of user
(Optional) Represents the overall signature verification configuration
(Optional) Represents the overall signature verification configuration
Determines whether to abort the signature attachment process if the conditions are not met for the associated signer. If false, it will continue to attach the signature.
➔ Specifies the maximum number of attempts allowed for the signature verification process for the associated signer.
Represents a collection of rules for the signature verification process.
⮕ [ Represents a collection of rules for the signature verification process. ]
➔ Specifies the logical operation (AND/OR) to be performed on the conditions within a rule
Represents a collection of conditions that must be satisfied for the associated rule.
⮕ [ Represents a collection of conditions that must be satisfied for the associated rule. ]
➔ Specifies the field to be checked in the condition.
➔ Specifies the type of matching to be performed on the field (e.g., exact, fuzzy).
Specifies the value to be compared against the field in the condition.
(Optional) Specifies the threshold value for fuzzy matching.
Specifies the value to be compared against the field in the condition
Fuzzy score representing the similarity in case of fuzzy matching. Null if not applicable
multi property rule
multi property rule
(Optional) Represents the overall signature conditional configuration
➔
Pass True if authentication link is required in response payload based on above customer’s identifier
Array of signer objects
⮕ [ Array of signer objects ]
Email address or mobile of user
➔ Signing reason for user from whom signature is requested
➔ 'aadhaar' : sign using aadhaar. [default] 'dsc' : sign using DSC 'electronic' : Screen pad based signature (slate signature)
➔ mode of signature, if sign_type is electronic
➔ Name of signer
Signer tag as mentioned in the template created over dashboard.
Additional sign features added upon document signing
⮕ [ Additional sign features added upon document signing ]
➔ geo_location: if geolocation is required
➔ geo location with address
➔ pass true if geo location is optional
➔ In multiparty signing, sequence outlines the order in which each involved party should sign the document.
Send direct signing link over email or sms. Default false.
Base 64 value of pdf doc
curl -X POST "https://api.digio.in/v2/client/document/uploadpdf" \
-H 'accept: application/json' Unique ID to identify documents provided by Digio. This has to be passed for directly landing on this document within the website
true/false
➔ 'outbound': Sent request to sign 'inbound': Received request to sign
➔ 'requested': pending signature from at least one signing party 'completed': all signing parties have signed 'expired': at least one signing party did n’t sign prior to request expiry
(Note: Documents that “expired” without any signature, and hasn’t been accessed in a month will be archived. Documents successfully signed archived after an year audit trail is available for downloading)
Name of the file as provided by you
'yyyy-mm-dd hh:mm:ss': Timestamp of Document upload in IST
true/false
➔ 'Aadhaar','Electronic','DSC'
➔
Array of signing parties
Name of the signing party
➔ 'requested': pending signature from user 'signed': signed by user 'expired': user did not sign prior to request expiry
➔ 'self': Requested from self 'org': Requested from an Organization and signatory not assigned 'signatory': Requested from an Organization and signatory has been assigned
➔ 'aadhaar': signed to be signed using aadhaar 'dsc': signed to be signed using dsc 'electronic' : signed using slate
➔ 'slate' 'slate_certified' 'otp' (can be viewed for electronic signature only)
Email or mobile of the signing party
Reason to sign the document
'yyyy-mm-dd hh:mm:ss': Timestamp of Sign Request expiry in IST, if set. Default: 10 days from requested_on
(Optional) Represents the overall signature verification configuration.
Overall result of the document validation. Possible values: "FAIL" or "PASS."
Array of rule results, each representing the outcome of an individual validation rule applied to the document.
⮕ [ Array of rule results, each representing the outcome of an individual validation rule applied to the document. ]
Unique identifier of the validation rule
Result of the validation rule. Possible values: "FAIL" or "PASS."
➔ Specifies the logical operation (AND/OR) to be performed on the conditions within a rule.
Represents a collection of conditions that must be satisfied for the associated rule.
⮕ [ Represents a collection of conditions that must be satisfied for the associated rule. ]
Specifies the field to be checked in the condition.
Type of matching being performed for the field in the condition. Possible values: "EXACT" or "FUZZY."
Actual value of the field being evaluated in the condition.
Expected value for the field being evaluated in the condition.
Fuzzy score representing the similarity in case of fuzzy matching. Null if not applicable
Result of the condition evaluation. Possible values: "FAIL" or "PASS."
If include_authentication_url was true in the request object then this object is populated.
Sign features added upon document signing
⮕ [ Sign features added upon document signing ]
➔
➔
➔ Either SEEDING | USER_INPUT
Flag indicating whether seeding is required or not
Existing User Name
Number of pages in document
Array of signing parties
⮕ [ Array of signing parties ]
Name of the signing party
➔ 'requested': pending signature from user 'signed': signed by user 'expired': user did not sign prior to request expiry
➔ 'self': Requested from self 'org': Requested from an Organization and signatory not assigned 'signatory': Requested from an Organization and signatory has been assigned
➔ 'aadhaar': signed to be signed using aadhaar 'dsc': signed to be signed using dsc 'electronic' : signed using slate
➔ 'slate' 'slate_certified' 'otp' (can be viewed for electronic signature only)
Email or mobile of the signing party
Reason to sign the document
'yyyy-mm-dd hh:mm:ss': Timestamp of Sign Request expiry in IST, if set. Default: 10 days from requested_on
(Optional) Represents the overall signature verification configuration.
Overall result of the document validation. Possible values: "FAIL" or "PASS."
Array of rule results, each representing the outcome of an individual validation rule applied to the document.
⮕ [ Array of rule results, each representing the outcome of an individual validation rule applied to the document. ]
Unique identifier of the validation rule
Result of the validation rule. Possible values: "FAIL" or "PASS."
➔ Specifies the logical operation (AND/OR) to be performed on the conditions within a rule.
Represents a collection of conditions that must be satisfied for the associated rule.
⮕ [ Represents a collection of conditions that must be satisfied for the associated rule. ]
Specifies the field to be checked in the condition.
Type of matching being performed for the field in the condition. Possible values: "EXACT" or "FUZZY."
Actual value of the field being evaluated in the condition.
Expected value for the field being evaluated in the condition.
Fuzzy score representing the similarity in case of fuzzy matching. Null if not applicable
Result of the condition evaluation. Possible values: "FAIL" or "PASS."
If include_authentication_url was true in the request object then this object is populated.
Sign features added upon document signing
⮕ [ Sign features added upon document signing ]
➔
➔
➔ Either SEEDING | USER_INPUT
Flag indicating whether seeding is required or not
Existing User Name
Organization name registered with Digio account
'yyyy-mm-dd hh:mm:ss': Timestamp of Sign Request origination in IST
'yyyy-mm-dd hh:mm:ss': Timestamp of Sign Request expiry in IST, if set. Default: 10 days from requested_on
Organization email address registered with Digio account
➔ org
➔ api
true/false
Only applicable while creating sign request when generate access token value is passes as “true”
Unique identifier of the parent entity the access token belongs to
Unique identifier referencing an access token
DateTime at which the access token expires. New token can be generated when expired with the access token generation API mentioned in the document.
'yyyy-mm-dd hh:mm:ss': Timestamp of generation
E Stamp Certificate ID consumed during document creation
E Stamp Certificate ID consumed during document creation
➔
➔
⮕ [ Additional sign features added upon document signing ]
➔ geo_location: if geolocation is required
➔ geo location with address
➔ pass true if geo location is optional
➔
➔
➔
Details of Estamps, Quantities to be consumed and other merge details like
Map of tag names and quantities to be attached. Tag names should be without spaces
Note : Do not pass any special character or space in E-stamp tag name. Available tag names can be checked on dashboard -> E-Stamping section
Map of tag names and quantities to be attached. Tag names should be without spaces Note : Do not pass any special character or space in E-stamp tag name. Available tag names can be checked on dashboard -> E-Stamping section
➔ note on estamp page
➔
➔
(Optional) Represents the overall signature verification configuration
Determines whether to abort the signature attachment process if the conditions are not met for the associated signer. If false, it will continue to attach the signature.
➔ Specifies the maximum number of attempts allowed for the signature verification process for the associated signer.
Represents a collection of rules for the signature verification process.
⮕ [ Represents a collection of rules for the signature verification process. ]
➔ Specifies the logical operation (AND/OR) to be performed on the conditions within a rule
Represents a collection of conditions that must be satisfied for the associated rule.
⮕ [ Represents a collection of conditions that must be satisfied for the associated rule. ]
➔ Specifies the field to be checked in the condition.
➔ Specifies the type of matching to be performed on the field (e.g., exact, fuzzy).
Specifies the value to be compared against the field in the condition.
(Optional) Specifies the threshold value for fuzzy matching.
Specifies the value to be compared against the field in the condition
Fuzzy score representing the similarity in case of fuzzy matching. Null if not applicable
multi property rule
multi property rule
(Optional) Represents the overall signature conditional configuration
➔
Details about the exception. Usually contains the exception id for reference.
Error code
Description of the error
Custom errors
Was this page helpful?