Onboard an account

client.Embed.Accounts.Onboard(ctx, accountID, params) (*AccountV1, error)

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

accountID string

params EmbedAccountOnboardParams

TermsOfService param.Field[TermsOfServiceV1]

Body param

CorrelationID param.Field[string]optional

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

IdempotencyKey param.Field[string]optional

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

maxLength40

minLength10

RequestID param.Field[string]optional

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

ReturnsExpand Collapse

type AccountV1 struct{…}

Data AccountV1Data

ID string

Unique identifier for the account.

formatuuid

AccessLevel string

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:

const AccountV1DataAccessLevelStandard AccountV1DataAccessLevel = "standard"

const AccountV1DataAccessLevelManaged AccountV1DataAccessLevel = "managed"

OrganizationID string

The unique identifier of the organization this account belongs to.

formatuuid

Status string

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

One of the following:

const AccountV1DataStatusCreated AccountV1DataStatus = "created"

const AccountV1DataStatusOnboarding AccountV1DataStatus = "onboarding"

const AccountV1DataStatusActive AccountV1DataStatus = "active"

const AccountV1DataStatusRejected AccountV1DataStatus = "rejected"

const AccountV1DataStatusInactive AccountV1DataStatus = "inactive"

StatusDetail AccountV1DataStatusDetail

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 string

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

One of the following:

const AccountV1DataStatusDetailReasonUnverified AccountV1DataStatusDetailReason = "unverified"

const AccountV1DataStatusDetailReasonInReview AccountV1DataStatusDetailReason = "in_review"

const AccountV1DataStatusDetailReasonPending AccountV1DataStatusDetailReason = "pending"

const AccountV1DataStatusDetailReasonStuck AccountV1DataStatusDetailReason = "stuck"

const AccountV1DataStatusDetailReasonVerified AccountV1DataStatusDetailReason = "verified"

const AccountV1DataStatusDetailReasonFailedVerification AccountV1DataStatusDetailReason = "failed_verification"

const AccountV1DataStatusDetailReasonDisabled AccountV1DataStatusDetailReason = "disabled"

const AccountV1DataStatusDetailReasonTerminated AccountV1DataStatusDetailReason = "terminated"

const AccountV1DataStatusDetailReasonNew AccountV1DataStatusDetailReason = "new"

Source string

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

Type string

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

BusinessProfile BusinessProfileV1optional

Name string

The operating or trade name of the business.

Website string

URL of the business's primary marketing website.

formaturi

Address AddressV1optional

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

City string

City, district, suburb, town, or village.

Line1 string

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

PostalCode string

Postal or ZIP code.

State string

Two-letter state code.

Country stringoptional

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

Line2 stringoptional

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

Description stringoptional

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

Industry IndustryV1optional

Category stringoptional

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

Mcc stringoptional

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

Sector stringoptional

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

LegalName stringoptional

The official registered name of the business.

Phone stringoptional

The primary contact phone number for the business.

SupportChannels SupportChannelsV1optional

Email stringoptional

The email address for customer support inquiries.

formatemail

Phone stringoptional

The phone number for customer support.

URL stringoptional

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

formaturi

TaxID stringoptional

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

UseCase stringoptional

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

Capabilities AccountV1DataCapabilitiesoptional

ConsentTypes AccountV1DataCapabilitiesConsentTypes

Internet CapabilityV1

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