Get Forms Data Request DetailsNEW

Digi Forms
API Integration
Get Forms Data Request Details

Call this API to get Forms Data Request Details

Note : Copy the CURL only after filling the input parameters

For API Base URL's, click here. Kindly append the Base URL to the API endpoints below to integrate

Get Forms Data Request Details API

get {BASE_URL}/client/form/{id}/response

Call this API to Get Forms Data Request Details API

REQUEST

PATH PARAMETERS

* id

string

Unique identifier referencing a request

API Server

https://api.digio.in

Authentication

Not Required

curl -X GET "https://api.digio.in/client/form/{id}/response" \
 -H 'accept: application/json'

RESPONSE

application/json

Field

Type

Description

string

Unique identifier referencing a request.

customerIdentifier

string

Customer email/phone number as passed in the request.

formId

string

Unique identifier referring to form template to be used while creating the request.

referenceId

string

Internal reference ID as passed in the request

transactionId

string

As passed in the request. Generated by the system and returned if not passed.

notifyCustomer

boolean

f true, a notification is sent to the customer on their email/mobile phone.

expireInDays

integer

Default: 10 days

status

enum

➔ requested immediately post creation.

Allowed: REQUESTED┃SENT_FOR_SIGNING┃COMPLETED┃REJECTED┃EXPIRED┃IN_PROGRESS

title

string

Name of the form Template

description

string

Description of the form Template

- properties

object

Detailed properties of the form

[any-key]

string

Detailed properties of the form

- fileProperties

object

Detailed properties of the file

[any-key]

string

Detailed properties of the file

- document

object

string

Unique ID to identify documents provided by Digio. This has to be passed for directly landing on this document within the website

is_agreement

boolean

true/false

agreement_type

enum

➔ 'outbound': Sent request to sign 'inbound': Received request to sign

Allowed: inbound┃outbound

agreement_status

enum

➔ '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)

Allowed: draft┃requested┃completed┃expired┃failed

file_name

string

Name of the file as provided by you

created_at

date-time

'yyyy-mm-dd hh:mm:ss': Timestamp of Document upload in IST

self_signed

boolean

true/false

self_sign_type

enum

➔ 'Aadhaar','Electronic','DSC'

Allowed: dsc┃aadhaar┃external┃external_sign┃aadhaar_with_dependents┃electronic_with_dependents┃electronic┃document_review

self_sign_mode

enum

➔

Allowed: otp┃slate┃kyc┃otp_certified┃slate_certified┃esign_3┃esign_3s┃nesl_aadhaar_sign

- self_details

object

Array of signing parties

name

string

Name of the signing party

status

enum

➔ 'requested': pending signature from user 'signed': signed by user 'expired': user did not sign prior to request expiry

Allowed: requested┃signed┃expired┃sequenced┃cancelled┃removed┃failed┃skipped

type

enum

➔ 'self': Requested from self 'org': Requested from an Organization and signatory not assigned 'signatory': Requested from an Organization and signatory has been assigned

Allowed: self┃org┃signatory

signature_type

enum

➔ 'aadhaar': signed to be signed using aadhaar 'dsc': signed to be signed using dsc 'electronic' : signed using slate

Allowed: dsc┃aadhaar┃external┃external_sign┃aadhaar_with_dependents┃electronic_with_dependents┃electronic┃document_review

signature_mode

enum

➔ 'slate' 'slate_certified' 'otp' (can be viewed for electronic signature only)

Allowed: otp┃slate┃kyc┃otp_certified┃slate_certified┃esign_3┃esign_3s┃nesl_aadhaar_sign

identifier

string

Email or mobile of the signing party

reason

string

Reason to sign the document

expire_on

date-time

'yyyy-mm-dd hh:mm:ss': Timestamp of Sign Request expiry in IST, if set. Default: 10 days from requested_on

- signature_verification_response

object

(Optional) Represents the overall signature verification configuration.

overallResult

string

Overall result of the document validation. Possible values: "FAIL" or "PASS."

- ruleResults

array of object

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. ]

ruleId

integer

Unique identifier of the validation rule

result

string

Result of the validation rule. Possible values: "FAIL" or "PASS."

