Skip to content
straddle API Docs
Get started
API Reference

Embed

EmbedAccounts

Accounts represent businesses using Straddle through your platform. Each account must complete automated verification before processing payments. Use accounts to manage your users' payment capabilities, track verification status, and control access to features. Accounts can be instantly created in sandbox and require additional verification for production access.

Lookup an account
embed.accounts.get(straccount_id, AccountGetParams**kwargs) -> AccountV1
GET/v1/accounts/{account_id}
Update an account
embed.accounts.update(straccount_id, AccountUpdateParams**kwargs) -> AccountV1
PUT/v1/accounts/{account_id}
Create an account
embed.accounts.create(AccountCreateParams**kwargs) -> AccountV1
POST/v1/accounts
List accounts
embed.accounts.list(AccountListParams**kwargs) -> SyncPageNumberSchema[Data]
GET/v1/accounts
Onboard an account
embed.accounts.onboard(straccount_id, AccountOnboardParams**kwargs) -> AccountV1
POST/v1/accounts/{account_id}/onboard
Simulate status transitions for a sandbox account
embed.accounts.simulate(straccount_id, AccountSimulateParams**kwargs) -> AccountV1
POST/v1/accounts/{account_id}/simulate
ModelsExpand Collapse
class AccountPagedV1: …
data: List[Data]
id: str

Unique identifier for the account.

formatuuid
access_level: Literal["standard", "managed"]

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

One of the following:
"standard"
"managed"
organization_id: str

The unique identifier of the organization this account belongs to.

formatuuid
status: Literal["created", "onboarding", "active", 2 more]

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

One of the following:
"created"
"onboarding"
"active"
"rejected"
"inactive"
status_detail: DataStatusDetail
code: str

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

message: str

A human-readable message describing the current status.

reason: Literal["unverified", "in_review", "pending", 6 more]

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

One of the following:
"unverified"
"in_review"
"pending"
"stuck"
"verified"
"failed_verification"
"disabled"
"terminated"
"new"
source: Literal["watchtower"]

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

type: Literal["business"]

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

business_profile: Optional[BusinessProfileV1]
name: str

The operating or trade name of the business.

website: str

URL of the business's primary marketing website.

formaturi
address: Optional[AddressV1]

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

city: Optional[str]

City, district, suburb, town, or village.

line1: Optional[str]

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

postal_code: Optional[str]

Postal or ZIP code.

state: Optional[str]

Two-letter state code.

country: Optional[str]

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

line2: Optional[str]

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

description: Optional[str]

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

industry: Optional[IndustryV1]
category: Optional[str]

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

mcc: Optional[str]

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

sector: Optional[str]

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

The official registered name of the business.

phone: Optional[str]

The primary contact phone number for the business.

support_channels: Optional[SupportChannelsV1]
email: Optional[str]

The email address for customer support inquiries.

formatemail
phone: Optional[str]

The phone number for customer support.

url: Optional[str]

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

formaturi
tax_id: Optional[str]

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

use_case: Optional[str]

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

capabilities: Optional[DataCapabilities]

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

One of the following:

Whether the signed agreement payment authorization capability is enabled for the account.

One of the following:
customer_types: DataCapabilitiesCustomerTypes
businesses: CapabilityV1
capability_status: Literal["active", "inactive"]
One of the following:
"active"
"inactive"
individuals: CapabilityV1
capability_status: Literal["active", "inactive"]
One of the following:
"active"
"inactive"
payment_types: DataCapabilitiesPaymentTypes
charges: CapabilityV1
capability_status: Literal["active", "inactive"]
One of the following:
"active"
"inactive"
payouts: CapabilityV1
capability_status: Literal["active", "inactive"]
One of the following:
"active"
"inactive"
created_at: Optional[datetime]

Timestamp of when the account was created.

formatdate-time
external_id: Optional[str]

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

metadata: Optional[Dict[str, Optional[str]]]

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

settings: Optional[DataSettings]
charges: DataSettingsCharges
daily_amount: int

The maximum dollar amount of charges in a calendar day.

