Query String and Token Guide
A comprehensive guide to the Query String and Token ID options for Liveform. These options enable features such as transmitting additional information, preventing duplicate submissions, and identifying users. Explore essential tools to optimize your ID Check process.
1. Customizable Query String Options
The Query String options available in Liveform and API allow you to send additional information and customize the KYC process.
2. Basic URL Structure
- Base Form URL:
https://form.argosidentity.com/?pid={project_Id} - URL with Query String:
https://form.argosidentity.com/?pid={project_Id}&blacklistCountries=false
2-1. Key Query String Parameters
| Parameter | ID Document | Knowledge-Based | Description |
|---|---|---|---|
blacklistCountries | Yes | Yes | Turns off blacklist country restrictions for the specific submission (false only). |
approvePeriod | Yes | No | Turns off the approved duplicate submission prevention period (false only). |
rejectPeriod | Yes | No | Turns off the rejected duplicate submission prevention period (false only). |
ageLimit | Yes | Yes | Turns off age restriction for the specific submission (false only). |
rejectDuplicateUser | Yes | Yes | Enables/disables duplicate submission prevention (true or false accepted). - In Knowledge-Based Submission, it works to contain Name, Gender, Birth Date, and Nationality information. |
email | Yes | Yes | User’s email address. |
userid | Yes | Yes | Custom unique identifier for the user. |
pid | Yes | Yes | Unique identifier for each project. |
sid | Yes | Yes | Unique identifier for each submission. |
cf1 | Yes | Yes | Custom option field #1. |
cf2 | Yes | Yes | Custom option field #2. |
cf3 | Yes | Yes | Custom option field #3. |
allowedCountries | Yes | Yes | Must be encrypted. allowedCountries can only be set using the encryption option and cannot be specified directly. e.g., If the encrypted value {'allowedCountries': 'USA,KOR'} is provided, only the United States (USA) and South Korea (KOR) will be allowed. |
knowledgeField | No | Yes | Must be encrypted. Set visible fields from the supported fields. Refer to the value below each parameter. |
knowledgePrefill | No | Yes | Must be encrypted. Fill out the value in advance. Refer to the value below each parameter. |
2-1-a. Knowledge-Based Parameter Values
2-1-b. Skip to Select Country in Knowledge-Based
In Knowledge-Based, if allowedCountries set one nationality.
e.g. {'allowedCountries': 'USA'} The form skips to the select country page.
All Query String values must be URL-encoded.
Below is an example of ID Check with and without an email query parameter.
2-2. Unique User ID and Custom Fields
- Generate a unique user ID for KYC submitter identification during API calls.
- Add up to three custom fields (
cf1,cf2,cf3) to transmit additional information.
3. Token ID Options
The tokenId is a string used for Liveform submissions in Private Mode.
Purpose: Prevent shared or duplicate use of the same URL.
3-1. Token Validation
Validation fails (error occurs) under the following conditions:
- Time Expiry: More than 3 minutes have elapsed since the first use.
- Existing Valid Submission: There is an existing submission with a determined KYC status (approved, rejected, pending).
Caution:
If the above conditions are not met, multiple users may proceed with the same Token ID simultaneously.
3-2. Methods to Check Token ID
- Webhook
- GET Submission API (single retrieval using
submission_id) - Download Submission CSV from the dashboard
3-3. URL Structure for Token ID
- Base Form URL:
https://form.argosidentity.com/?pid={project_Id} - URL with Token ID:
https://form.argosidentity.com/?pid={project_Id}&token={tokenId}
By using this guide, you can effectively leverage Query String and Token ID options in ID Check to optimize your KYC process and enhance user experience.
Was this page helpful?