Create New RequestNEW

Digi Studio
Integration Steps
Create New Request

This creates a new request and optionally sends notifications to your users

To use this API, you need a workflow template created from DigiStudio. For more information, Contact Support

Create Request

post {BASE_URL}/client/kyc/v2/request/with_template

Request Body Params (application/json)

customer_identifier*string

Email/mobile phone number of the customer to which the KYC request is sent.

notify_customerboolean

If true, a notification is sent to the customer on their email/mobile phone. Recommendation: if using only SDK then pass false in notify_customer param

customer_notification_modeenum

Sends an SMS/Whatsapp notification if the identifier is mobile number

Allowed:

SMS

| WHATSAPP

| ALL

customer_namestring

Name of the customer. Max length: 100

reference_idstring

Customer reference number (underscore or alphanumeric string supported). If not passed, one will be auto generated by Digio

transaction_idstring

Unique identifier referring to transaction (underscore or alphanumeric string supported). If not passed, one will be auto generated by Digio

template_name*string

Name of KYC template created over dashboard to be used while creating the request.

preset_valuesobject

Can be used to prefill form feilds or digilocker linked attributes in the KYC flow

digilocker_document_attributesobject

Attributes using which additional documents can be fetched from digilocker(Not applicable for AADHAAR). E.g {"PAN":{"pan_number":"ABCDEF123","name":"Test name"}})

expire_in_daysinteger

Request Expiry in number of days => Default: 10 days, After expiry user will not be able to proceed

other_signersarray

estamp_request.tagsobject

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

estamp_request.note_contentstring

note on estamp page

estamp_request.note_on_pageenum

Allowed:

first

| last

| all

| custom

estamp_request.sign_on_pageenum

Allowed:

first

| last

| all

| custom

generate_access_tokenboolean

Default false, if you need an access token then pass this. If allowed for other input details, will receive an access_token object in response(For SDKs only).

rpd_config_idstring

Reverse Penny Drop Config ID

collection_amountstring

As Part of the Customer Onboarding Journey Clients can charge their customer. Amount to be charged can be configured here.

estamp_tagsobject

E Stamp Certificate ID consumed during document creation

generate_deeplink_infoboolean

Flag indicating whether to generate Deep link Info

Create a new request in DigiStudio from a standard or custom template

REQUEST

REQUEST BODY application/json

Field

Type

Description

customer_identifier *

string

Email/mobile phone number of the customer to which the KYC request is sent.

notify_customer

boolean

If true, a notification is sent to the customer on their email/mobile phone. Recommendation: if using only SDK then pass false in notify_customer param

customer_notification_mode

enum

➔ Sends an SMS/Whatsapp notification if the identifier is mobile number

Default: SMS

Allowed: SMS┃WHATSAPP┃ALL

customer_name

string

➔ Name of the customer. Max length: 100

Pattern: ^[0-9A-Za-z\s.]{0,}$

reference_id

string

➔ Customer reference number (underscore or alphanumeric string supported). If not passed, one will be auto generated by Digio

Pattern: ^[0-9A-Za-z\_\-\/]{0,}$

transaction_id

string

➔ Unique identifier referring to transaction (underscore or alphanumeric string supported). If not passed, one will be auto generated by Digio

Pattern: ^[0-9A-Za-z\_\-\/]{0,}$

template_name *

string

➔ Name of KYC template created over dashboard to be used while creating the request.

Constraints: 1 to 100 chars

Pattern: ^[^<>";=%!\*+?]*$

- preset_values

object

Can be used to prefill form feilds or digilocker linked attributes in the KYC flow

- digilocker_document_attributes

object

Attributes using which additional documents can be fetched from digilocker(Not applicable for AADHAAR). E.g {"PAN":{"pan_number":"ABCDEF123","name":"Test name"}})

- [any-key]

object

Attributes using which additional documents can be fetched from digilocker(Not applicable for AADHAAR). E.g {"PAN":{"pan_number":"ABCDEF123","name":"Test name"}})

[any-key]

string

Attributes using which additional documents can be fetched from digilocker(Not applicable for AADHAAR). E.g {"PAN":{"pan_number":"ABCDEF123","name":"Test name"}})

expire_in_days

integer

➔ Request Expiry in number of days => Default: 10 days, After expiry user will not be able to proceed

Constraints: Min 1┃Max 90