operation

enum

➔ Specifies the logical operation (AND/OR) to be performed on the conditions within a rule.

Allowed: AND┃OR

- conditions

array of object

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. ]

field

string

Specifies the field to be checked in the condition.

match

string

Type of matching being performed for the field in the condition. Possible values: "EXACT" or "FUZZY."

actualValue

string

Actual value of the field being evaluated in the condition.

expectedValue

string

Expected value for the field being evaluated in the condition.

fuzzyScore

integer

Fuzzy score representing the similarity in case of fuzzy matching. Null if not applicable

result

string

Result of the condition evaluation. Possible values: "FAIL" or "PASS."

aadhaar_mode

string

authentication_url

string

If include_authentication_url was true in the request object then this object is populated.

- signing_features

array of object

Sign features added upon document signing
⮕ [ Sign features added upon document signing ]

featureId

string

result

string

type

enum

➔

Allowed: geo_location┃consent

status

enum

➔

Allowed: requested┃success┃skipped

optional

boolean

performEnrichment

boolean

seed_method

enum

➔ Either SEEDING | USER_INPUT

Allowed: seeding┃user_input

seeding_required

boolean

Flag indicating whether seeding is required or not

existing_user_name

string

Existing User Name

no_of_pages

integer

Number of pages in document

- signing_parties

array of object

Array of signing parties
⮕ [ Array of signing parties ]

name

string

Name of the signing party

status

enum

➔ 'requested': pending signature from user 'signed': signed by user 'expired': user did not sign prior to request expiry

Allowed: requested┃signed┃expired┃sequenced┃cancelled┃removed┃failed┃skipped

type

enum

➔ 'self': Requested from self 'org': Requested from an Organization and signatory not assigned 'signatory': Requested from an Organization and signatory has been assigned

Allowed: self┃org┃signatory

signature_type

enum

➔ 'aadhaar': signed to be signed using aadhaar 'dsc': signed to be signed using dsc 'electronic' : signed using slate

Allowed: dsc┃aadhaar┃external┃external_sign┃aadhaar_with_dependents┃electronic_with_dependents┃electronic┃document_review

signature_mode

enum

➔ 'slate' 'slate_certified' 'otp' (can be viewed for electronic signature only)

Allowed: otp┃slate┃kyc┃otp_certified┃slate_certified┃esign_3┃esign_3s┃nesl_aadhaar_sign

identifier

string

Email or mobile of the signing party

reason

string

Reason to sign the document

expire_on

date-time

'yyyy-mm-dd hh:mm:ss': Timestamp of Sign Request expiry in IST, if set. Default: 10 days from requested_on

- signature_verification_response

object

(Optional) Represents the overall signature verification configuration.

overallResult

string

Overall result of the document validation. Possible values: "FAIL" or "PASS."

- ruleResults

array of object

ruleId

integer

Unique identifier of the validation rule

result

string

Result of the validation rule. Possible values: "FAIL" or "PASS."

operation

enum

➔ Specifies the logical operation (AND/OR) to be performed on the conditions within a rule.

Allowed: AND┃OR

- conditions

array of object

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. ]

field

string

Specifies the field to be checked in the condition.

match

string

Type of matching being performed for the field in the condition. Possible values: "EXACT" or "FUZZY."

actualValue

string

Actual value of the field being evaluated in the condition.

expectedValue

string

Expected value for the field being evaluated in the condition.

fuzzyScore

integer

Fuzzy score representing the similarity in case of fuzzy matching. Null if not applicable

result

string

Result of the condition evaluation. Possible values: "FAIL" or "PASS."

aadhaar_mode

string

authentication_url

string

If include_authentication_url was true in the request object then this object is populated.

- signing_features

array of object

Sign features added upon document signing
⮕ [ Sign features added upon document signing ]

featureId

string

result

string

type

enum

➔

Allowed: geo_location┃consent

status

enum

➔

Allowed: requested┃success┃skipped

optional

boolean

performEnrichment

boolean

seed_method

enum

➔ Either SEEDING | USER_INPUT

Allowed: seeding┃user_input

seeding_required

boolean

Flag indicating whether seeding is required or not