formatint32
funding_time: Literal["immediate", "next_day", "one_day", 4 more]

The amount of time it takes for a charge to be funded. This value is defined by Straddle.

One of the following:
"immediate"
"next_day"
"one_day"
"two_day"
"three_day"
"four_day"
"five_day"
linked_bank_account_id: str

The unique identifier of the linked bank account associated with charges. This value is defined by Straddle.

formatuuid
max_amount: int

The maximum amount of a single charge.

formatint32
monthly_amount: int

The maximum dollar amount of charges in a calendar month.

formatint32
monthly_count: int

The maximum number of charges in a calendar month.

formatint32
payouts: DataSettingsPayouts
daily_amount: int

The maximum dollar amount of payouts in a day.

formatint32
funding_time: Literal["immediate", "next_day", "one_day", 4 more]

The amount of time it takes for a payout to be funded. This value is defined by Straddle.

One of the following:
"immediate"
"next_day"
"one_day"
"two_day"
"three_day"
"four_day"
"five_day"
linked_bank_account_id: str

The unique identifier of the linked bank account to use for payouts.

formatuuid
max_amount: int

The maximum amount of a single payout.

formatint32
monthly_amount: int

The maximum dollar amount of payouts in a month.

formatint32
monthly_count: int

The maximum number of payouts in a month.

formatint32
terms_of_service: Optional[TermsOfServiceV1]
accepted_date: datetime

The datetime of when the terms of service were accepted, in ISO 8601 format.

formatdate-time
agreement_type: Literal["embedded", "direct"]

The type or version of the agreement accepted. Use embedded unless your platform was specifically enabled for direct agreements.

One of the following:
"embedded"
"direct"
agreement_url: Optional[str]

The URL where the full text of the accepted agreement can be found.

accepted_ip: Optional[str]

The IP address from which the terms of service were accepted.

accepted_user_agent: Optional[str]

The user agent string of the browser or application used to accept the terms.

updated_at: Optional[datetime]

Timestamp of the most recent update to the account.

formatdate-time

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

api_request_id: str

Unique identifier for this API request, useful for troubleshooting.

formatuuid
api_request_timestamp: datetime

Timestamp for this API request, useful for troubleshooting.

formatdate-time
max_page_size: int

Maximum allowed page size for this endpoint.

formatint32
page_number: int

Page number for paginated results.

formatint32
page_size: int

Number of items per page in this response.

formatint32
sort_by: str

The field that the results were sorted by.

sort_order: Literal["asc", "desc"]
One of the following:
"asc"
"desc"
total_items: int

Total number of items returned in this response.

formatint32
total_pages: int

The number of pages available.

formatint32
response_type: Literal["object", "array", "error", "none"]

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.
One of the following:
"object"
"array"
"error"
"none"
class AccountV1: …
data: Data
id: str

Unique identifier for the account.

formatuuid
access_level: Literal["standard", "managed"]

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

One of the following:
"standard"
"managed"
organization_id: str

The unique identifier of the organization this account belongs to.

formatuuid
status: Literal["created", "onboarding", "active", 2 more]

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

One of the following:
"created"
"onboarding"
"active"
"rejected"
"inactive"
status_detail: DataStatusDetail
code: str

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

message: str

A human-readable message describing the current status.

reason: Literal["unverified", "in_review", "pending", 6 more]

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

One of the following:
"unverified"
"in_review"
"pending"
"stuck"
"verified"
"failed_verification"
"disabled"
"terminated"
"new"
source: Literal["watchtower"]

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

type: Literal["business"]

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

business_profile: Optional[BusinessProfileV1]
name: str

The operating or trade name of the business.

website: str

URL of the business's primary marketing website.

formaturi
address: Optional[AddressV1]

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

city: Optional[str]

City, district, suburb, town, or village.

line1: Optional[str]

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

postal_code: Optional[str]

Postal or ZIP code.

state: Optional[str]

Two-letter state code.

country: Optional[str]

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

line2: Optional[str]

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

description: Optional[str]

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

industry: Optional[IndustryV1]
category: Optional[str]

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

