Numi Register icon

Numi Register

Numi Register Node
Join our community

Overview

The Numi Register node is designed to register or update user profiles with the Numi service. It supports two operations: "Level 1" registration, which collects detailed user information to create a new profile, and "Level 2", which upgrades an existing user's level based on their phone number. This node is useful in onboarding workflows, KYC (Know Your Customer) processes, or any automation where user registration and verification are required.

Example scenarios:

  • Automating user sign-up for a fintech application.
  • Collecting and verifying user details for compliance purposes.
  • Upgrading user access levels after additional verification steps.

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 (required for Level 1).
Middle Name The user's middle name (optional, Level 1 only).
Last Name The user's last name (required for Level 1).
Last Name 2 An additional last name (optional, Level 1 only).
Email The user's email address (optional, Level 1 only).
Phone Number The user's phone number (required for both Level 1 and Level 2).
Date of Birth The user's date of birth in YYYY-MM-DD format (optional, Level 1 only).
Birth State The state where the user was born (optional, Level 1 only).
Address The user's primary address (required for Level 1).
Address 2 Additional address information (optional, Level 1 only).
Country Code The user's country code (required for Level 1).
State The user's state (required for Level 1).
City The user's city (required for Level 1).
Zip Code The user's zip code (required for Level 1).

Output

The node outputs a JSON object with a field indicating the result of the registration:

{
  "new_profile": {
    "registered": true // or false
  }
}
  • If registration or upgrade is successful, registered will be true.
  • If unsuccessful, registered will be false.

No binary data is output by this node.

Dependencies

  • External Service: Requires access to the Numi partner API via the PartnerServiceFactory.
  • API Key: Needs n8n credentials named numiKeyApi to authenticate requests.

Troubleshooting

Common issues:

  • Missing Required Fields: If required fields (e.g., First Name, Last Name, Phone Number, etc.) are not provided for Level 1, the node may fail or the registration will not succeed.
  • Invalid Data Format: Incorrect formats (e.g., invalid date in Date of Birth) can cause errors.
  • Authentication Errors: If the numiKeyApi credential is missing or incorrect, the node will not be able to communicate with the Numi service.
  • API Failures: If the external Numi service is down or returns an error, registration will fail and registered will be false.

Error messages:

  • Errors related to missing parameters or failed API calls will typically result in registered: false in the output. Check the input data and credentials if you encounter this.

Links and References

  • n8n Documentation
  • For more about Numi's API, refer to your organization's internal documentation or contact Numi support.

Discussion