Straddle icon

Straddle

Interact with Straddle API
Join our community

Actions81

Overview

This node performs the onboarding of an account by sending a POST request to the endpoint /v1/accounts/{account_id}/onboard. It is designed to facilitate the process of completing or updating onboarding information for a specific account in a system that supports such operations. This can be useful in scenarios where you need to programmatically trigger or update the onboarding status of accounts, for example, when integrating with payment platforms or compliance systems.

Practical examples include:

  • Automatically submitting terms of service acceptance and related onboarding data for newly created accounts.
  • Triggering onboarding steps after collecting required compliance or business information from users.
  • Debugging or tracing onboarding requests using optional client-generated identifiers.

Properties

Name Meaning
Account Id The unique identifier of the account to onboard.
Request Id Optional client-generated identifier to trace and debug a single request (sent as header).
Correlation Id Optional client-generated identifier to trace and debug a series of related requests (header).
Terms Of Service JSON object containing terms_of_service information required for onboarding.

Output

The node outputs JSON data representing the response from the onboarding API call. This typically includes details about the onboarding status or confirmation of the submitted terms of service. The exact structure depends on the API response but generally reflects the updated state of the account's onboarding process.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authentication to the Straddle API.
  • The base URL for the API is dynamically set based on the environment credential parameter.
  • The node sends HTTP requests with Accept: application/json and Content-Type: application/json headers.

Troubleshooting

  • Missing or invalid Account Id: Ensure the "Account Id" property is provided and correctly references an existing account.
  • Invalid or malformed Terms Of Service JSON: The "Terms Of Service" input must be valid JSON; otherwise, the request body will be incorrect.
  • API authentication errors: Verify that the API key credential is configured properly and has necessary permissions.
  • Request or correlation ID usage: If debugging request flows, ensure these IDs are unique and consistent across calls.
  • Network or endpoint errors: Confirm the environment setting matches the correct API base URL and that the API service is reachable.

Common error messages would likely relate to HTTP 4xx or 5xx responses indicating authorization issues, missing parameters, or server errors. Checking the request payload and headers against API documentation can help resolve these.

Links and References

Discussion