Get Status APINEW

Get current status of the request by calling this API

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

Get Details API

post {BASE_URL}/client/kyc/v2/{id}/response

Get Current Status and Details for a DigiStudio Request

REQUEST

PATH PARAMETERS

* id

string

QUERY-STRING PARAMETERS

detail_response

boolean

API Server

https://api.digio.in

Authentication

Required (None Applied)

curl -X POST "https://api.digio.in/client/kyc/v2/{id}/response" \
 -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

action_ref

string

type

enum

➔

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

status

enum

➔

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

file_id

string

AdditionalFileIds

[string]

sub_file_id

string

execution_request_id

string

- face_match_result

object

match_result

enum

➔ Result from the FaceMatch Operation. "matched" if the confidence is greater than minimum threshold

Allowed: matched┃not_matched┃failed┃none

confidence

integer

Confidence score of similar the faces are!

- ocr_result

object

id_no

string

name

string

fathers_name

string

mothers_name

string

dob

string

year_of_birth

string

address

string

gender

string

id_type

enum

➔

Allowed: PAN┃FORM_60┃VOTER_ID┃AADHAAR┃EAADHAAR┃PASSPORT┃DRIVING_LICENSE┃CHEQUE┃VEHICLE_RC┃CIN┃DIN┃TAN┃TIN┃UAADHAAR┃FSSAI┃OTHER┃KRA_PAN┃E_STAMP┃GST┃PAN_ADVANCED┃IFSC┃UDYAMAADHAAR┃PAN_GST┃GST_ADVANCED┃CIN_ADVANCED┃BANK_STATEMENT

date_of_issue

string

date_of_expiry

string

encoded_image

string

encoded_signature

string

central_db_match_result

enum

➔

Allowed: matched┃not_matched┃error

central_db_lookup_details

string

file_no

string

bank_name

string

account_no

string

ifsc

string

- address_information

object

address

string

localityOrPostOffice

string

districtOrCity

string

state

string

pincode

string

- id_card_data_response

object

id_no

string

name

string

fathers_name

string

mothers_name

string

dob

string

year_of_birth

string

address

string

gender

string

id_type

enum

➔

date_of_issue

string

date_of_expiry

string

file_no

string

account_no

string

ifsc

string

status

string

city_jurisdiction

string

nature_of_business

string

registration_date

string

company_type

string

duty

string

state_jurisdiction

string

- address_information

object

address

string

localityOrPostOffice

string

districtOrCity

string

state

string

pincode

string

- additional_verification_response

object

companyCategory

string

emailId

string

classOfCompany

string

dateOfLastAgm

string

registeredAddress

string

registeredNumber

string

paidUpCapitalInRs

string

whetherListedOrNot

string

suspendedAtStockExchange

string

cin

string

companySubcategory

string

authorisedCapitalInRs

string

companyStatus_for_efiling

string

rocCode

string

dateOfBalanceSheet

string

dateOfIncorporation

string

companyName

string

activeCompliance

string

rdRegion

string

mainDivisionOfBusinessActivityToBeCarriedOutInIndia

string

previousFirmCompanyDetailsIfApplicable

string

llpin

string

numberOfDesignatedPartners

string

llpName

string

totalObligationOfContribution

string

llpStatus

string

descriptionOfMainDivision

string

numberOfPartners

string

llpStrikeOffAmalgamatedDate

string

statusUnderCirp

string

- balanceSheets

array of object

dateOfFiling

string

financialYear

string

- annualReturns

array of object

dateOfFiling

string

financialYear

string

- action_data

object

- sub_actions

array of object

string

type

enum

➔

Allowed: GEO_TAGGING┃FRAME_CAPTURE┃USER_INSTRUCTION┃AGENT_INSTRUCTION┃AGENT_COMMENTS┃USER_CONSENT┃QUESTIONNAIRE┃ASSISTANCE_INSTRUCTION┃EMAIL_VERIFICATION┃MOBILE_VERIFICATION┃ESTAMP_PROCUREMENT┃PLUGIN

status

enum

➔

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

file_id

string

sub_file_id

string

- details

object

- [any-key]

object

- ocr_result

object

id_no

string

name

string

fathers_name

string

mothers_name

string

dob

string

year_of_birth

string

address

string

gender

string

id_type

enum

➔

date_of_issue

string

date_of_expiry

string

encoded_image

string

encoded_signature

string

central_db_match_result

enum

➔

