Straddle icon

Straddle

Interact with Straddle API
Join our community

Actions81

Overview

This node interacts with the Straddle API to initialize a bridge session for a specified customer. It is designed to create an initialization token or session that can be used in workflows requiring secure and scoped access to customer-related operations within the Straddle platform.

Common scenarios where this node is beneficial include:

  • Platforms needing to programmatically start a bridge session for a customer.
  • Automating onboarding or authentication flows where a temporary token/session must be generated.
  • Integrations that require scoped requests tied to specific accounts or customers.

For example, a financial services platform could use this node to initialize a bridge session for a customer before performing further actions like payments or data retrieval.

Properties

Name Meaning
Straddle Account Id (Optional) For platforms to specify an account ID to set the scope of the request via header.
Request Id (Optional) Client-generated identifier to trace and debug a single request via header.
Correlation Id (Optional) Client-generated identifier to trace and debug a series of related requests via header.
Customer Id (Required) The customer identifier for whom the token/session is being created; sent in the body.

Output

The node outputs JSON data representing the response from the Straddle API after initializing the bridge. This typically includes details about the created token/session and any associated metadata returned by the API.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating with the Straddle API.
  • The base URL for API requests is dynamically constructed using the environment value from credentials (e.g., https://{environment}.straddle.io).
  • The node expects standard HTTP headers including Accept: application/json and Content-Type: application/json.

Troubleshooting

  • Missing Customer Id: Since Customer Id is required, omitting it will likely cause the API call to fail. Ensure this property is provided.
  • Invalid or missing API credentials: Authentication errors may occur if the API key credential is not configured correctly.
  • Incorrect environment setting: The base URL depends on the environment parameter; an incorrect environment value will lead to connection failures.
  • Header misconfiguration: Optional headers like Straddle Account Id, Request Id, and Correlation Id should be strings if used; invalid values might cause unexpected API behavior.
  • API errors: The node passes through API error messages. Common issues include invalid customer IDs or permission errors. Review the API response message for guidance.

Links and References

Discussion