Simulate status transitions for a sandbox account

post/v1/accounts/{account_id}/simulate

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

Path ParametersExpand Collapse

account_id: string

Query ParametersExpand Collapse

final_status: optional "onboarding" or "active"

Accepts one of the following:

"onboarding"

"active"

Header ParametersExpand Collapse

"correlation-id": optional string

"idempotency-key": optional string

"request-id": optional string

ReturnsExpand Collapse

AccountV1 = object { data, meta, response_type }

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

id: string

Unique identifier for the account.

formatuuid

access_level: "standard" or "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" or "onboarding" or "active" or 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: object { 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" or "in_review" or "pending" or 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: optional 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: optional 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: optional string

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

country: optional string

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

line1: optional string

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

line2: optional string

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

postal_code: optional string

Postal or ZIP code.

description: optional string

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

industry: optional IndustryV1 { category, mcc, sector }

category: optional string

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

mcc: optional string

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

sector: optional string

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

legal_name: optional string

The official registered name of the business.

phone: optional string

The primary contact phone number for the business.

support_channels: optional SupportChannelsV1 { email, phone, url }

email: optional string

The email address for customer support inquiries.

formatemail

phone: optional string

The phone number for customer support.

url: optional string

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

formaturi

tax_id: optional string

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

use_case: optional string

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

capabilities: optional object { consent_types, customer_types, payment_types }

consent_types: object { internet, signed_agreement }

internet: CapabilityV1 { capability_status }

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