mcc: Optional[str]

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

sector: Optional[str]

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

The official registered name of the business.

phone: Optional[str]

The primary contact phone number for the business.

support_channels: Optional[SupportChannelsV1]
email: Optional[str]

The email address for customer support inquiries.

formatemail
phone: Optional[str]

The phone number for customer support.

url: Optional[str]

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

formaturi
tax_id: Optional[str]

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

use_case: Optional[str]

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

capabilities: Optional[DataCapabilities]

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

One of the following:

Whether the signed agreement payment authorization capability is enabled for the account.

One of the following:
customer_types: DataCapabilitiesCustomerTypes
businesses: CapabilityV1
capability_status: Literal["active", "inactive"]
One of the following:
"active"
"inactive"
individuals: CapabilityV1
capability_status: Literal["active", "inactive"]
One of the following:
"active"
"inactive"
payment_types: DataCapabilitiesPaymentTypes
charges: CapabilityV1
capability_status: Literal["active", "inactive"]
One of the following:
"active"
"inactive"
payouts: CapabilityV1
capability_status: Literal["active", "inactive"]
One of the following:
"active"
"inactive"
created_at: Optional[datetime]

Timestamp of when the account was created.

formatdate-time
external_id: Optional[str]

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

metadata: Optional[Dict[str, Optional[str]]]

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

settings: Optional[DataSettings]
charges: DataSettingsCharges
daily_amount: int

The maximum dollar amount of charges in a calendar day.

formatint32
funding_time: Literal["immediate", "next_day", "one_day", 4 more]

The amount of time it takes for a charge to be funded. This value is defined by Straddle.

One of the following:
"immediate"
"next_day"
"one_day"
"two_day"
"three_day"
"four_day"
"five_day"
linked_bank_account_id: str

The unique identifier of the linked bank account associated with charges. This value is defined by Straddle.

formatuuid
max_amount: int

The maximum amount of a single charge.

formatint32
monthly_amount: int

The maximum dollar amount of charges in a calendar month.

formatint32
monthly_count: int

The maximum number of charges in a calendar month.

formatint32
payouts: DataSettingsPayouts
daily_amount: int

The maximum dollar amount of payouts in a day.

formatint32
funding_time: Literal["immediate", "next_day", "one_day", 4 more]

The amount of time it takes for a payout to be funded. This value is defined by Straddle.

One of the following:
"immediate"
"next_day"
"one_day"
"two_day"
"three_day"
"four_day"
"five_day"
linked_bank_account_id: str

The unique identifier of the linked bank account to use for payouts.

formatuuid
max_amount: int

The maximum amount of a single payout.

formatint32
monthly_amount: int

The maximum dollar amount of payouts in a month.

formatint32
monthly_count: int

The maximum number of payouts in a month.

formatint32
terms_of_service: Optional[TermsOfServiceV1]
accepted_date: datetime

The datetime of when the terms of service were accepted, in ISO 8601 format.

formatdate-time
agreement_type: Literal["embedded", "direct"]

The type or version of the agreement accepted. Use embedded unless your platform was specifically enabled for direct agreements.

One of the following:
"embedded"
"direct"
agreement_url: Optional[str]

The URL where the full text of the accepted agreement can be found.

accepted_ip: Optional[str]

The IP address from which the terms of service were accepted.

accepted_user_agent: Optional[str]

The user agent string of the browser or application used to accept the terms.

updated_at: Optional[datetime]

Timestamp of the most recent update to the account.

formatdate-time

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

api_request_id: str

Unique identifier for this API request, useful for troubleshooting.

formatuuid
api_request_timestamp: datetime

Timestamp for this API request, useful for troubleshooting.

formatdate-time
response_type: Literal["object", "array", "error", "none"]

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.
One of the following:
"object"
"array"
"error"
"none"
class AddressV1: …

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

city: Optional[str]

City, district, suburb, town, or village.

line1: Optional[str]

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

postal_code: Optional[str]

Postal or ZIP code.

state: Optional[str]

Two-letter state code.

country: Optional[str]

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

line2: Optional[str]

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

