CrunchzApp icon

CrunchzApp

Interact with CrunchzApp API
Join our community

Actions22

Overview

This node interacts with the CrunchzApp API to request a One-Time Password (OTP) code for a specified contact. It allows users to customize the OTP code's characteristics such as length, character composition (letters and/or numbers), capitalization, and expiration time. This is useful in scenarios where secure verification or authentication is needed, for example:

  • Sending an OTP to a user’s phone number for two-factor authentication.
  • Generating temporary access codes for password resets or account verification.
  • Customizing OTP format to meet specific security policies.

Properties

Name Meaning
Length The length of the OTP code to generate.
Use Letter Whether to include letters in the OTP code (true/false).
Use Number Whether to include numbers in the OTP code (true/false).
All Capital Whether all characters in the OTP code should be uppercase (true/false).
Name The name of the entity requesting the OTP (e.g., application or service name).
Expires Expiration time of the OTP code in seconds.
Contact Id Required. The identifier of the contact to request the OTP for (e.g., phone number).

Output

The node outputs JSON data containing the response from the CrunchzApp API after requesting the OTP code. This typically includes details about the generated OTP, its validity, and any metadata returned by the API. The output does not explicitly mention binary data, so it is assumed to be purely JSON.

Dependencies

  • Requires an active CrunchzApp API key credential configured in n8n.
  • Depends on the CrunchzApp REST API endpoint at https://api.crunchz.app/api.
  • The node sends requests with JSON payloads including the OTP parameters and contact ID.

Troubleshooting

  • Missing Contact Id: Since "Contact Id" is required, omitting it will likely cause an error. Ensure this property is set correctly.
  • Invalid API Credentials: If the API key is missing or invalid, the node will fail to authenticate with the CrunchzApp API.
  • Incorrect Property Values: Setting incompatible options (e.g., length zero or disabling both letters and numbers) may cause the API to reject the request.
  • Network Issues: Connectivity problems to the CrunchzApp API endpoint can cause timeouts or failures.

To resolve errors:

  • Verify that all required properties are provided and valid.
  • Check API credentials and permissions.
  • Confirm network connectivity.
  • Review API response messages for specific error details.

Links and References

Discussion