Straddle icon

Straddle

Interact with Straddle API

Actions81

Overview

This node allows you to create a new Platform entity by sending structured business profile data and optional metadata to an external API. It is useful in scenarios where you need to register or onboard platforms with detailed business information, such as address, industry classification, and support channels. For example, a payment service provider might use this node to programmatically create platform accounts for their clients, including relevant compliance and contact details.

Properties

Name Meaning
Request Id Optional client-generated identifier to trace and debug a single request (sent as HTTP header).
Correlation Id Optional client-generated identifier to trace and debug a series of related requests (header).
Business Profile Required JSON object containing detailed business profile information including address, industry, and support channels.
Metadata Optional JSON object for user-defined key-value pairs to attach custom metadata to the platform.
External Id Optional string identifier for the platform, typically used to link with external systems.

Output

The node outputs the response from the API call as JSON in the json output field. This JSON will contain the created platform's details, including the submitted business profile, metadata, status, and any identifiers assigned by the API. The node does not output binary data.

Dependencies

  • Requires an API key credential for authentication with the external Straddle API.
  • The base URL for API requests is dynamically set based on the configured environment credential.
  • The node expects the API to accept and return JSON-formatted data.

Troubleshooting

  • Missing required Business Profile: The operation requires a valid JSON object for the business profile. Ensure it is correctly formatted and includes mandatory fields like address and industry.
  • Invalid JSON input: If the JSON properties (business_profile, metadata) are malformed, the API request will fail. Validate JSON syntax before execution.
  • Authentication errors: Make sure the API key credential is properly configured and has permissions to create platforms.
  • Header injection issues: Custom headers like request-id and correlation-id must be strings; invalid values may cause request failures.
  • API endpoint or environment misconfiguration: Verify that the environment variable used to build the base URL matches the expected API environment.

Links and References

  • Straddle API Documentation (hypothetical link)
  • JSON Schema references for business profile and related objects can be found in the bundled schema file (straddle.json).

Discussion