Lola OnboardingInstall

Overview

The Lola Onboarding node facilitates user onboarding and identity verification processes by generating onboarding links for users. It supports operations such as enrolling new users, verifying existing users, and enrolling with facematch (using a reference image). The node is typically used in workflows where you need to initiate or manage biometric-based onboarding or verification, often integrated with chat platforms (e.g., Telegram, WhatsApp) or custom web applications.

Practical examples:

• Sending a user an onboarding link via chat to complete their registration with biometric verification.
• Verifying the identity of a returning user before granting access to sensitive resources.
• Enrolling a user with additional facematch security using a provided reference image.

Properties

Name	Meaning
Operation	Selects the action to perform: - Verify: Verify a registered user identity based on enrollment biometric data - Enrollment: Enroll a new user - Enrollment with Facematch: Enroll a new user with a reference image for facematch
Proof of Life	Specifies the type of liveness check: - Liveness: Proof of life with liveness - Genuine Presence Assurance: Stronger proof of life - None: No proof of life, just a selfie
User ID	User ID to be used for the onboarding process (required).
Source ID	The source ID to send to Lola Agent (e.g., telegram, whatsapp, etc.) (required).
Chat Identifier	A chat identifier to identify the chat session (required).
Message Identifier	A message identifier to track the message.
Return URL	The URL to redirect the user to after the onboarding process is completed; can be a web page or a deeplink.
Enable Dev Params	Whether to enable developer parameters. If enabled, allows specifying a custom Lola Server URL.
Lola Server URL	The URL of the Lola server (required if "Enable Dev Params" is true); e.g., http://localhost:3000 or an ngrok URL.
Theme of Iprov	The theme of the onboarding process (e.g., "default", "dark", "light", etc.) (required).

Output

The node outputs a JSON object under the key lola_onboarding:

• On success:

  {
    "lola_onboarding": {
      "url": "<onboarding_link_url>",
      "status": "success"
    }
  }
  

• On error:

  {
    "lola_onboarding": {
      "status": "error",
      "error": "<error_message>"
    }
  }
  

No binary data is output by this node.

Dependencies

• External Service: Requires access to a Lola server (URL specified in "Lola Server URL" when dev params are enabled).
• API Key: May require lolaKeyApi credentials depending on your Lola server configuration.
• n8n Configuration: Ensure network access to the Lola server from your n8n instance.

Troubleshooting

Common Issues:

• Missing Required Fields: If required fields like User ID, Source ID, or Chat Identifier are not provided, the node may fail to generate the onboarding link.
• Invalid Lola Server URL: If the Lola server URL is incorrect or unreachable, onboarding link generation will fail.
• Error in Response: If the Lola server returns an error, it will appear in the lola_onboarding.error field.

Common Error Messages:

• "status": "error", "error": "<error_message>": Indicates a problem occurred during onboarding link generation. Check the error message for details (e.g., invalid parameters, server issues).

How to resolve:

• Double-check all required input properties.
• Ensure the Lola server is running and accessible at the specified URL.
• Review the error message for hints about missing or invalid data.

Links and References

• n8n Documentation
• For more information about Lola onboarding, refer to your Lola server's API documentation or contact your system administrator.