class BusinessProfileV1: …
name: str

The operating or trade name of the business.

website: str

URL of the business's primary marketing website.

formaturi
address: Optional[AddressV1]

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

city: Optional[str]

City, district, suburb, town, or village.

line1: Optional[str]

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

postal_code: Optional[str]

Postal or ZIP code.

state: Optional[str]

Two-letter state code.

country: Optional[str]

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

line2: Optional[str]

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

description: Optional[str]

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

industry: Optional[IndustryV1]
category: Optional[str]

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

mcc: Optional[str]

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

sector: Optional[str]

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

The official registered name of the business.

phone: Optional[str]

The primary contact phone number for the business.

support_channels: Optional[SupportChannelsV1]
email: Optional[str]

The email address for customer support inquiries.

formatemail
phone: Optional[str]

The phone number for customer support.

url: Optional[str]

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

formaturi
tax_id: Optional[str]

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

use_case: Optional[str]

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

class CapabilityV1: …
capability_status: Literal["active", "inactive"]
One of the following:
"active"
"inactive"
class IndustryV1: …
category: Optional[str]

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

mcc: Optional[str]

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

sector: Optional[str]

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

class SupportChannelsV1: …
email: Optional[str]

The email address for customer support inquiries.

formatemail
phone: Optional[str]

The phone number for customer support.

url: Optional[str]

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

formaturi
class TermsOfServiceV1: …
accepted_date: datetime

The datetime of when the terms of service were accepted, in ISO 8601 format.

formatdate-time
agreement_type: Literal["embedded", "direct"]

The type or version of the agreement accepted. Use embedded unless your platform was specifically enabled for direct agreements.

One of the following:
"embedded"
"direct"
agreement_url: Optional[str]

The URL where the full text of the accepted agreement can be found.

accepted_ip: Optional[str]

The IP address from which the terms of service were accepted.

accepted_user_agent: Optional[str]

The user agent string of the browser or application used to accept the terms.

EmbedAccountsCapability Requests

Capabilities enable specific features and services for an Account. Use capability requests to unlock higher processing limits, new payment types, or additional platform features as your users' businesses grow. Track approval status and manage documentation requirements through a single interface.

Request a capability
embed.accounts.capability_requests.create(straccount_id, CapabilityRequestCreateParams**kwargs) -> CapabilityRequestPagedV1
POST/v1/accounts/{account_id}/capability_requests
List capability requests
embed.accounts.capability_requests.list(straccount_id, CapabilityRequestListParams**kwargs) -> SyncPageNumberSchema[Data]
GET/v1/accounts/{account_id}/capability_requests
ModelsExpand Collapse
class CapabilityRequestPagedV1: …
data: List[Data]
id: str

Unique identifier for the capability request.

formatuuid
account_id: str

The unique identifier of the account associated with this capability request.

formatuuid
category: Literal["payment_type", "customer_type", "consent_type"]

The category of the requested capability. Use payment_type for charges and payouts, customer_type to define individuals or businesses, and consent_type for signed_agreement or internet payment authorization.

One of the following:
"payment_type"
"customer_type"
"consent_type"
created_at: datetime

Timestamp of when the capability request was created.

formatdate-time
enable: bool

Whether this capability request is to enable or disable the capability.

status: Literal["active", "inactive", "in_review", 3 more]

The current status of the capability request.

One of the following:
"active"
"inactive"
"in_review"
"rejected"
"approved"
"reviewing"
type: Literal["charges", "payouts", "individuals", 3 more]

The specific type of capability being requested within the category.

One of the following:
"charges"
"payouts"
"individuals"
"businesses"
"signed_agreement"
"internet"
updated_at: datetime

Timestamp of the most recent update to the capability request.

formatdate-time
settings: Optional[Dict[str, object]]

Any specific settings or configurations related to the requested capability.

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

api_request_id: str

Unique identifier for this API request, useful for troubleshooting.

formatuuid
api_request_timestamp: datetime

Timestamp for this API request, useful for troubleshooting.

formatdate-time
max_page_size: int

Maximum allowed page size for this endpoint.

