Accounts

Create an account

Creates a new account associated with your Straddle platform integration. This endpoint allows you to set up an account with specified details, including business information and access levels.

post/v1/accounts

Request

  • Base URL
    https://sandbox.straddle.com
  • URL
    https://sandbox.straddle.com/v1/accounts
  • Auth
    HTTP bearer

Headers

request-idstring

Optional client generated identifier to trace and debug a request.

correlation-idstring

Optional client generated identifier to trace and debug a series of requests.

idempotency-keystring

Optional client generated value to use for idempotent requests.

Request body

organization_idstring uuid required

The unique identifier of the organization related to this account.

account_type'business' required

The type of account to be created. Currently, only business is supported.

access_level'standard' | 'managed' required

The access level granted to the account. This is determined by your platform configuration. Use standard unless instructed otherwise by Straddle.

metadataobject nullable

Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the account in a structured format.

external_idstring nullable

Unique identifier for the account in your database, used for cross-referencing between Straddle and your systems.

Response

Created

response_type'object' | 'array' | 'error' | 'none' required

Indicates the structure of the returned content.

  • "object" means the data field contains a single JSON object.
  • "array" means the data field contains an array of objects.
  • "error" means the data field contains an error object with details of the issue.
  • "none" means no data is returned.

Changes