Authentica icon

Authentica

OTP and account balance via Authentica
Join our community

Actions3

Overview

This node integrates with the Authentica API to provide two main functionalities: sending and verifying one-time passwords (OTPs), and retrieving account balance information. Specifically, for the Account - Get Balance operation, it fetches the current balance associated with the authenticated account.

Typical use cases include:

  • Checking the remaining credit or funds available in an Authentica account before sending OTPs.
  • Monitoring usage limits or billing status programmatically within an automation workflow.

Example scenario:

  • Before triggering a bulk OTP send operation, you might want to verify that your account has sufficient balance by using this node's "Get Balance" operation.

Properties

Name Meaning
Include Raw Response Boolean option to attach the full raw API response under the raw field for debugging.

Output

The node outputs JSON data with the following structure:

  • balance: The numeric value representing the current account balance.
  • raw (optional): If "Include Raw Response" is enabled, the entire API response object is included here for detailed inspection.

Example output JSON:

{
  "balance": 123.45,
  "raw": {
    "data": {
      "balance": 123.45,
      ...
    },
    ...
  }
}

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Authentica API.
  • The base URL defaults to https://api.authentica.sa but can be overridden via credentials configuration.
  • Uses HTTP requests with JSON payloads and expects JSON responses.

Troubleshooting

  • Invalid Credentials: If authentication fails, ensure the API key credential is correctly configured and active.
  • Network Issues: Connectivity problems may cause request failures; verify network access to the Authentica API endpoint.
  • Unexpected Response Structure: If the API changes its response format, the node might fail to extract the balance properly.
  • Enable Raw Response: To debug issues, enable the "Include Raw Response" property to see the full API reply.

Common error messages:

  • "Phone must be E.164, e.g. +9665XXXXXXX" or "Email is not valid" are related to OTP operations and do not apply to the Get Balance operation.
  • API errors will be surfaced as node execution errors unless "Continue On Fail" is enabled.

Links and References

Discussion