Straddle icon

Straddle

Interact with Straddle API

Actions81

Overview

This node updates the status of a specific Representative in the system by sending a PATCH request to an internal API endpoint. It is useful for workflows that need to programmatically change or track the lifecycle state of representatives, such as onboarding processes, compliance checks, or account management automation.

Practical examples include:

  • Automatically marking a representative as "Active" after successful verification.
  • Setting a representative's status to "Rejected" if they fail compliance checks.
  • Updating detailed status information during various stages like "Onboarding" or "Inactive".

Properties

Name Meaning
Representative Id The unique identifier of the representative whose status is being updated.
Request Id Optional client-generated identifier to trace and debug this specific request (sent as header).
Correlation Id Optional client-generated identifier to trace and debug a series of related requests (header).
Status The new high-level status of the representative. Options: Unknown, Created, Onboarding, Active, Rejected, Inactive.
Status Detail More granular detail about the status. Options: Unknown, Unverified, In Review, Pending, Stuck, Verified, Failed Verification, Disabled, Terminated.

Output

The node outputs the JSON response from the API call, which typically contains the updated representative object including its new status and status details. The output structure reflects the representative's data model with fields such as address, compliance profile, capabilities, settings, bank details, status details, and verification info.

No binary data output is involved.

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 PATCH requests with JSON payloads and expects JSON responses.

Troubleshooting

  • Common issues:
    • Invalid or missing Representative Id will cause the API to reject the request.
    • Incorrect or expired API credentials will result in authentication errors.
    • Providing invalid status or status_detail values not in the allowed options may cause validation errors.
  • Error messages:
    • Unauthorized or 401 errors indicate problems with API authentication; verify the API key credential.
    • 404 Not Found errors suggest the specified representative ID does not exist.
    • 400 Bad Request errors often mean required parameters are missing or invalid; check property values carefully.
  • To resolve errors, ensure all required properties are correctly set, the API key is valid, and the representative exists.

Links and References

  • Straddle API Documentation (hypothetical link)
  • n8n HTTP Request Node documentation for understanding request routing and headers.

Discussion