formatint32
page_number: int

Page number for paginated results.

formatint32
page_size: int

Number of items per page in this response.

formatint32
sort_by: str

The field that the results were sorted by.

sort_order: Literal["asc", "desc"]
One of the following:
"asc"
"desc"
total_items: int

Total number of items returned in this response.

formatint32
total_pages: int

The number of pages available.

formatint32
response_type: Literal["object", "array", "error", "none"]

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.
One of the following:
"object"
"array"
"error"
"none"

EmbedLinked Bank Accounts

Linked bank accounts connect your platform users' external bank accounts to Straddle for settlements and payment funding. Each linked account undergoes automated verification and continuous monitoring. Use linked accounts to manage where clients receive deposits, fund payouts, and track settlement preferences.

Create a linked bank account
embed.linked_bank_accounts.create(LinkedBankAccountCreateParams**kwargs) -> LinkedBankAccountV1
POST/v1/linked_bank_accounts
List linked bank accounts
embed.linked_bank_accounts.list(LinkedBankAccountListParams**kwargs) -> SyncPageNumberSchema[Data]
GET/v1/linked_bank_accounts
Update a linked bank account
embed.linked_bank_accounts.update(strlinked_bank_account_id, LinkedBankAccountUpdateParams**kwargs) -> LinkedBankAccountV1
PUT/v1/linked_bank_accounts/{linked_bank_account_id}
Lookup a linked bank account
embed.linked_bank_accounts.get(strlinked_bank_account_id, LinkedBankAccountGetParams**kwargs) -> LinkedBankAccountV1
GET/v1/linked_bank_accounts/{linked_bank_account_id}
Unmask a linked bank account
embed.linked_bank_accounts.unmask(strlinked_bank_account_id, LinkedBankAccountUnmaskParams**kwargs) -> LinkedBankAccountUnmaskV1
GET/v1/linked_bank_accounts/{linked_bank_account_id}/unmask
Cancel a linked bank account
embed.linked_bank_accounts.cancel(strlinked_bank_account_id, LinkedBankAccountCancelParams**kwargs) -> LinkedBankAccountV1
PATCH/v1/linked_bank_accounts/{linked_bank_account_id}/cancel
ModelsExpand Collapse
class LinkedBankAccountPagedV1: …
data: List[Data]
id: str

Unique identifier for the linked bank account.

formatuuid
account_id: Optional[str]

The unique identifier of the Straddle account related to this bank account.

formatuuid
bank_account: DataBankAccount
account_holder: str
account_mask: str
institution_name: str
routing_number: str
created_at: datetime

Timestamp of when the bank account object was created.

formatdate-time
purposes: List[Literal["charges", "payouts", "billing"]]

The purposes for the linked bank account.

One of the following:
"charges"
"payouts"
"billing"
status: Literal["created", "onboarding", "active", 3 more]

The current status of the linked bank account.

One of the following:
"created"
"onboarding"
"active"
"rejected"
"inactive"
"canceled"
status_detail: DataStatusDetail
code: str

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

message: str

A human-readable message describing the current status.

reason: Literal["unverified", "in_review", "pending", 5 more]

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

One of the following:
"unverified"
"in_review"
"pending"
"stuck"
"verified"
"failed_verification"
"disabled"
"new"
source: Literal["watchtower"]

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

updated_at: datetime

Timestamp of the most recent update to the linked bank account.

formatdate-time
description: Optional[str]

Optional description for the bank account.

metadata: Optional[Dict[str, Optional[str]]]

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

platform_id: Optional[str]

The unique identifier of the Straddle Platform relatd to this bank account.

formatuuid

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

api_request_id: str

Unique identifier for this API request, useful for troubleshooting.

formatuuid
api_request_timestamp: datetime

Timestamp for this API request, useful for troubleshooting.

formatdate-time
max_page_size: int

Maximum allowed page size for this endpoint.

formatint32
page_number: int

Page number for paginated results.

formatint32
page_size: int

Number of items per page in this response.

formatint32
sort_by: str

The field that the results were sorted by.

