Lookup an account

client.embed.accounts.get(, ?, ?): AccountV1 { data, meta, response_type }

get/v1/accounts/{account_id}

Retrieves the details of an account that has previously been created. Supply the unique account ID that was returned from your previous request, and Straddle will return the corresponding account information.

ParametersExpand Collapse

accountID: string

The unique identifier of the account to retrieve.

formatuuid

params: AccountGetParams { correlationID, requestID }

correlationID?: string

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

requestID?: string

Optional client generated identifier to trace and debug a request.

ReturnsExpand Collapse

AccountV1 { data, meta, response_type }

data: 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: StatusDetail { 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 } | null

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 | null

City, district, suburb, town, or village.

state: string | null

Two-letter state code.

zip: string

Zip or postal code.

address2?: string | null

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

country?: string | null

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

line1?: string | null

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

line2?: string | null

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

postal_code?: string | null

Postal or ZIP code.

description?: string | null

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

industry?: IndustryV1 { category, mcc, sector }

category?: string | null

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

mcc?: string | null

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

sector?: string | null

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

legal_name?: string | null

The official registered name of the business.

phone?: string | null

The primary contact phone number for the business.

support_channels?: SupportChannelsV1 { email, phone, url }

email?: string | null

The email address for customer support inquiries.

formatemail

phone?: string | null

The phone number for customer support.

url?: string | null

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

formaturi

tax_id?: string | null

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

use_case?: string | null

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

capabilities?: Capabilities { consent_types, customer_types, payment_types }

consent_types: ConsentTypes { internet, signed_agreement }

internet: CapabilityV1 { capability_status }

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