Overview
The Numi Register node is designed to register or update user profiles with the Numi service, supporting two levels of registration: Level 1 (detailed profile creation) and Level 2 (profile upgrade). This node is useful in workflows where you need to onboard users, collect their personal information, and manage their registration status with an external partner system.
Common scenarios:
- Automating user onboarding processes by collecting and submitting user details.
- Upgrading existing user profiles to a higher verification level.
- Integrating user registration into larger business automation flows.
Practical example:
A company uses this node to automatically register new customers in the Numi system after they sign up on their website, ensuring all required data is collected and stored.
Properties
| Name | Meaning |
|---|---|
| Operation | Selects the type of registration: - Level 1: Register Level 1 - Level 2: Register Level 2 |
| First Name | The user's first name for profile creation. (Required for Level 1) |
| Middle Name | The user's middle name for profile creation. (Level 1 only) |
| Last Name | The user's last name for profile creation. (Required for Level 1) |
| Last Name 2 | An additional last name for profile creation. (Level 1 only) |
| The user's email address for profile creation. (Level 1 only) | |
| Phone Number | The user's phone number for profile creation. (Required) |
| Date of Birth | The user's date of birth (format: YYYY-MM-DD) for profile creation. (Level 1 only) |
| Birth State | The user's state of birth for profile creation. (Level 1 only) |
| Address | The user's primary address for profile creation. (Required for Level 1) |
| Address 2 | The user's secondary address for profile creation. (Level 1 only) |
| Country Code | The user's country code for profile creation. (Required for Level 1) |
| State | The user's state for profile creation. (Required for Level 1) |
| City | The user's city for profile creation. (Required for Level 1) |
| Zip Code | The user's zip code for profile creation. (Required for Level 1) |
Note: Most fields are only required or visible when "Operation" is set to "Level 1".
Output
The node outputs the input data with an added field in the json object:
{
"new_profile": {
"registered": true // or false
}
}
- new_profile.registered: Indicates whether the registration or upgrade was successful (
true) or not (false).
No binary data is produced by this node.
Dependencies
- External Service: Requires access to the Numi partner API via the
PartnerServiceFactory. - Credentials: Needs a credential named
numiKeyApiconfigured in n8n for authentication.
Troubleshooting
Common issues:
- Missing Required Fields: If required fields (e.g., First Name, Last Name, Phone Number) are not provided, the node may fail or the registration will be unsuccessful.
- Invalid Data Format: Incorrect formats (e.g., invalid date in "Date of Birth") can cause errors.
- API Credential Issues: If the
numiKeyApicredential is missing or incorrect, the node will not be able to communicate with the Numi service.
Error messages and resolutions:
- "Cannot read property 'userId' of undefined" — This may occur if the API response does not contain the expected data. Check your credentials and input values.
- "Missing required parameter..." — Ensure all required fields for the selected operation are filled.
Links and References
- n8n Documentation: Credentials
- n8n Documentation: Custom Nodes
- For more about the Numi service, refer to your organization's internal documentation or contact your Numi integration support.