sort_order: Literal["asc", "desc"]
One of the following:
"asc"
"desc"
total_items: int

Total number of items returned in this response.

formatint32
total_pages: int

The number of pages available.

formatint32
response_type: Literal["object", "array", "error", "none"]

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.
One of the following:
"object"
"array"
"error"
"none"
class LinkedBankAccountUnmaskV1: …
data: Data
id: str

Unique identifier for the linked bank account.

formatuuid
account_id: str

Unique identifier for the Straddle account related to this bank account.

formatuuid
bank_account: DataBankAccount

The bank account details associated with the linked bank account.

account_holder: str
account_number: str
institution_name: str
routing_number: str
created_at: datetime

Timestamp of when the linked bank account was created.

formatdate-time
status: Literal["created", "onboarding", "active", 3 more]

The current status of the linked bank account.

One of the following:
"created"
"onboarding"
"active"
"rejected"
"inactive"
"canceled"
status_detail: DataStatusDetail

Additional details about the current status of the linked bank account.

code: str

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

message: str

A human-readable message describing the current status.

reason: Literal["unverified", "in_review", "pending", 5 more]

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

One of the following:
"unverified"
"in_review"
"pending"
"stuck"
"verified"
"failed_verification"
"disabled"
"new"
source: Literal["watchtower"]

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

updated_at: datetime

Timestamp of when the linked bank account was last updated.

formatdate-time
metadata: Optional[Dict[str, Optional[str]]]

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

api_request_id: str

Unique identifier for this API request, useful for troubleshooting.

formatuuid
api_request_timestamp: datetime

Timestamp for this API request, useful for troubleshooting.

formatdate-time
response_type: Literal["object", "array", "error", "none"]

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.
One of the following:
"object"
"array"
"error"
"none"
class LinkedBankAccountV1: …
data: Data
id: str

Unique identifier for the linked bank account.

formatuuid
account_id: Optional[str]

The unique identifier of the Straddle account related to this bank account.

formatuuid
bank_account: DataBankAccount
account_holder: str
account_mask: str
institution_name: str
routing_number: str
created_at: datetime

Timestamp of when the bank account object was created.

formatdate-time
purposes: List[Literal["charges", "payouts", "billing"]]

The purposes for the linked bank account.

One of the following:
"charges"
"payouts"
"billing"
status: Literal["created", "onboarding", "active", 3 more]

The current status of the linked bank account.

One of the following:
"created"
"onboarding"
"active"
"rejected"
"inactive"
"canceled"
status_detail: DataStatusDetail
code: str

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

message: str

A human-readable message describing the current status.

reason: Literal["unverified", "in_review", "pending", 5 more]

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

One of the following:
"unverified"
"in_review"
"pending"
"stuck"
"verified"
"failed_verification"
"disabled"
"new"
source: Literal["watchtower"]

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

updated_at: datetime

Timestamp of the most recent update to the linked bank account.

formatdate-time
description: Optional[str]

Optional description for the bank account.

metadata: Optional[Dict[str, Optional[str]]]

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

platform_id: Optional[str]

The unique identifier of the Straddle Platform relatd to this bank account.

formatuuid

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

api_request_id: str

Unique identifier for this API request, useful for troubleshooting.

formatuuid
api_request_timestamp: datetime

Timestamp for this API request, useful for troubleshooting.

formatdate-time
response_type: Literal["object", "array", "error", "none"]

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.
One of the following:
"object"
"array"
"error"
"none"

EmbedOrganizations

Organizations are a powerful feature in Straddle that allow you to manage multiple accounts under a single umbrella. This hierarchical structure is particularly useful for businesses with complex operations, multiple departments, or legally related entities.

Create an organization
embed.organizations.create(OrganizationCreateParams**kwargs) -> OrganizationV1
POST/v1/organizations
List organizations
embed.organizations.list(OrganizationListParams**kwargs) -> SyncPageNumberSchema[Data]
GET/v1/organizations
Retrieve organization details
embed.organizations.get(strorganization_id, OrganizationGetParams**kwargs) -> OrganizationV1
GET/v1/organizations/{organization_id}
ModelsExpand Collapse
class OrganizationPagedV1: …
data: List[Data]
id: str

