New Omni documentation is now available — policy-driven document verification and API reference. Explore Omni → · Custom Theme for KYC liveform: Learn more →
New Omni documentation is now available — policy-driven document verification and API reference. Explore Omni → · Custom Theme for KYC liveform: Learn more →
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.
Show QueryString Parameter table for ID check and Knowledge-Based
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.
auxidField
Yes
No
Must be encrypted. Used when auxiliary verification of identity information is required in addition to ID documents and selfie photos. Currently phoneNumber is implemented, see details below. Cannot be used simultaneously with selectedIssuingCountry and selectedIdType. This will be changed through future updates.
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.
allowedIdTypes
Yes
No
Must be encrypted. Can set to show ID card type. Refer to the value below each parameter.
allowedDocumentFields
Yes
No
Must be encrypted. Can set to show available field. Refer to the value below each parameter.
projectionId
Yes
Yes
Must be encrypted. Can apply a projection to exclude fields. ProjectionName cannot be used together.
projectionName
Yes
Yes
Must be encrypted. Can apply a projection to exclude fields. ProjectionId cannot be used together.
selectedIssuingCountry
Yes
Yes
Must be encrypted. By selecting, user can skip the selecting country page. allowedCountries and selectedIdType can be used together. Also, when allowedCountries is selected, countreis not in the allowedCountries cannot be used. Same countries in blacklistCountries cannot be used together.
selectedIdType
Yes
No
Must be encrypted. By selecting, user can skip the selecting Id type page. Must be used with selectedIssuingCountry. If selectedIdType is used alone, it will cause error. Also, using Universal mode and selectedIdType together will casue error; exceptional case: note that if the issuingCountryis KOR and Universal mode is on, selecting IdType page will be shown to users.
mainColor
Yes
Yes
Must be encrypted. Sets the primary color of CTA buttons and positive action UI elements. Value must be a 6-digit hex color code with # prefix (e.g., #AEFF00). See Custom Theme and Liveform Customization.
innerColor
Yes
Yes
Must be encrypted. Sets the inner text/icon color within CTA buttons and action elements. Value must be a 6-digit hex color code with # prefix (e.g., #FFFFFF). See Custom Theme and Liveform Customization.
startValidUntil
Yes
Yes
Must be encrypted. Specifies the expiration time before authentication begins in UTC+0 ISO 8601 format (e.g., 2026-04-30T15:00:00Z). If the user accesses the link after the specified time has passed, authentication is blocked and they are directed to the PV-40018 error page. Use this when you need to enforce “link entry within a set time period” such as guardian authentication for minors.
startValidUntil Behavior (2026-04)
Validation Priority: Evaluated before all other validations such as token ID validation. If start expiration is confirmed, subsequent validations are not performed.
Encryption Required: Cannot be used as plain text. Must be included in the encrypted parameter alongside other encryption options.
Timezone: Always interpreted as UTC+0. Example: {"startValidUntil":"2026-04-30T15:00:00Z"}.
Supported Pipelines: ID Document, Knowledge-based.
Expiration Behavior: Redirects to error page /error-page/expired-start-valid-until (error code PV-40018), displaying the message “The verification link has expired. Please try again with a new link.” to the user.
Show QueryString Parameter table for Knowledge-Based only
Parameter
ID Document
Knowledge-Based
Description
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.
skip
No
Yes
Must be encrypted. When selected, users can skip the user information collection process in Knowledge-Based and proceed to the next step where they take a selfie photo as configured in the dashboard. Cannot be used with other knowledgeField options.
The correct option should not have spaces after commas, like {'allowedDocumentFields': 'gender,name,date_of_birth,issue_date'}
Show Auxiliary ID Field in ID check
For identity information that requires verification in addition to ID documents and selfie information (e.g., phone numbers), you can collect and verify using the auxidField option.
[ID document] auxidField Parameter Values
phoneNumber SMS-based phone number verification
e.g. {'auxidField': 'phoneNumber'}
note that inside of encrypted should be encrypted; the above query is only for example
Caution:
Must be encrypted for use.
The parameter values above are case-sensitive. For example, if you write phonenumber, it will not work. You must write phoneNumber as shown above.
Cannot be used simultaneously with selectedIssuingCountry and selectedIdType. This will be changed through future updates.
Currently 91 countries do not support SMS verification.
Check Unsupported CountriesTo view the complete list of 91 countries where SMS verification for auxidField phoneNumber feature is not supported, please refer to the link below.📋 View SMS Verification Unsupported Countries List
skip : skip must be used alone and cannot be used with other knowledgeField options. e.g. {'knowledgeField': 'gender,nationality,name'}
e.g. {'knowledgeField': 'skip'} The parameter values above are case-sensitive. For example, birthdate will not work. You must write birthDate as shown above.
address Input the keyword address to search in Google Maps
phoneNumber Country code with phone number without hyphen(-)e.g. {'knowledgePrefill': 'gender=male,birthdate=1990-01-01,SSN=123-12-0001,address=Washington D.C.,phoneNumber=+15555551234'}For address, use keywords that can be searched in Google Maps. The prefilled value will appear in the address search field.
The correct option should not have spaces after commas, like: {'knowledgeField': 'gender,nationality,name'}
Show Only Selfie in Knowledge-Based
In Knowledge-Based, when you enter skip, users can skip the user information collection process and proceed to the next step. When configured, the country selection and user information input collection screens will be skipped.
e.g. {'knowledgeField': 'skip'}
USECASE: when you want to perform Face-based authentication without collecting additional information, you can implement this by enabling the Selfie process option in the dashboard and setting ‘skip’ in the ‘knowledgeField’.
Caution:
Cannot be used with other knowledgeField options besides skip.
However, it can be used together with the administrator-provided email, userid, cf1, cf2, and cf3.
You can enable the encrypted only option in the dashboard. After activation, URL query parameters only allow pid(project id), encrypted and lang(language), other parameters are not allowed.
https://form.argosidentity.com?pid={project_Id}&encrypted={encrypted_option}&email=your_email_address@argosidentity.com(X)email is not an allowed parameter, so access is denied.
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.
