Lola Onboarding icon

Lola Onboarding

Lola Onboarding Node

Lola Onboarding

AI-generated

Overview

The Lola Onboarding node facilitates user onboarding and identity verification processes by generating onboarding or verification links for users. It interacts with a Lola server to create these links, supporting different operations such as enrollment, facematch enrollment, and verification, with optional proof-of-life checks. This node is useful in scenarios where you need to onboard new users, verify existing users' identities, or integrate biometric authentication into chat-based workflows (e.g., via Telegram, WhatsApp).

Practical examples:

  • Sending a user an onboarding link in a chat app to register their identity.
  • Verifying a user's identity before granting access to sensitive resources.
  • Enrolling users with additional security using facematch and liveness detection.

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 proof-of-life check:
- Liveness: Proof of life with liveness.
- Genuine Presence Assurance: Proof of life with Genuine Presence Assurance.
- None: No proof of life, just a selfie.
User ID User ID to be used for the onboarding. 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 (used only if "Enable Dev Params" is true). Required when enabled.

Output

The node outputs a JSON object in the first input item's json.lola_onboarding field:

  • 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

  • Lola Server: You must have access to a running Lola server. The server URL can be customized for development purposes.
  • API Key (optional): The node supports an optional credential named lolaKeyApi, but it is not required by default.
  • n8n Configuration: Ensure that any required credentials or environment variables for accessing the Lola server are set up if your deployment requires them.

Troubleshooting

Common issues:

  • Missing Required Fields: If required fields like User ID, Source ID, or Chat Identifier are missing, 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, the output will contain status: "error" and an error message.

Common error messages:

  • "status": "error", "error": "<error_message>": Indicates a problem occurred while generating the onboarding link. Check the error message for details (e.g., invalid parameters, server unavailable).
  • n8n's own NodeOperationError: Thrown if an unexpected exception occurs; review the error details for troubleshooting.

Links and References

  • n8n Documentation
  • Lola server documentation (refer to your organization's internal resources or the Lola API provider)

Discussion