Terms and Conditions
Terms and Conditions means to review and confirm that you understand and agree to the terms and conditions associated with a particular service, product, or agreement.
You have the ability to upload PDF documents (which can be downloaded if needed), a series of images, and links. Additionally, a text editor to allow you to provide your own content.
How to Setup
1 Go to Workspace > Workflows, and click on the flow created for Terms and Conditions. If you need understanding in creating a workflow, refer to the step-by-step guide here.
2 Hover over the plus (+) symbol and select Workflow. From the list, click Terms and Conditions to add it.
3 Click on the newly added workflow, then select the General tab to customize your preferences.
Manage General
(*) Indicates an action to be mandatory.
Name | Description |
---|---|
*Display Name | Set a name to the workflow for easy identification. |
Description | Summarize the purpose and functionality of this workflow module. |
Enable | This 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. |
Rule | This 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.
Manage Configs
(*) Indicates an action to be mandatory.
Name | Description |
---|---|
*Terms and conditions VersionTerms and conditions Version | Set the version of the Terms and Conditions to be displayed in HTML format (e.g., x.x.x). Note that each type configured must have a different version. Once created, the version and its type cannot be changed. |
*Type | Set the Terms and Conditions type; such as Link, PDF, Image, Text. |
Each type has its own set of configurations and provide respective response
- Link
- Image
- Text
When Link
is configured as the type, you will be redirected to view the respective terms and conditions via the provided link.
In the Terms and Condition Link
field, provide the URL to be redirected to the terms and conditions.
When PDF
is configured as the type, a PDF containing the respective terms and conditions will be displayed.
In the Terms and Condition Link
field, upload the PDF to be displayed, with a maximum file size of 5 MB.
When Image
is configured as the type, an image containing the respective terms and conditions will be displayed as a PDF file.
In the Terms and Condition Link
field, upload images with a maximum file size of 5MB. Note that SVG files are not supported.
When Text
is configured as the type, the terms and conditions will be displayed as text content.
In the Terms and Condition Link
field, click on the ADD
button to open the text editor
Provide the text with the necessary formatting, and then click on the SAVE
button.
5 After you've configured everything needed, click on SAVE.
6 Proceed to attach the workflow to the relevant application for execution. Refer to 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 The verification page will vary based on the Type chosen for Terms and Conditions.
On clicking Decline, the verification will be failed.
- Link
- Image
- Text
If you have configured Link
as the terms and conditions type, the following will be displayed.
To view the content in a new tab, click on the link icon. Once done reviewing, check the consent box and click on the Accept
button.
If you have configured PDF
as the terms and conditions type, the following will be displayed.
To view the content in a new tab, click on the link icon. Once done reviewing, check the consent box and click on the Accept
button.
If you have configured Image
as the terms and conditions type, the following will be displayed.
To view the content in a new tab, click on the link icon. Once done reviewing, check the consent box and click on the Accept
button.
If you have configured Text
as the terms and conditions type, the following will be displayed.
Once done reviewing, check the consent box and click on the Accept
button.
5 The verification process will be completed.
If "force onboarding" is enabled in the API request, all users, regardless of status, will be directed to the onboarding flow first, followed by the verification flow if configured.
6 The response can differ depending on the chosen Verification Way and Notification Way configurations. To know more, see here.
7 Here is a sample response for Terms and Condition:
{
"workflow": "verification",
"user_id": "mark@gmail.com",
"request_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx",
"terms_and_conditions_accepted_at": "1719569072",
"terms_and_conditions_version": "x.x.x"
}