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

cURL

cURL

curl --request POST \
  --header 'Authorization: Bearer YOUR_SECRET_API_KEY' \
  --url https://sandbox.straddle.com/v1/accounts \
  --header 'Content-Type: application/json' \
  --data '{
  "organization_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "account_type": "business",
  "business_profile": {
    "name": "<string>",
    "website": "https://example.com"
  },
  "access_level": "standard"
}'

201

{
  "meta": {
    "api_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "api_request_timestamp": "2023-11-07T05:31:56Z"
  },
  "response_type": "object",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "business",
    "status": "created",
    "status_detail": {
      "reason": "unverified",
      "source": "watchtower",
      "code": "<string>",
      "message": "<string>"
    },
    "access_level": "standard",
    "business_profile": {
      "name": "<string>",
      "website": "<string>",
      "legal_name": "<string>",
      "description": "<string>",
      "use_case": "<string>",
      "tax_id": "<string>",
      "phone": "<string>",
      "address": {
        "line1": "<string>",
        "city": "<string>",
        "state": "<string>",
        "postal_code": "<string>",
        "line2": "<string>",
        "country": "<string>"
      },
      "industry": {
        "mcc": "<string>",
        "sector": "<string>",
        "category": "<string>"
      },
      "support_channels": {
        "email": "[e-mail]",
        "phone": "<string>",
        "url": "<string>"
      }
    },
    "capabilities": {
      "payment_types": {
        "charges": {
          "capability_status": "active"
        },
        "payouts": {
          "capability_status": "active"
        }
      },
      "customer_types": {
        "individuals": {
          "capability_status": "active"
        },
        "businesses": {
          "capability_status": "active"
        }
      },
      "consent_types": {
        "signed_agreement": {
          "capability_status": "active"
        },
        "internet": {
          "capability_status": "active"
        }
      }
    },
    "settings": {
      "charges": {
        "max_amount": 123,
        "monthly_amount": 123,
        "daily_amount": 123,
        "monthly_count": 123,
        "funding_time": "immediate",
        "linked_bank_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "payouts": {
        "max_amount": 123,
        "monthly_amount": 123,
        "daily_amount": 123,
        "monthly_count": 123,
        "funding_time": "immediate",
        "linked_bank_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    },
    "terms_of_service": {
      "accepted_date": "2023-11-07T05:31:56Z",
      "agreement_url": "<string>",
      "agreement_type": "embedded",
      "accepted_ip": "<string>",
      "accepted_user_agent": "<string>"
    },
    "metadata": {},
    "external_id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization · string · header · required

Use your Straddle API Key in the Authorization header as Bearer to authorize API requests.

Headers

request-id · string

Optional client generated identifier to trace and debug a request.

correlation-id · string

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

idempotency-key · string

Optional client generated value to use for idempotent requests.

Required string length: 10 - 40

Body

application/jsontext/jsonapplication/*+json

organization_id · string<uuid> · required

The unique identifier of the organization related to this account.

account_type · enum<string> · required

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

Available options: business

business_profile · object · required

Show child attributes

access_level · enum<string> · required

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

Available options: standard, managed

metadata · object

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

Show child attributes

external_id · string | null

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

Response

201

text/plain

Created

meta · object · required

Metadata about the API request, including an identifier and timestamp.

Show child attributes

response_type · enum<string> · 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.

Available options: object, array, error, none

data · object · required

Show child attributes