Simulate status transitions for a sandbox account

embed.accounts.simulate(account_id, **kwargs) -> AccountV1 { data, meta, response_type }

post/v1/accounts/{account_id}/simulate

Simulate the status transitions for sandbox accounts. This endpoint can only be used for sandbox accounts.

ParametersExpand Collapse

account_id: String

final_status: :onboarding | :active

Accepts one of the following:

:onboarding

:active

correlation_id: String

idempotency_key: String

request_id: String

ReturnsExpand Collapse

class AccountV1 { data, meta, response_type }

data: { id, access_level, organization_id, 11 more}

id: String

Unique identifier for the account.

formatuuid

access_level: :standard | :managed

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

Accepts one of the following:

:standard

:managed

organization_id: String

The unique identifier of the organization this account belongs to.

formatuuid

status: :created | :onboarding | :active | 2 more

The current status of the account (e.g., 'active', 'inactive', 'pending').

Accepts one of the following:

:created

:onboarding

:active

:rejected

:inactive

status_detail: { code, message, reason, source}

code: String

A machine-readable code for the specific status, useful for programmatic handling.

message: String

A human-readable message describing the current status.

reason: :unverified | :in_review | :pending | 6 more

A machine-readable identifier for the specific status, useful for programmatic handling.

Accepts one of the following:

:unverified

:in_review

:pending

:stuck

:verified

:failed_verification

:disabled

:terminated

:new

source: :watchtower

Identifies the origin of the status change (e.g., bank_decline, watchtower). This helps in tracking the cause of status updates.

Accepts one of the following:

:watchtower

type: :business

The type of account (e.g., 'individual', 'business').

Accepts one of the following:

:business

business_profile: BusinessProfileV1 { name, website, address, 7 more }

name: String

The operating or trade name of the business.

website: String

URL of the business's primary marketing website.

formaturi

address: AddressV1 { address1, city, state, 6 more }

The address object is optional. If provided, it must be a valid address.

address1: String

Primary address line (e.g., street, PO Box).

city: String

City, district, suburb, town, or village.

state: String

Two-letter state code.

zip: String

Zip or postal code.

address2: String

Secondary address line (e.g., apartment, suite, unit, or building).

country: String

The country of the address, in ISO 3166-1 alpha-2 format.

line1: String

Primary address line (e.g., street, PO Box).

line2: String

Secondary address line (e.g., apartment, suite, unit, or building).

postal_code: String

Postal or ZIP code.

description: String

A brief description of the business and its products or services.

industry: IndustryV1 { category, mcc, sector }

category: String

The general category of the industry. Required if not providing MCC.

mcc: String

The Merchant Category Code (MCC) that best describes the business. Optional.

sector: String

The specific sector within the industry category. Required if not providing MCC.

legal_name: String

The official registered name of the business.

phone: String

The primary contact phone number for the business.

support_channels: SupportChannelsV1 { email, phone, url }

email: String

The email address for customer support inquiries.

formatemail

phone: String

The phone number for customer support.

url: String

The URL of the business's customer support page or contact form.

formaturi

tax_id: String

The business's tax identification number (e.g., EIN in the US).

use_case: String

A description of how the business intends to use Straddle's services.

capabilities: { consent_types, customer_types, payment_types}

consent_types: { internet, signed_agreement}

internet: CapabilityV1 { capability_status }

Whether the internet payment authorization capability is enabled for the account.