Straddle's unique identifier for the organization.

formatuuid
created_at: datetime

Timestamp of when the organization was created.

formatdate-time
name: str

The name of the organization.

updated_at: datetime

Timestamp of the most recent update to the organization.

formatdate-time
external_id: Optional[str]

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

metadata: Optional[Dict[str, Optional[str]]]

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

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

api_request_id: str

Unique identifier for this API request, useful for troubleshooting.

formatuuid
api_request_timestamp: datetime

Timestamp for this API request, useful for troubleshooting.

formatdate-time
max_page_size: int

Maximum allowed page size for this endpoint.

formatint32
page_number: int

Page number for paginated results.

formatint32
page_size: int

Number of items per page in this response.

formatint32
sort_by: str

The field that the results were sorted by.

sort_order: Literal["asc", "desc"]
One of the following:
"asc"
"desc"
total_items: int

Total number of items returned in this response.

formatint32
total_pages: int

The number of pages available.

formatint32
response_type: Literal["object", "array", "error", "none"]

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.
One of the following:
"object"
"array"
"error"
"none"
class OrganizationV1: …
data: Data
id: str

Straddle's unique identifier for the organization.

formatuuid
created_at: datetime

Timestamp of when the organization was created.

formatdate-time
name: str

The name of the organization.

updated_at: datetime

Timestamp of the most recent update to the organization.

formatdate-time
external_id: Optional[str]

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

metadata: Optional[Dict[str, Optional[str]]]

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

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

api_request_id: str

Unique identifier for this API request, useful for troubleshooting.

formatuuid
api_request_timestamp: datetime

Timestamp for this API request, useful for troubleshooting.

formatdate-time
response_type: Literal["object", "array", "error", "none"]

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.
One of the following:
"object"
"array"
"error"
"none"

EmbedRepresentatives

Representatives are individuals who have legal authority or significant responsibility within a business entity associated with a Straddle account. Each representative undergoes automated verification as part of KYC/KYB compliance. Use representatives to collect and verify beneficial owners, control persons, and authorized signers required for account onboarding. Representatives also determine who can legally operate the account and make important changes.

Create a representative
embed.representatives.create(RepresentativeCreateParams**kwargs) -> Representative
POST/v1/representatives
List representatives
embed.representatives.list(RepresentativeListParams**kwargs) -> SyncPageNumberSchema[Data]
GET/v1/representatives
Update a representative
embed.representatives.update(strrepresentative_id, RepresentativeUpdateParams**kwargs) -> Representative
PUT/v1/representatives/{representative_id}
Lookup a representative
embed.representatives.get(strrepresentative_id, RepresentativeGetParams**kwargs) -> Representative
GET/v1/representatives/{representative_id}
Retrieve unmasked representative details
embed.representatives.unmask(strrepresentative_id, RepresentativeUnmaskParams**kwargs) -> Representative
GET/v1/representatives/{representative_id}/unmask
ModelsExpand Collapse
class Representative: …
data: Data
id: str

Unique identifier for the representative.

formatuuid
account_id: str

The unique identifier of the account this representative is associated with.

formatuuid
created_at: datetime

Timestamp of when the representative was created.

formatdate-time
dob: date

The date of birth of the representative, in ISO 8601 format (YYYY-MM-DD).

formatdate
email: Optional[str]

The email address of the representative.

formatemail
first_name: str

The first name of the representative.

last_name: str

The last name of the representative.

mobile_number: str

The mobile phone number of the representative.

name: str
relationship: DataRelationship
control: bool

Whether the representative has significant responsibility to control, manage, or direct the organization. One representative must be identified under the control prong for each legal entity.

owner: bool

Whether the representative owns any percentage of of the equity interests of the legal entity.

primary: bool

Whether the person is authorized as the primary representative of the account. This is the person chosen by the business to provide information about themselves, general information about the account, and who consented to the services agreement.

There can be only one primary representative for an account at a time.

percent_ownership: Optional[float]