existing_user_name

string

Existing User Name

- sign_request_details

object

name

string

Organization name registered with Digio account

requested_on

date-time

'yyyy-mm-dd hh:mm:ss': Timestamp of Sign Request origination in IST

expire_on

date-time

'yyyy-mm-dd hh:mm:ss': Timestamp of Sign Request expiry in IST, if set. Default: 10 days from requested_on

identifier

string

Organization email address registered with Digio account

requester_type

enum

➔ org

Allowed: individual┃org

channel

enum

➔ api

Allowed: web┃android┃ios┃windows┃android_partner┃api┃android_sdk

cancel_reason

string

require_full_document_review

boolean

- other_doc_details

object

web_hook_available

boolean

true/false

- access_token

object

Only applicable while creating sign request when generate access token value is passes as “true”

entityId

string

Unique identifier of the parent entity the access token belongs to

string

Unique identifier referencing an access token

validTill

date-time

DateTime at which the access token expires. New token can be generated when expired with the access token generation API mentioned in the document.

createdAt

date-time

'yyyy-mm-dd hh:mm:ss': Timestamp of generation

- attached_estamp_details

object

E Stamp Certificate ID consumed during document creation

[any-key]

[string]

E Stamp Certificate ID consumed during document creation

- document_additional_info

object

string

docId

string

subUserId

string

postSigningReceivers

string

- draft

object

file_name

string

- signers

array of object

- signer

object

name

string

identifier

string

reminder

[integer]

signType

enum

➔

Allowed: dsc┃aadhaar┃external┃external_sign┃aadhaar_with_dependents┃electronic_with_dependents┃electronic┃document_review

signatureMode

enum

➔

Allowed: otp┃slate┃kyc┃otp_certified┃slate_certified┃esign_3┃esign_3s┃nesl_aadhaar_sign

optional

boolean

- signing_addons

array of object

⮕ [ 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

expiredInDays

integer

preferredSeedMethod

enum

➔

Allowed: seeding┃user_input

- coords

object

- [any-key]

array of object

llx

integer

lly

integer

urx

integer

ury

integer

post_signing_receivers

[string]

customer_notification_mode

enum

➔

Allowed: SMS┃WHATSAPP┃ALL┃EMAIL

sequential

boolean

comment

string

send_sign_link

boolean

display_on_page

enum

➔

Allowed: first┃last┃all┃custom

notify_signers

boolean

- estamp_request

object

Details of Estamps, Quantities to be consumed and other merge details like

- tags

object

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

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

- signature_verification

object

- [any-key]

object

(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*

array of object

Represents a collection of rules for the signature verification process.
⮕ [ 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*

array of object

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. ]

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

object

multi property rule

[any-key]

[string]

multi property rule

- signing_condition_request

object

(Optional) Represents the overall signature conditional configuration

- conditions

array of object

- signingCondition

array of object

type

enum

➔

Allowed: AT_LEAST_N_ACTIONERS┃REQUIRED_UNITS

- signers

array of object

signingPartyId

string

identifier

string

name

string

signingStatus

string

signedAt

string

identifiers

[string]

value

integer

conditionPassed

boolean

reference_id

string

createdAt

date-time

updatedAt

date-time

- pdfMetaData

object

- pageMetaData

object

- [any-key]

object

width

number

height

number

consents

[string]

createdAt

date-time

DateTime of request creation.

updatedAt

date-time

DateTime of request updation.

- accessToken

object

Only applicable while creating sign request when generate access token value is passes as “true”

entityId

string

Unique identifier of the parent entity the access token belongs to

string

Unique identifier referencing an access token

validTill

date-time

DateTime at which the access token expires. New token can be generated when expired with the access token generation API mentioned in the document.

createdAt

date-time

'yyyy-mm-dd hh:mm:ss': Timestamp of generation

- pluginResponse

array of object

Contains Plugin Details like :- plugin_id , plugin_name , status
⮕ [ Contains Plugin Details like :- plugin_id , plugin_name , status ]

- [any-key]

object

Contains Plugin Details like :- plugin_id , plugin_name , status

authenticationUrl

string

Provides Link for Authentication