Default: 10

- other_signers

array of object

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

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

array of object

Additional sign features added upon document signing
⮕ [ Additional sign features added upon document signing ]

type *

enum

➔ geo_location: if geolocation is required

Allowed: geo_location

performEnrichment

boolean

➔ geo location with address

Default: false

optional

boolean

➔ pass true if geo location is optional

Default: false

- estamp_request

object

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

- tags

object

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

generate_access_token

boolean

Default false, if you need an access token then pass this. If allowed for other input details, will receive an access_token object in response(For SDKs only).

rpd_config_id

string

Reverse Penny Drop Config ID

collection_amount

string

As Part of the Customer Onboarding Journey Clients can charge their customer. Amount to be charged can be configured here.

- estamp_tags

object

E Stamp Certificate ID consumed during document creation

generate_deeplink_info

boolean

Flag indicating whether to generate Deep link Info

API Server

https://api.digio.in

Authentication

Required (None Applied)

curl -X POST "https://api.digio.in/client/kyc/v2/request/with_template" \
 -H 'accept: application/json'

RESPONSE

application/json

Field

Type

Description

string

Unique identifier referencing a request.

created_at

date-time

Time of creation of a request.

status

enum

➔ Status of the request. “requested” immediately post creation

Allowed: requested┃approval_pending┃approved┃rejected┃failed┃expired┃skipped

customer_identifier

string

Customer email/phone number as passed in the request.

- actions

array of object

LIST of details of steps configured in workflow along with approved/reject status
⮕ [ LIST of details of steps configured in workflow along with approved/reject status ]

string

step_request_id

string

Step Request ID

action_ref

string

Action Reference

type

enum

➔

Allowed: video┃image┃selfie┃aadhaar_offline┃two_way_video┃digilocker┃penny_drop┃generic┃document_flow┃fund_collection

status

enum

➔

Allowed: requested┃success┃approval_pending┃approved┃rejected┃failed┃expired┃skipped

file_id

string

file Id

sub_file_id

string

sub file Id

execution_request_id

string

equivalent to Digilocker request ID or Form request ID or reverse penny drop request ID

- validation_result

object

Result Obtained after validation

completed_at

date-time

Completion Time

face_match_obj_type

enum

➔

Allowed: source┃match_required┃strict_match_required┃none

face_match_status

enum

➔

Allowed: na┃new┃halted┃failed┃done

obj_analysis_status

enum

➔

Allowed: na┃new┃halted┃failed┃done

method

enum

➔

Allowed: otp_text┃otp_audio┃otp_none

otp

string

processing_done

boolean

Flag that identifies whether the processing of the request is done or not

retry_count

integer

Configurable rules that determines how many retries the request is allowed to do

reference_id

string

Internal reference ID as passed in the request.

- request_details

object

Data passed in the request that is displayed on the dashboard, usually to help an agent make a decision.

[any-key]

string

Data passed in the request that is displayed on the dashboard, usually to help an agent make a decision.

transaction_id

string

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

customer_name

string

The name of the customer

expire_in_days

integer

No. of days after which the KYC request will expire.

reminder_registered

boolean

States if there is any reminder registered.

- access_token

object

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

created_at

date-time

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

updated_at

date-time

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

entity_id

string

Unique identifier of the parent entity the access token belongs to

string

Unique identifier referencing an access token

valid_till

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.

workflow_name

string

Name of the workflow.

error_messages

[string]

error messages generated

auto_approved

boolean

A flag indicating that the file should automatically move on the Approved State or not

auditor_name

string

Name of the auditor

auditor_identifier

string

Unique identifier referencing auditor.

- additional_validations

array of object

Additional Validation Required

type

enum

➔

Allowed: fuzzy_match

- validation_attributes

object

Attributes required for validation

match_result

enum

➔

Allowed: matched┃not_matched┃failed┃none

confidence

number

Confidence below which the match fails

- additional_plugin_invocations

object

Plugin to be invoked upon KYC request reaching a particular status (can be configured by the client)

- [any-key]

array of object

template_id

string

Unique identifier for Workflow template created over dashboard (generated by Digio, e.g: KTP12345678)

- upi_deeplink_info

object

Deep intent meta for reverse penny drop

deepIntentUrl

string

Deep Intent Url

deepQrUrl

string

Deep QR Url