Skip to main content

Custom Response

The Custom Response allows you to include customized outputs alongside the default workflow response, offering flexibility to customize results based on specific needs while keeping the core response unchanged.

How to Setup​

1 Go to Workspace > Workflows, and click on the flow created for Custom Response. If you need understanding in creating a workflow, refer to the step-by-step guide here.

Make sure a preceding workflow is added and completed for the custom response to be fetched, as it can only be retrieved after the workflow is executed. For instance, Verify Aadhaar and Verify PAN are used here.

Note that, the custom response or result is triggered only when the preceding workflow(s) are fully executed.

2 Hover over the plus (+) symbol and select Workflow. From the list, click Custom Response to add it.

Custom Response

3 Click on the newly added workflow, then select the General tab to customize your preferences.

General

Manage General​

(*) Indicates an action to be mandatory.

NameDescription
Display Name*Set a name to the workflow for easy identification.
DescriptionSummarize the purpose and functionality of this workflow module.
EnableThis toggle is enabled by default. When enabled, the particular workflow module begins its execution. Conversely, if disabled, the workflow module remains inactive and won't proceed.
RuleThis determines the criteria for triggering the particular workflow module. When the selected rule is evaluated, and is satisfied, the workflow proceeds as provided. If not, the workflow will not be executed. Note: If no rules are set, the workflow defaults to its standard action without any rule. For more information about the rules, refer here.

4 Then, click on the Configs tab to set the necessary configurations.

Configs

Manage Configs​

(*) Indicates an action to be mandatory.

NameDescription
Custom Response Key*This is the key used to store the custom response data in the output. It serves as the field name in the response to identify your custom data (e.g., Docs_Key).
Custom Response Value*Provide the Custom Response Value. if multiple values are provided, they should be formatted in JSON, with each claim enclosed in "example": "${verify_aadhaar@state}". If only one value is being retrieved, it should be formatted as ${verify_aadhaar@state}. This ensures the data is accurately displayed based on the workflow configuration.

5 After you've configured everything needed, click on SAVE.

6 Proceed to attach the workflow to the relevant application for execution. Refer to the instructions on how to attach a workflow to an application here.

How it Works​

1 Launch Postman or your preferred API tool and execute the flow by configuring the suitable Method, URL, and Body settings. If you're seeking guidance on how to perform these actions, see here.

2 Upon initiating the API call, a verification request will be sent to your configured Verification Way settings.

3 Based on the request, execute the flow in an incognito browser and follow the prompts to complete the verification process.

4 Since Verify Aadhaar and Verify PAN are configured, begin by providing the Aadhaar number, and click on Submit.

Aadhaar

5 Continue with the PAN verification by providing the PAN number and click on Submit.

PAN

6 The verification process will be completed only if the entered data is valid.

Verification Completed

7 Here is a sample response for Custom Response:

{
   "requestId":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx",
   "workflow": "verification",
   "userId": "mark@gmail.com",
   "pan_number": "Exxxxxxxxx",
   "dob": "2000-11-30",
   "aadhaar_number": "40xxxxxxxx",
   "pan_verified_at": "1733304403",
   "aadhaar_verified_at": "1733304391",
   "state": "Tamil Nadu",
   "pan_verified": "true",
   "aadhaar_verified": "true",
   "Docs_Key": "{\n\"aadhaar_no\":\"40xxxxxxxx\",\n\"state\":\"Tamil Nadu\",\n\"dob\":\"2000-12-30\"\n}"
}