Allowed: matched┃not_matched┃error

central_db_lookup_details

string

file_no

string

bank_name

string

account_no

string

ifsc

string

- address_information

object

address

string

localityOrPostOffice

string

districtOrCity

string

state

string

pincode

string

title

string

sub_action_ref

string

description

string

optional

boolean

actioner

enum

➔

Allowed: USER┃AGENT

input_data

string

strict_validation_type

enum

➔

Allowed: pan┃voter_id┃aadhaar┃passport┃cheque┃signature┃driving_license┃vehicle_rc┃other_address_proof┃aadhaar_xml┃eaadhaar┃gst┃cin┃bank_statement

obj_analysis_status

enum

➔

Allowed: na┃new┃halted┃failed┃done

face_match_obj_type

enum

➔

Allowed: source┃match_required┃strict_match_required┃none

- face_match_result

object

match_result

enum

➔ Result from the FaceMatch Operation. "matched" if the confidence is greater than minimum threshold

Allowed: matched┃not_matched┃failed┃none

confidence

integer

Confidence score of similar the faces are!

face_match_status

enum

➔

Allowed: na┃new┃halted┃failed┃done

completed_at

date-time

- plugin_response

array of object

- [any-key]

object

- estamp_details

array of object

orderId

string

orderItemId

string

status

enum

➔

Allowed: new┃cancelled┃rejected_by_admin┃shared_with_seller┃approved_by_seller┃rejected_by_seller┃fulfilled_by_seller┃partially_successful┃successful┃delivered_physically┃partially_fulfilled_by_seller┃expired

documentId

string

stampId

string

- estampFileDetails

array of object

storeId

string

fileName

string

extension

enum

➔

Allowed: jpg┃jpeg┃png┃pdf

seqNo

integer

estampMasterId

string

esignDocumentId

string

ocrStatus

boolean

detectedEstampId

string

denominationInDigit

string

detectedIssueDate

string

detectedDocRef

string

expiringInDays

integer

procurementDate

string

state

string

amount

string

- validation_result

object

- fuzzy_match_responses

array of object

unique_id

string

source_ref

string

source_value

string

target_ref

string

target_value

string

match_score

integer

result

enum

➔

Allowed: matched┃not_matched┃failed┃none

external_result

enum

➔

Allowed: matched┃not_matched┃failed┃none

source_name

string

target_name

string

face_match_external_result

enum

➔

Allowed: matched┃not_matched┃failed┃none

- liveness_check_result

object

Results from the checks for the back part of the ID Card

score

number

Confidence of image being live or real/acceptable. Higher the better

result

enum

➔ Result for the validation check (UNKNOWN is from Gray-area where manual verification can be done if you don't want customers to reattempt). Ideally consider Unknown also as Fail and ask user to reattempt.

Allowed: PASS┃FAIL┃UNKNOWN

errors

[string]

In case there are errors, list of errors found in image
⮕ [ In case there are errors, list of errors found in image ]

count

integer

Count

- user_input_ocr_data_fuzzy_match

object

[any-key]

number

- validation_result

object

- [any-key]

object

completed_at

date-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┃audio_declaration

otp

string

- fund_collection_payment_details

object

payerVpa

string

payerAccountNumber

string

payerIfsc

string

payerAccountName

string

npciUpiTxnId

string

amount

string

payeeVa

string

payeeIfsc

string

payeeAccountNumber

string

payeeName

string

status

string

statusDescription

string

errorCode

string

paymentDate

string

settlementStatus

string

settlementId

string

processing_done

boolean

retry_count

integer

file_base64

string

subfile_base64

string

additional_file_ids

[string]

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”

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

workflow_name

string

Name of the workflow.

error_messages

[string]

auto_approved

boolean

States weather auto approved.

auditor_name

string

Name of the auditor

auditor_identifier

string

Unique identifier referencing auditor.

- additional_validations

array of object

type

enum

➔

Allowed: fuzzy_match

- validation_attributes

object

[any-key]

string

match_result

enum

➔

Allowed: matched┃not_matched┃failed┃none

confidence

number

- additional_plugin_invocations

object

- [any-key]

array of object

template_id

string

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

- auditor_actions

object

Actions performed by auditor

auditor_remarks

string

auditor_disposition

[string]

- upi_deeplink_info

object

Deep intent meta for reverse penny drop

deepIntentUrl

string

deepQrUrl

string

is_terminated

boolean

Indicates whether the request has been terminated