Query parameters

The Client Portal accepts query parameters that pre-fill a form and map it to data you already hold.

Base URL structure

The general structure for a form URL is: https://client-portal.dotfile.com/[ClientPortal_ID]/forms

Replace [ClientPortal_ID] with the ID of the Client Portal you are linking to. To use several parameters, combine them with &.

Parameters for any portal

• externalId: your own ID, used to map a Dotfile case to your data. If it is set and a case already exists, the contact is redirected to the checks section.
  Usage: externalId=[YOUR_EXTERNAL_ID]
  Example: externalId=USER12345 or externalId=CASE_9876
• lng: overrides the language.
  Usage: lng=[LANGUAGE_CODE]
  Example: lng=fr for French, lng=es for Spanish. Use the two-letter language code.

The remaining parameters pre-fill form fields, and which ones apply depends on whether the portal is KYC or KYB.

KYC flow

• email: sets the applicant of the onboarding flow. This is the contact who receives the recollection email.
• firstName: pre-fills the first name.
• lastName: pre-fills the last name.

KYB flow

• companyName: pre-fills the name of the company.
• registrationNumber: pre-fills the registration number of the company.
• country: pre-fills the country of registration of the company.

Example

To pre-fill the external ID as ABC987 and set the language to French on a given form, the URL looks like this:

https://client-portal.dotfile.com/[ClientPortal_ID]/forms?externalId=ABC987&lng=fr