The percentage of ownership the representative has. Required if 'Owner' is true.

formatdouble
title: Optional[str]

The job title of the representative.

ssn_last4: str

The last 4 digits of the representative's Social Security Number.

status: Literal["created", "onboarding", "active", 2 more]

The current status of the representative.

One of the following:
"created"
"onboarding"
"active"
"rejected"
"inactive"
status_detail: DataStatusDetail
code: str

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

message: str

A human-readable message describing the current status.

reason: Literal["unverified", "in_review", "pending", 5 more]

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

One of the following:
"unverified"
"in_review"
"pending"
"stuck"
"verified"
"failed_verification"
"disabled"
"new"
source: Literal["watchtower"]

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

updated_at: datetime

Timestamp of the most recent update to the representative.

formatdate-time
external_id: Optional[str]

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

metadata: Optional[Dict[str, str]]

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

phone: Optional[str]
user_id: Optional[str]

The unique identifier of the user account associated with this representative, if applicable.

formatuuid

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

api_request_id: str

Unique identifier for this API request, useful for troubleshooting.

formatuuid
api_request_timestamp: datetime

Timestamp for this API request, useful for troubleshooting.

formatdate-time
response_type: Literal["object", "array", "error", "none"]

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.
One of the following:
"object"
"array"
"error"
"none"
class RepresentativePaged: …
data: List[Data]
id: str

Unique identifier for the representative.

formatuuid
account_id: str

The unique identifier of the account this representative is associated with.

formatuuid
created_at: datetime

Timestamp of when the representative was created.

formatdate-time
dob: date

The date of birth of the representative, in ISO 8601 format (YYYY-MM-DD).

formatdate
email: Optional[str]

The email address of the representative.

formatemail
first_name: str

The first name of the representative.

last_name: str

The last name of the representative.

mobile_number: str

The mobile phone number of the representative.

name: str
relationship: DataRelationship
control: bool

Whether the representative has significant responsibility to control, manage, or direct the organization. One representative must be identified under the control prong for each legal entity.

owner: bool

Whether the representative owns any percentage of of the equity interests of the legal entity.

primary: bool

Whether the person is authorized as the primary representative of the account. This is the person chosen by the business to provide information about themselves, general information about the account, and who consented to the services agreement.

There can be only one primary representative for an account at a time.

percent_ownership: Optional[float]

The percentage of ownership the representative has. Required if 'Owner' is true.

formatdouble
title: Optional[str]

The job title of the representative.

ssn_last4: str

The last 4 digits of the representative's Social Security Number.

status: Literal["created", "onboarding", "active", 2 more]

The current status of the representative.

One of the following:
"created"
"onboarding"
"active"
"rejected"
"inactive"
status_detail: DataStatusDetail
code: str

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

message: str

A human-readable message describing the current status.

reason: Literal["unverified", "in_review", "pending", 5 more]

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

One of the following:
"unverified"
"in_review"
"pending"
"stuck"
"verified"
"failed_verification"
"disabled"
"new"
source: Literal["watchtower"]

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

updated_at: datetime

Timestamp of the most recent update to the representative.

formatdate-time
external_id: Optional[str]

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

metadata: Optional[Dict[str, str]]

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

phone: Optional[str]
user_id: Optional[str]

The unique identifier of the user account associated with this representative, if applicable.

formatuuid

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

api_request_id: str

Unique identifier for this API request, useful for troubleshooting.

formatuuid
api_request_timestamp: datetime

Timestamp for this API request, useful for troubleshooting.

formatdate-time
max_page_size: int

Maximum allowed page size for this endpoint.

formatint32
page_number: int

Page number for paginated results.

formatint32
page_size: int

Number of items per page in this response.

formatint32
sort_by: str

The field that the results were sorted by.

sort_order: Literal["asc", "desc"]
One of the following:
"asc"
"desc"
total_items: int

Total number of items returned in this response.

formatint32
total_pages: int

The number of pages available.

formatint32
response_type: Literal["object", "array", "error", "none"]

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.
One of the following:
"object"
"array"
"error"
"none"