Onboard an account

AccountV1 Embed.Accounts.Onboard(, )

POST/v1/accounts/{account_id}/onboard

Initiates the onboarding process for a new account. This endpoint can only be used for accounts where at least one representative and one bank account have already been created.

ParametersExpand Collapse

AccountOnboardParams parameters

required string accountID

Path param

formatuuid

required TermsOfServiceV1 termsOfService

Body param

string correlationID

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

string idempotencyKey

Header param: Optional client generated value to use for idempotent requests.

maxLength40

minLength10

string requestID

Header param: Optional client generated identifier to trace and debug a request.

ReturnsExpand Collapse

class AccountV1:

required Data Data

required string ID

Unique identifier for the account.

formatuuid

required AccessLevel AccessLevel

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:

required string OrganizationID

The unique identifier of the organization this account belongs to.

formatuuid

required Status Status

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

One of the following:

required StatusDetail StatusDetail

required string Code

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

required string Message

A human-readable message describing the current status.

required Reason Reason

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

One of the following:

required Source Source

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

required Type Type

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

BusinessProfileV1 BusinessProfile

required string Name

The operating or trade name of the business.

required string Website

URL of the business's primary marketing website.

formaturi

AddressV1? Address

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

required string? City

City, district, suburb, town, or village.

required string? Line1

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

required string? PostalCode

Postal or ZIP code.

required string? State

Two-letter state code.

string? Country

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

string? Line2

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

string? Description

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

IndustryV1 Industry

string? Category

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

string? Mcc

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

string? Sector

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

string? LegalName

The official registered name of the business.

string? Phone

The primary contact phone number for the business.

SupportChannelsV1 SupportChannels

string? Email

The email address for customer support inquiries.

formatemail

string? Phone

The phone number for customer support.

string? Url

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

formaturi

string? TaxID

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

string? UseCase

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

Capabilities Capabilities

required ConsentTypes ConsentTypes

required CapabilityV1 Internet

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