When navigating to /portal/create, URL-parameters can be used to pre-fill the form.

Format

Please use standard URL GET-parameters and URL-encoded characters.

Parameters

The following parameters are taken into account.

• gender

  Possible values: “male” and “female”

• firstname

• lastname

• name

  This is meant to be the neutral name when neutral check recipient (e.g. companies) is chosen. If you only add the parameter name and neither firstname nor lastname, then the recipient type is automatically set to neutral.

• email

  If you only set the email parameter and not the sms parameter, then the send type is automatically set to email.

• mobile

  If you only set the mobile parameter and not the email parameter, then the send type is automatically set to sms.

• subject

• notes

• language

  Only provide a language that is supported by flixcheck (de-DE, en-GB, it-IT, fr-FR)

• customValues

  Provide a URL-encoded, JSON-stringified version of the customValues-object. All information about that object can be found in the API documentation at section PostCreateCheck > customValues. Example:

  [
      {
          "identifier": "client_number",
          "label": "Client Number",
          "value": "193750189"
      }
  ]
  

  will become

  %5B%7B%22identifier%22%3A%22client_number%22%2C%22label%22%3A%22Client%20Number%22%2C%22value%22%3A%22193750189%22%7D%5D

• customValuesOverwrite

  Provide a URL-encoded, JSON-stringified partial version of an existing customValues-object.

  The identifier or label needs to match an existing customValue.

  [
      {
          "identifier": "client_number",
          "value": "newValue"
      }
  ]
  

  will become

  %5B%7B%22identifier%22%3A%20%22client_number%22%2C%22value%22%3A%20%22newValue%22%7D%5D

• templateId

  Provide the ID of a template of the currently logged in account or of a template that is shared with the currently logged in account. The template will be fetched and set. The rest of the parameters will be applied afterwards.

• mode

  If set to message and the simple message plugin is active, then the create page automatically switches to “Create simple message”

• sendBy Possible values are sms and email. If set, the toggle will be pre-set to the corresponding channel.

Example