Create and manage client accounts
Create the Account
Add Required Related Objects
Representatives
Linked Bank Accounts
Capabilities
Initiate Onboarding
Automate Wisely
Provide Clear Guidance
Implement Webhooks
Secure Data Handling
Offer Support
Field | Type | Description |
---|---|---|
organization_id | string | The unique identifier of the organization this account belongs to. |
account_type | string | The type of account. Currently, only ‘business’ is supported. |
business_profile | object | Detailed information about the business associated with this account. |
business_profile.name | string | The operating or trade name of the business. |
business_profile.website | string | URL of the business’s primary marketing website. |
business_profile.legal_name | string | The official registered name of the business. |
business_profile.description | string | A brief description of the business and its products or services. |
business_profile.use_case | string | A description of how the business intends to use Straddle’s services. |
business_profile.tax_id | string | The business’s tax identification number (e.g., EIN in the US). |
business_profile.phone | string | The primary contact phone number for the business. |
business_profile.address | object | The primary address of the business. |
business_profile.address.line1 | string | Primary address line (e.g., street, PO Box). |
business_profile.address.line2 | string | Secondary address line (e.g., apartment, suite, unit, or building). |
business_profile.address.city | string | City, district, suburb, town, or village. |
business_profile.address.state | string | Two-letter state code. |
business_profile.address.postal_code | string | Postal or ZIP code. |
business_profile.address.country | string | The country of the address, in ISO 3166-1 alpha-2 format. |
business_profile.industry | object | Information about the business’s industry. |
business_profile.industry.mcc | string | The Merchant Category Code (MCC) that best describes the business. |
business_profile.industry.sector | string | The specific sector within the industry category. |
business_profile.industry.category | string | The general category of the industry. |
business_profile.support_channels | object | Contact information for customer support. |
business_profile.support_channels.email | string | The email address for customer support inquiries. |
business_profile.support_channels.phone | string | The phone number for customer support. |
business_profile.support_channels.url | string | The URL of the business’s customer support page or contact form. |
access_level | string | The desired access level for the account. Can be ‘standard’ or ‘managed’. |
metadata | object | Additional key-value pairs for storing extra information about the account. |
external_id | string | Your own unique identifier for the account, useful for cross-referencing. |
Parameter | Type | Required | Description |
---|---|---|---|
account_id | string | Yes | The unique identifier of the account to onboard |
Parameter | Type | Required | Description |
---|---|---|---|
terms_of_service | object | Yes | Information about the user’s acceptance of Straddle’s terms of service |
Field | Type | Required | Description |
---|---|---|---|
accepted_date | string | Yes | The datetime when the terms of service were accepted, in ISO 8601 format (e.g., “2025-03-21T10:30:00Z”) |
agreement_type | enum<string> | Yes | The type or version of the agreement accepted. Available options: embedded , direct Use embedded unless your platform was specifically enabled for direct agreements |
accepted_ip | string | No | The IP address from which the terms of service were accepted |
accepted_user_agent | string | No | The user agent string of the browser or application used to accept the terms |
agreement_url | string | Yes | The URL where the full text of the accepted agreement can be found |
200 OK
response with details about the account.
Status | Description |
---|---|
Created | Initial status when an account is first created. |
Onboarding | The account is going through the onboarding process. |
Active | The account has completed onboarding and is fully operational. |
Rejected | The account has failed the onboarding process or compliance checks. |
Inactive | The account has been temporarily or permanently suspended. |
Created
Onboarding
Active
Rejected
Inactive
status_detail
object provides more granular information about the account’s current status. It includes the following fields:
unverified
: Initial state, pending verificationin_review
: Account is being reviewedpending
: Waiting for additional informationstuck
: Issues in the verification processverified
: Successfully verifiedfailed_verification
: Verification process faileddisabled
: Account has been disabledterminated
: Account has been permanently closedstatus
and status_detail
when handling accounts in your integration. The status_detail
can provide crucial information for resolving issues or proceeding with account management.