# Embed # Accounts ## Lookup an account `client.embed.accounts.get(stringaccountID, AccountGetParamsparams?, RequestOptionsoptions?): AccountV1` **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. ### Parameters - `accountID: string` The unique identifier of the account to retrieve. - `params: AccountGetParams` - `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. ### Returns - `AccountV1` - `data: Data` - `id: string` Unique identifier for the account. - `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. - `"standard"` - `"managed"` - `organization_id: string` The unique identifier of the organization this account belongs to. - `status: "created" | "onboarding" | "active" | 2 more` The current status of the account (e.g., 'active', 'inactive', 'pending'). - `"created"` - `"onboarding"` - `"active"` - `"rejected"` - `"inactive"` - `status_detail: StatusDetail` - `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. - `"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. - `"watchtower"` - `type: "business"` The type of account (e.g., 'individual', 'business'). - `"business"` - `business_profile?: BusinessProfileV1` - `name: string` The operating or trade name of the business. - `website: string` URL of the business's primary marketing website. - `address?: AddressV1 | null` The address object is optional. If provided, it must be a valid address. - `city: string | null` City, district, suburb, town, or village. - `line1: string | null` Primary address line (e.g., street, PO Box). - `postal_code: string | null` Postal or ZIP code. - `state: string | null` Two-letter state code. - `country?: string | null` The country of the address, in ISO 3166-1 alpha-2 format. - `line2?: string | null` Secondary address line (e.g., apartment, suite, unit, or building). - `description?: string | null` A brief description of the business and its products or services. - `industry?: IndustryV1` - `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?: string | null` The email address for customer support inquiries. - `phone?: string | null` The phone number for customer support. - `url?: string | null` The URL of the business's customer support page or contact form. - `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: ConsentTypes` - `internet: CapabilityV1` Whether the internet payment authorization capability is enabled for the account. - `capability_status: "active" | "inactive"` - `"active"` - `"inactive"` - `signed_agreement: CapabilityV1` Whether the signed agreement payment authorization capability is enabled for the account. - `customer_types: CustomerTypes` - `businesses: CapabilityV1` - `individuals: CapabilityV1` - `payment_types: PaymentTypes` - `charges: CapabilityV1` - `payouts: CapabilityV1` - `created_at?: string | null` Timestamp of when the account was created. - `external_id?: string | null` Unique identifier for the account in your database, used for cross-referencing between Straddle and your systems. - `metadata?: Record | null` Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the account in a structured format. - `settings?: Settings` - `charges: Charges` - `daily_amount: number` The maximum dollar amount of charges in a calendar day. - `funding_time: "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. - `"immediate"` - `"next_day"` - `"one_day"` - `"two_day"` - `"three_day"` - `"four_day"` - `"five_day"` - `linked_bank_account_id: string` The unique identifier of the linked bank account associated with charges. This value is defined by Straddle. - `max_amount: number` The maximum amount of a single charge. - `monthly_amount: number` The maximum dollar amount of charges in a calendar month. - `monthly_count: number` The maximum number of charges in a calendar month. - `payouts: Payouts` - `daily_amount: number` The maximum dollar amount of payouts in a day. - `funding_time: "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. - `"immediate"` - `"next_day"` - `"one_day"` - `"two_day"` - `"three_day"` - `"four_day"` - `"five_day"` - `linked_bank_account_id: string` The unique identifier of the linked bank account to use for payouts. - `max_amount: number` The maximum amount of a single payout. - `monthly_amount: number` The maximum dollar amount of payouts in a month. - `monthly_count: number` The maximum number of payouts in a month. - `terms_of_service?: TermsOfServiceV1` - `accepted_date: string` The datetime of when the terms of service were accepted, in ISO 8601 format. - `agreement_type: "embedded" | "direct"` The type or version of the agreement accepted. Use `embedded` unless your platform was specifically enabled for `direct` agreements. - `"embedded"` - `"direct"` - `agreement_url: string | null` The URL where the full text of the accepted agreement can be found. - `accepted_ip?: string | null` The IP address from which the terms of service were accepted. - `accepted_user_agent?: string | null` The user agent string of the browser or application used to accept the terms. - `updated_at?: string | null` Timestamp of the most recent update to the account. - `meta: ResponseMetadata` Metadata about the API request, including an identifier and timestamp. - `api_request_id: string` Unique identifier for this API request, useful for troubleshooting. - `api_request_timestamp: string` Timestamp for this API request, useful for troubleshooting. - `response_type: "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. - `"object"` - `"array"` - `"error"` - `"none"` ### Example ```typescript import Straddle from '@straddlecom/straddle'; const client = new Straddle({ apiKey: process.env['STRADDLE_API_KEY'], // This is the default and can be omitted }); const accountV1 = await client.embed.accounts.get('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e'); console.log(accountV1.data); ``` #### Response ```json { "data": { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "access_level": "standard", "organization_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "status": "created", "status_detail": { "code": "code", "message": "message", "reason": "unverified", "source": "watchtower" }, "type": "business", "business_profile": { "name": "name", "website": "https://example.com", "address": { "city": "city", "line1": "line1", "postal_code": "21029-1360", "state": "SE", "country": "country", "line2": "line2" }, "description": "description", "industry": { "category": "category", "mcc": "mcc", "sector": "sector" }, "legal_name": "legal_name", "phone": "+46991022", "support_channels": { "email": "dev@stainless.com", "phone": "+46991022", "url": "https://example.com" }, "tax_id": "210297980", "use_case": "use_case" }, "capabilities": { "consent_types": { "internet": { "capability_status": "active" }, "signed_agreement": { "capability_status": "active" } }, "customer_types": { "businesses": { "capability_status": "active" }, "individuals": { "capability_status": "active" } }, "payment_types": { "charges": { "capability_status": "active" }, "payouts": { "capability_status": "active" } } }, "created_at": "2019-12-27T18:11:19.117Z", "external_id": "external_id", "metadata": { "foo": "string" }, "settings": { "charges": { "daily_amount": 0, "funding_time": "immediate", "linked_bank_account_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "max_amount": 0, "monthly_amount": 0, "monthly_count": 0 }, "payouts": { "daily_amount": 0, "funding_time": "immediate", "linked_bank_account_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "max_amount": 0, "monthly_amount": 0, "monthly_count": 0 } }, "terms_of_service": { "accepted_date": "2019-12-27T18:11:19.117Z", "agreement_type": "embedded", "agreement_url": "agreement_url", "accepted_ip": "accepted_ip", "accepted_user_agent": "accepted_user_agent" }, "updated_at": "2019-12-27T18:11:19.117Z" }, "meta": { "api_request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "api_request_timestamp": "2019-12-27T18:11:19.117Z" }, "response_type": "object" } ``` ## Update an account `client.embed.accounts.update(stringaccountID, AccountUpdateParamsparams, RequestOptionsoptions?): AccountV1` **put** `/v1/accounts/{account_id}` Updates an existing account's information. This endpoint allows you to update various account details during onboarding or after the account has been created. ### Parameters - `accountID: string` - `params: AccountUpdateParams` - `business_profile: BusinessProfileV1` Body param - `name: string` The operating or trade name of the business. - `website: string` URL of the business's primary marketing website. - `address?: AddressV1 | null` The address object is optional. If provided, it must be a valid address. - `city: string | null` City, district, suburb, town, or village. - `line1: string | null` Primary address line (e.g., street, PO Box). - `postal_code: string | null` Postal or ZIP code. - `state: string | null` Two-letter state code. - `country?: string | null` The country of the address, in ISO 3166-1 alpha-2 format. - `line2?: string | null` Secondary address line (e.g., apartment, suite, unit, or building). - `description?: string | null` A brief description of the business and its products or services. - `industry?: IndustryV1` - `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?: string | null` The email address for customer support inquiries. - `phone?: string | null` The phone number for customer support. - `url?: string | null` The URL of the business's customer support page or contact form. - `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. - `external_id?: string | null` Body param: Unique identifier for the account in your database, used for cross-referencing between Straddle and your systems. - `metadata?: Record | null` Body param: Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the account in a structured format. - `correlationID?: string` Header param: Optional client generated identifier to trace and debug a series of requests. - `idempotencyKey?: string` Header param: Optional client generated value to use for idempotent requests. - `requestID?: string` Header param: Optional client generated identifier to trace and debug a request. ### Returns - `AccountV1` - `data: Data` - `id: string` Unique identifier for the account. - `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. - `"standard"` - `"managed"` - `organization_id: string` The unique identifier of the organization this account belongs to. - `status: "created" | "onboarding" | "active" | 2 more` The current status of the account (e.g., 'active', 'inactive', 'pending'). - `"created"` - `"onboarding"` - `"active"` - `"rejected"` - `"inactive"` - `status_detail: StatusDetail` - `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. - `"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. - `"watchtower"` - `type: "business"` The type of account (e.g., 'individual', 'business'). - `"business"` - `business_profile?: BusinessProfileV1` - `name: string` The operating or trade name of the business. - `website: string` URL of the business's primary marketing website. - `address?: AddressV1 | null` The address object is optional. If provided, it must be a valid address. - `city: string | null` City, district, suburb, town, or village. - `line1: string | null` Primary address line (e.g., street, PO Box). - `postal_code: string | null` Postal or ZIP code. - `state: string | null` Two-letter state code. - `country?: string | null` The country of the address, in ISO 3166-1 alpha-2 format. - `line2?: string | null` Secondary address line (e.g., apartment, suite, unit, or building). - `description?: string | null` A brief description of the business and its products or services. - `industry?: IndustryV1` - `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?: string | null` The email address for customer support inquiries. - `phone?: string | null` The phone number for customer support. - `url?: string | null` The URL of the business's customer support page or contact form. - `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: ConsentTypes` - `internet: CapabilityV1` Whether the internet payment authorization capability is enabled for the account. - `capability_status: "active" | "inactive"` - `"active"` - `"inactive"` - `signed_agreement: CapabilityV1` Whether the signed agreement payment authorization capability is enabled for the account. - `customer_types: CustomerTypes` - `businesses: CapabilityV1` - `individuals: CapabilityV1` - `payment_types: PaymentTypes` - `charges: CapabilityV1` - `payouts: CapabilityV1` - `created_at?: string | null` Timestamp of when the account was created. - `external_id?: string | null` Unique identifier for the account in your database, used for cross-referencing between Straddle and your systems. - `metadata?: Record | null` Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the account in a structured format. - `settings?: Settings` - `charges: Charges` - `daily_amount: number` The maximum dollar amount of charges in a calendar day. - `funding_time: "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. - `"immediate"` - `"next_day"` - `"one_day"` - `"two_day"` - `"three_day"` - `"four_day"` - `"five_day"` - `linked_bank_account_id: string` The unique identifier of the linked bank account associated with charges. This value is defined by Straddle. - `max_amount: number` The maximum amount of a single charge. - `monthly_amount: number` The maximum dollar amount of charges in a calendar month. - `monthly_count: number` The maximum number of charges in a calendar month. - `payouts: Payouts` - `daily_amount: number` The maximum dollar amount of payouts in a day. - `funding_time: "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. - `"immediate"` - `"next_day"` - `"one_day"` - `"two_day"` - `"three_day"` - `"four_day"` - `"five_day"` - `linked_bank_account_id: string` The unique identifier of the linked bank account to use for payouts. - `max_amount: number` The maximum amount of a single payout. - `monthly_amount: number` The maximum dollar amount of payouts in a month. - `monthly_count: number` The maximum number of payouts in a month. - `terms_of_service?: TermsOfServiceV1` - `accepted_date: string` The datetime of when the terms of service were accepted, in ISO 8601 format. - `agreement_type: "embedded" | "direct"` The type or version of the agreement accepted. Use `embedded` unless your platform was specifically enabled for `direct` agreements. - `"embedded"` - `"direct"` - `agreement_url: string | null` The URL where the full text of the accepted agreement can be found. - `accepted_ip?: string | null` The IP address from which the terms of service were accepted. - `accepted_user_agent?: string | null` The user agent string of the browser or application used to accept the terms. - `updated_at?: string | null` Timestamp of the most recent update to the account. - `meta: ResponseMetadata` Metadata about the API request, including an identifier and timestamp. - `api_request_id: string` Unique identifier for this API request, useful for troubleshooting. - `api_request_timestamp: string` Timestamp for this API request, useful for troubleshooting. - `response_type: "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. - `"object"` - `"array"` - `"error"` - `"none"` ### Example ```typescript import Straddle from '@straddlecom/straddle'; const client = new Straddle({ apiKey: process.env['STRADDLE_API_KEY'], // This is the default and can be omitted }); const accountV1 = await client.embed.accounts.update('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', { business_profile: { name: 'name', website: 'https://example.com' }, }); console.log(accountV1.data); ``` #### Response ```json { "data": { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "access_level": "standard", "organization_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "status": "created", "status_detail": { "code": "code", "message": "message", "reason": "unverified", "source": "watchtower" }, "type": "business", "business_profile": { "name": "name", "website": "https://example.com", "address": { "city": "city", "line1": "line1", "postal_code": "21029-1360", "state": "SE", "country": "country", "line2": "line2" }, "description": "description", "industry": { "category": "category", "mcc": "mcc", "sector": "sector" }, "legal_name": "legal_name", "phone": "+46991022", "support_channels": { "email": "dev@stainless.com", "phone": "+46991022", "url": "https://example.com" }, "tax_id": "210297980", "use_case": "use_case" }, "capabilities": { "consent_types": { "internet": { "capability_status": "active" }, "signed_agreement": { "capability_status": "active" } }, "customer_types": { "businesses": { "capability_status": "active" }, "individuals": { "capability_status": "active" } }, "payment_types": { "charges": { "capability_status": "active" }, "payouts": { "capability_status": "active" } } }, "created_at": "2019-12-27T18:11:19.117Z", "external_id": "external_id", "metadata": { "foo": "string" }, "settings": { "charges": { "daily_amount": 0, "funding_time": "immediate", "linked_bank_account_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "max_amount": 0, "monthly_amount": 0, "monthly_count": 0 }, "payouts": { "daily_amount": 0, "funding_time": "immediate", "linked_bank_account_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "max_amount": 0, "monthly_amount": 0, "monthly_count": 0 } }, "terms_of_service": { "accepted_date": "2019-12-27T18:11:19.117Z", "agreement_type": "embedded", "agreement_url": "agreement_url", "accepted_ip": "accepted_ip", "accepted_user_agent": "accepted_user_agent" }, "updated_at": "2019-12-27T18:11:19.117Z" }, "meta": { "api_request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "api_request_timestamp": "2019-12-27T18:11:19.117Z" }, "response_type": "object" } ``` ## Create an account `client.embed.accounts.create(AccountCreateParamsparams, RequestOptionsoptions?): AccountV1` **post** `/v1/accounts` Creates a new account associated with your Straddle platform integration. This endpoint allows you to set up an account with specified details, including business information and access levels. ### Parameters - `params: AccountCreateParams` - `access_level: "standard" | "managed"` Body param: The access level granted to the account. This is determined by your platform configuration. Use `standard` unless instructed otherwise by Straddle. - `"standard"` - `"managed"` - `account_type: "business"` Body param: The type of account to be created. Currently, only `business` is supported. - `"business"` - `business_profile: BusinessProfileV1` Body param - `name: string` The operating or trade name of the business. - `website: string` URL of the business's primary marketing website. - `address?: AddressV1 | null` The address object is optional. If provided, it must be a valid address. - `city: string | null` City, district, suburb, town, or village. - `line1: string | null` Primary address line (e.g., street, PO Box). - `postal_code: string | null` Postal or ZIP code. - `state: string | null` Two-letter state code. - `country?: string | null` The country of the address, in ISO 3166-1 alpha-2 format. - `line2?: string | null` Secondary address line (e.g., apartment, suite, unit, or building). - `description?: string | null` A brief description of the business and its products or services. - `industry?: IndustryV1` - `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?: string | null` The email address for customer support inquiries. - `phone?: string | null` The phone number for customer support. - `url?: string | null` The URL of the business's customer support page or contact form. - `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. - `organization_id: string` Body param: The unique identifier of the organization related to this account. - `external_id?: string | null` Body param: Unique identifier for the account in your database, used for cross-referencing between Straddle and your systems. - `metadata?: Record | null` Body param: Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the account in a structured format. - `correlationID?: string` Header param: Optional client generated identifier to trace and debug a series of requests. - `idempotencyKey?: string` Header param: Optional client generated value to use for idempotent requests. - `requestID?: string` Header param: Optional client generated identifier to trace and debug a request. ### Returns - `AccountV1` - `data: Data` - `id: string` Unique identifier for the account. - `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. - `"standard"` - `"managed"` - `organization_id: string` The unique identifier of the organization this account belongs to. - `status: "created" | "onboarding" | "active" | 2 more` The current status of the account (e.g., 'active', 'inactive', 'pending'). - `"created"` - `"onboarding"` - `"active"` - `"rejected"` - `"inactive"` - `status_detail: StatusDetail` - `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. - `"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. - `"watchtower"` - `type: "business"` The type of account (e.g., 'individual', 'business'). - `"business"` - `business_profile?: BusinessProfileV1` - `name: string` The operating or trade name of the business. - `website: string` URL of the business's primary marketing website. - `address?: AddressV1 | null` The address object is optional. If provided, it must be a valid address. - `city: string | null` City, district, suburb, town, or village. - `line1: string | null` Primary address line (e.g., street, PO Box). - `postal_code: string | null` Postal or ZIP code. - `state: string | null` Two-letter state code. - `country?: string | null` The country of the address, in ISO 3166-1 alpha-2 format. - `line2?: string | null` Secondary address line (e.g., apartment, suite, unit, or building). - `description?: string | null` A brief description of the business and its products or services. - `industry?: IndustryV1` - `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?: string | null` The email address for customer support inquiries. - `phone?: string | null` The phone number for customer support. - `url?: string | null` The URL of the business's customer support page or contact form. - `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: ConsentTypes` - `internet: CapabilityV1` Whether the internet payment authorization capability is enabled for the account. - `capability_status: "active" | "inactive"` - `"active"` - `"inactive"` - `signed_agreement: CapabilityV1` Whether the signed agreement payment authorization capability is enabled for the account. - `customer_types: CustomerTypes` - `businesses: CapabilityV1` - `individuals: CapabilityV1` - `payment_types: PaymentTypes` - `charges: CapabilityV1` - `payouts: CapabilityV1` - `created_at?: string | null` Timestamp of when the account was created. - `external_id?: string | null` Unique identifier for the account in your database, used for cross-referencing between Straddle and your systems. - `metadata?: Record | null` Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the account in a structured format. - `settings?: Settings` - `charges: Charges` - `daily_amount: number` The maximum dollar amount of charges in a calendar day. - `funding_time: "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. - `"immediate"` - `"next_day"` - `"one_day"` - `"two_day"` - `"three_day"` - `"four_day"` - `"five_day"` - `linked_bank_account_id: string` The unique identifier of the linked bank account associated with charges. This value is defined by Straddle. - `max_amount: number` The maximum amount of a single charge. - `monthly_amount: number` The maximum dollar amount of charges in a calendar month. - `monthly_count: number` The maximum number of charges in a calendar month. - `payouts: Payouts` - `daily_amount: number` The maximum dollar amount of payouts in a day. - `funding_time: "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. - `"immediate"` - `"next_day"` - `"one_day"` - `"two_day"` - `"three_day"` - `"four_day"` - `"five_day"` - `linked_bank_account_id: string` The unique identifier of the linked bank account to use for payouts. - `max_amount: number` The maximum amount of a single payout. - `monthly_amount: number` The maximum dollar amount of payouts in a month. - `monthly_count: number` The maximum number of payouts in a month. - `terms_of_service?: TermsOfServiceV1` - `accepted_date: string` The datetime of when the terms of service were accepted, in ISO 8601 format. - `agreement_type: "embedded" | "direct"` The type or version of the agreement accepted. Use `embedded` unless your platform was specifically enabled for `direct` agreements. - `"embedded"` - `"direct"` - `agreement_url: string | null` The URL where the full text of the accepted agreement can be found. - `accepted_ip?: string | null` The IP address from which the terms of service were accepted. - `accepted_user_agent?: string | null` The user agent string of the browser or application used to accept the terms. - `updated_at?: string | null` Timestamp of the most recent update to the account. - `meta: ResponseMetadata` Metadata about the API request, including an identifier and timestamp. - `api_request_id: string` Unique identifier for this API request, useful for troubleshooting. - `api_request_timestamp: string` Timestamp for this API request, useful for troubleshooting. - `response_type: "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. - `"object"` - `"array"` - `"error"` - `"none"` ### Example ```typescript import Straddle from '@straddlecom/straddle'; const client = new Straddle({ apiKey: process.env['STRADDLE_API_KEY'], // This is the default and can be omitted }); const accountV1 = await client.embed.accounts.create({ access_level: 'standard', account_type: 'business', business_profile: { name: 'name', website: 'https://example.com' }, organization_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', }); console.log(accountV1.data); ``` #### Response ```json { "data": { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "access_level": "standard", "organization_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "status": "created", "status_detail": { "code": "code", "message": "message", "reason": "unverified", "source": "watchtower" }, "type": "business", "business_profile": { "name": "name", "website": "https://example.com", "address": { "city": "city", "line1": "line1", "postal_code": "21029-1360", "state": "SE", "country": "country", "line2": "line2" }, "description": "description", "industry": { "category": "category", "mcc": "mcc", "sector": "sector" }, "legal_name": "legal_name", "phone": "+46991022", "support_channels": { "email": "dev@stainless.com", "phone": "+46991022", "url": "https://example.com" }, "tax_id": "210297980", "use_case": "use_case" }, "capabilities": { "consent_types": { "internet": { "capability_status": "active" }, "signed_agreement": { "capability_status": "active" } }, "customer_types": { "businesses": { "capability_status": "active" }, "individuals": { "capability_status": "active" } }, "payment_types": { "charges": { "capability_status": "active" }, "payouts": { "capability_status": "active" } } }, "created_at": "2019-12-27T18:11:19.117Z", "external_id": "external_id", "metadata": { "foo": "string" }, "settings": { "charges": { "daily_amount": 0, "funding_time": "immediate", "linked_bank_account_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "max_amount": 0, "monthly_amount": 0, "monthly_count": 0 }, "payouts": { "daily_amount": 0, "funding_time": "immediate", "linked_bank_account_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "max_amount": 0, "monthly_amount": 0, "monthly_count": 0 } }, "terms_of_service": { "accepted_date": "2019-12-27T18:11:19.117Z", "agreement_type": "embedded", "agreement_url": "agreement_url", "accepted_ip": "accepted_ip", "accepted_user_agent": "accepted_user_agent" }, "updated_at": "2019-12-27T18:11:19.117Z" }, "meta": { "api_request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "api_request_timestamp": "2019-12-27T18:11:19.117Z" }, "response_type": "object" } ``` ## List accounts `client.embed.accounts.list(AccountListParamsparams?, RequestOptionsoptions?): PageNumberSchema` **get** `/v1/accounts` Returns a list of accounts associated with your Straddle platform integration. The accounts are returned sorted by creation date, with the most recently created accounts appearing first. This endpoint supports advanced sorting and filtering options. ### Parameters - `params: AccountListParams` - `page_number?: number` Query param: Results page number. Starts at page 1. Default value: 1 - `page_size?: number` Query param: Page size. Default value: 100. Max value: 1000 - `search_text?: string` Query param - `sort_by?: string` Query param: Sort By. Default value: 'id'. - `sort_order?: "asc" | "desc"` Query param: Sort Order. Default value: 'asc'. - `"asc"` - `"desc"` - `status?: "created" | "onboarding" | "active" | 2 more` Query param - `"created"` - `"onboarding"` - `"active"` - `"rejected"` - `"inactive"` - `type?: "business"` Query param - `"business"` - `correlationID?: string` Header param: Optional client generated identifier to trace and debug a series of requests. - `requestID?: string` Header param: Optional client generated identifier to trace and debug a request. ### Returns - `Data` - `id: string` Unique identifier for the account. - `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. - `"standard"` - `"managed"` - `organization_id: string` The unique identifier of the organization this account belongs to. - `status: "created" | "onboarding" | "active" | 2 more` The current status of the account (e.g., 'active', 'inactive', 'pending'). - `"created"` - `"onboarding"` - `"active"` - `"rejected"` - `"inactive"` - `status_detail: StatusDetail` - `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. - `"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. - `"watchtower"` - `type: "business"` The type of account (e.g., 'individual', 'business'). - `"business"` - `business_profile?: BusinessProfileV1` - `name: string` The operating or trade name of the business. - `website: string` URL of the business's primary marketing website. - `address?: AddressV1 | null` The address object is optional. If provided, it must be a valid address. - `city: string | null` City, district, suburb, town, or village. - `line1: string | null` Primary address line (e.g., street, PO Box). - `postal_code: string | null` Postal or ZIP code. - `state: string | null` Two-letter state code. - `country?: string | null` The country of the address, in ISO 3166-1 alpha-2 format. - `line2?: string | null` Secondary address line (e.g., apartment, suite, unit, or building). - `description?: string | null` A brief description of the business and its products or services. - `industry?: IndustryV1` - `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?: string | null` The email address for customer support inquiries. - `phone?: string | null` The phone number for customer support. - `url?: string | null` The URL of the business's customer support page or contact form. - `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: ConsentTypes` - `internet: CapabilityV1` Whether the internet payment authorization capability is enabled for the account. - `capability_status: "active" | "inactive"` - `"active"` - `"inactive"` - `signed_agreement: CapabilityV1` Whether the signed agreement payment authorization capability is enabled for the account. - `customer_types: CustomerTypes` - `businesses: CapabilityV1` - `individuals: CapabilityV1` - `payment_types: PaymentTypes` - `charges: CapabilityV1` - `payouts: CapabilityV1` - `created_at?: string | null` Timestamp of when the account was created. - `external_id?: string | null` Unique identifier for the account in your database, used for cross-referencing between Straddle and your systems. - `metadata?: Record | null` Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the account in a structured format. - `settings?: Settings` - `charges: Charges` - `daily_amount: number` The maximum dollar amount of charges in a calendar day. - `funding_time: "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. - `"immediate"` - `"next_day"` - `"one_day"` - `"two_day"` - `"three_day"` - `"four_day"` - `"five_day"` - `linked_bank_account_id: string` The unique identifier of the linked bank account associated with charges. This value is defined by Straddle. - `max_amount: number` The maximum amount of a single charge. - `monthly_amount: number` The maximum dollar amount of charges in a calendar month. - `monthly_count: number` The maximum number of charges in a calendar month. - `payouts: Payouts` - `daily_amount: number` The maximum dollar amount of payouts in a day. - `funding_time: "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. - `"immediate"` - `"next_day"` - `"one_day"` - `"two_day"` - `"three_day"` - `"four_day"` - `"five_day"` - `linked_bank_account_id: string` The unique identifier of the linked bank account to use for payouts. - `max_amount: number` The maximum amount of a single payout. - `monthly_amount: number` The maximum dollar amount of payouts in a month. - `monthly_count: number` The maximum number of payouts in a month. - `terms_of_service?: TermsOfServiceV1` - `accepted_date: string` The datetime of when the terms of service were accepted, in ISO 8601 format. - `agreement_type: "embedded" | "direct"` The type or version of the agreement accepted. Use `embedded` unless your platform was specifically enabled for `direct` agreements. - `"embedded"` - `"direct"` - `agreement_url: string | null` The URL where the full text of the accepted agreement can be found. - `accepted_ip?: string | null` The IP address from which the terms of service were accepted. - `accepted_user_agent?: string | null` The user agent string of the browser or application used to accept the terms. - `updated_at?: string | null` Timestamp of the most recent update to the account. ### Example ```typescript import Straddle from '@straddlecom/straddle'; const client = new Straddle({ apiKey: process.env['STRADDLE_API_KEY'], // This is the default and can be omitted }); // Automatically fetches more pages as needed. for await (const account of client.embed.accounts.list()) { console.log(account.id); } ``` #### Response ```json { "data": [ { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "access_level": "standard", "organization_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "status": "created", "status_detail": { "code": "code", "message": "message", "reason": "unverified", "source": "watchtower" }, "type": "business", "business_profile": { "name": "name", "website": "https://example.com", "address": { "city": "city", "line1": "line1", "postal_code": "21029-1360", "state": "SE", "country": "country", "line2": "line2" }, "description": "description", "industry": { "category": "category", "mcc": "mcc", "sector": "sector" }, "legal_name": "legal_name", "phone": "+46991022", "support_channels": { "email": "dev@stainless.com", "phone": "+46991022", "url": "https://example.com" }, "tax_id": "210297980", "use_case": "use_case" }, "capabilities": { "consent_types": { "internet": { "capability_status": "active" }, "signed_agreement": { "capability_status": "active" } }, "customer_types": { "businesses": { "capability_status": "active" }, "individuals": { "capability_status": "active" } }, "payment_types": { "charges": { "capability_status": "active" }, "payouts": { "capability_status": "active" } } }, "created_at": "2019-12-27T18:11:19.117Z", "external_id": "external_id", "metadata": { "foo": "string" }, "settings": { "charges": { "daily_amount": 0, "funding_time": "immediate", "linked_bank_account_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "max_amount": 0, "monthly_amount": 0, "monthly_count": 0 }, "payouts": { "daily_amount": 0, "funding_time": "immediate", "linked_bank_account_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "max_amount": 0, "monthly_amount": 0, "monthly_count": 0 } }, "terms_of_service": { "accepted_date": "2019-12-27T18:11:19.117Z", "agreement_type": "embedded", "agreement_url": "agreement_url", "accepted_ip": "accepted_ip", "accepted_user_agent": "accepted_user_agent" }, "updated_at": "2019-12-27T18:11:19.117Z" } ], "meta": { "api_request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "api_request_timestamp": "2019-12-27T18:11:19.117Z", "max_page_size": 0, "page_number": 0, "page_size": 0, "sort_by": "sort_by", "sort_order": "asc", "total_items": 0, "total_pages": 0 }, "response_type": "object" } ``` ## Onboard an account `client.embed.accounts.onboard(stringaccountID, AccountOnboardParamsparams, RequestOptionsoptions?): AccountV1` **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. ### Parameters - `accountID: string` - `params: AccountOnboardParams` - `terms_of_service: TermsOfServiceV1` Body param - `accepted_date: string` The datetime of when the terms of service were accepted, in ISO 8601 format. - `agreement_type: "embedded" | "direct"` The type or version of the agreement accepted. Use `embedded` unless your platform was specifically enabled for `direct` agreements. - `"embedded"` - `"direct"` - `agreement_url: string | null` The URL where the full text of the accepted agreement can be found. - `accepted_ip?: string | null` The IP address from which the terms of service were accepted. - `accepted_user_agent?: string | null` The user agent string of the browser or application used to accept the terms. - `correlationID?: string` Header param: Optional client generated identifier to trace and debug a series of requests. - `idempotencyKey?: string` Header param: Optional client generated value to use for idempotent requests. - `requestID?: string` Header param: Optional client generated identifier to trace and debug a request. ### Returns - `AccountV1` - `data: Data` - `id: string` Unique identifier for the account. - `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. - `"standard"` - `"managed"` - `organization_id: string` The unique identifier of the organization this account belongs to. - `status: "created" | "onboarding" | "active" | 2 more` The current status of the account (e.g., 'active', 'inactive', 'pending'). - `"created"` - `"onboarding"` - `"active"` - `"rejected"` - `"inactive"` - `status_detail: StatusDetail` - `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. - `"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. - `"watchtower"` - `type: "business"` The type of account (e.g., 'individual', 'business'). - `"business"` - `business_profile?: BusinessProfileV1` - `name: string` The operating or trade name of the business. - `website: string` URL of the business's primary marketing website. - `address?: AddressV1 | null` The address object is optional. If provided, it must be a valid address. - `city: string | null` City, district, suburb, town, or village. - `line1: string | null` Primary address line (e.g., street, PO Box). - `postal_code: string | null` Postal or ZIP code. - `state: string | null` Two-letter state code. - `country?: string | null` The country of the address, in ISO 3166-1 alpha-2 format. - `line2?: string | null` Secondary address line (e.g., apartment, suite, unit, or building). - `description?: string | null` A brief description of the business and its products or services. - `industry?: IndustryV1` - `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?: string | null` The email address for customer support inquiries. - `phone?: string | null` The phone number for customer support. - `url?: string | null` The URL of the business's customer support page or contact form. - `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: ConsentTypes` - `internet: CapabilityV1` Whether the internet payment authorization capability is enabled for the account. - `capability_status: "active" | "inactive"` - `"active"` - `"inactive"` - `signed_agreement: CapabilityV1` Whether the signed agreement payment authorization capability is enabled for the account. - `customer_types: CustomerTypes` - `businesses: CapabilityV1` - `individuals: CapabilityV1` - `payment_types: PaymentTypes` - `charges: CapabilityV1` - `payouts: CapabilityV1` - `created_at?: string | null` Timestamp of when the account was created. - `external_id?: string | null` Unique identifier for the account in your database, used for cross-referencing between Straddle and your systems. - `metadata?: Record | null` Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the account in a structured format. - `settings?: Settings` - `charges: Charges` - `daily_amount: number` The maximum dollar amount of charges in a calendar day. - `funding_time: "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. - `"immediate"` - `"next_day"` - `"one_day"` - `"two_day"` - `"three_day"` - `"four_day"` - `"five_day"` - `linked_bank_account_id: string` The unique identifier of the linked bank account associated with charges. This value is defined by Straddle. - `max_amount: number` The maximum amount of a single charge. - `monthly_amount: number` The maximum dollar amount of charges in a calendar month. - `monthly_count: number` The maximum number of charges in a calendar month. - `payouts: Payouts` - `daily_amount: number` The maximum dollar amount of payouts in a day. - `funding_time: "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. - `"immediate"` - `"next_day"` - `"one_day"` - `"two_day"` - `"three_day"` - `"four_day"` - `"five_day"` - `linked_bank_account_id: string` The unique identifier of the linked bank account to use for payouts. - `max_amount: number` The maximum amount of a single payout. - `monthly_amount: number` The maximum dollar amount of payouts in a month. - `monthly_count: number` The maximum number of payouts in a month. - `terms_of_service?: TermsOfServiceV1` - `accepted_date: string` The datetime of when the terms of service were accepted, in ISO 8601 format. - `agreement_type: "embedded" | "direct"` The type or version of the agreement accepted. Use `embedded` unless your platform was specifically enabled for `direct` agreements. - `"embedded"` - `"direct"` - `agreement_url: string | null` The URL where the full text of the accepted agreement can be found. - `accepted_ip?: string | null` The IP address from which the terms of service were accepted. - `accepted_user_agent?: string | null` The user agent string of the browser or application used to accept the terms. - `updated_at?: string | null` Timestamp of the most recent update to the account. - `meta: ResponseMetadata` Metadata about the API request, including an identifier and timestamp. - `api_request_id: string` Unique identifier for this API request, useful for troubleshooting. - `api_request_timestamp: string` Timestamp for this API request, useful for troubleshooting. - `response_type: "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. - `"object"` - `"array"` - `"error"` - `"none"` ### Example ```typescript import Straddle from '@straddlecom/straddle'; const client = new Straddle({ apiKey: process.env['STRADDLE_API_KEY'], // This is the default and can be omitted }); const accountV1 = await client.embed.accounts.onboard('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', { terms_of_service: { accepted_date: '2019-12-27T18:11:19.117Z', agreement_type: 'embedded', agreement_url: 'agreement_url', }, }); console.log(accountV1.data); ``` #### Response ```json { "data": { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "access_level": "standard", "organization_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "status": "created", "status_detail": { "code": "code", "message": "message", "reason": "unverified", "source": "watchtower" }, "type": "business", "business_profile": { "name": "name", "website": "https://example.com", "address": { "city": "city", "line1": "line1", "postal_code": "21029-1360", "state": "SE", "country": "country", "line2": "line2" }, "description": "description", "industry": { "category": "category", "mcc": "mcc", "sector": "sector" }, "legal_name": "legal_name", "phone": "+46991022", "support_channels": { "email": "dev@stainless.com", "phone": "+46991022", "url": "https://example.com" }, "tax_id": "210297980", "use_case": "use_case" }, "capabilities": { "consent_types": { "internet": { "capability_status": "active" }, "signed_agreement": { "capability_status": "active" } }, "customer_types": { "businesses": { "capability_status": "active" }, "individuals": { "capability_status": "active" } }, "payment_types": { "charges": { "capability_status": "active" }, "payouts": { "capability_status": "active" } } }, "created_at": "2019-12-27T18:11:19.117Z", "external_id": "external_id", "metadata": { "foo": "string" }, "settings": { "charges": { "daily_amount": 0, "funding_time": "immediate", "linked_bank_account_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "max_amount": 0, "monthly_amount": 0, "monthly_count": 0 }, "payouts": { "daily_amount": 0, "funding_time": "immediate", "linked_bank_account_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "max_amount": 0, "monthly_amount": 0, "monthly_count": 0 } }, "terms_of_service": { "accepted_date": "2019-12-27T18:11:19.117Z", "agreement_type": "embedded", "agreement_url": "agreement_url", "accepted_ip": "accepted_ip", "accepted_user_agent": "accepted_user_agent" }, "updated_at": "2019-12-27T18:11:19.117Z" }, "meta": { "api_request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "api_request_timestamp": "2019-12-27T18:11:19.117Z" }, "response_type": "object" } ``` ## Simulate status transitions for a sandbox account `client.embed.accounts.simulate(stringaccountID, AccountSimulateParamsparams?, RequestOptionsoptions?): AccountV1` **post** `/v1/accounts/{account_id}/simulate` Simulate the status transitions for sandbox accounts. This endpoint can only be used for sandbox accounts. ### Parameters - `accountID: string` - `params: AccountSimulateParams` - `final_status?: "onboarding" | "active"` Query param - `"onboarding"` - `"active"` - `correlationID?: string` Header param: Optional client generated identifier to trace and debug a series of requests. - `idempotencyKey?: string` Header param: Optional client generated value to use for idempotent requests. - `requestID?: string` Header param: Optional client generated identifier to trace and debug a request. ### Returns - `AccountV1` - `data: Data` - `id: string` Unique identifier for the account. - `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. - `"standard"` - `"managed"` - `organization_id: string` The unique identifier of the organization this account belongs to. - `status: "created" | "onboarding" | "active" | 2 more` The current status of the account (e.g., 'active', 'inactive', 'pending'). - `"created"` - `"onboarding"` - `"active"` - `"rejected"` - `"inactive"` - `status_detail: StatusDetail` - `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. - `"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. - `"watchtower"` - `type: "business"` The type of account (e.g., 'individual', 'business'). - `"business"` - `business_profile?: BusinessProfileV1` - `name: string` The operating or trade name of the business. - `website: string` URL of the business's primary marketing website. - `address?: AddressV1 | null` The address object is optional. If provided, it must be a valid address. - `city: string | null` City, district, suburb, town, or village. - `line1: string | null` Primary address line (e.g., street, PO Box). - `postal_code: string | null` Postal or ZIP code. - `state: string | null` Two-letter state code. - `country?: string | null` The country of the address, in ISO 3166-1 alpha-2 format. - `line2?: string | null` Secondary address line (e.g., apartment, suite, unit, or building). - `description?: string | null` A brief description of the business and its products or services. - `industry?: IndustryV1` - `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?: string | null` The email address for customer support inquiries. - `phone?: string | null` The phone number for customer support. - `url?: string | null` The URL of the business's customer support page or contact form. - `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: ConsentTypes` - `internet: CapabilityV1` Whether the internet payment authorization capability is enabled for the account. - `capability_status: "active" | "inactive"` - `"active"` - `"inactive"` - `signed_agreement: CapabilityV1` Whether the signed agreement payment authorization capability is enabled for the account. - `customer_types: CustomerTypes` - `businesses: CapabilityV1` - `individuals: CapabilityV1` - `payment_types: PaymentTypes` - `charges: CapabilityV1` - `payouts: CapabilityV1` - `created_at?: string | null` Timestamp of when the account was created. - `external_id?: string | null` Unique identifier for the account in your database, used for cross-referencing between Straddle and your systems. - `metadata?: Record | null` Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the account in a structured format. - `settings?: Settings` - `charges: Charges` - `daily_amount: number` The maximum dollar amount of charges in a calendar day. - `funding_time: "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. - `"immediate"` - `"next_day"` - `"one_day"` - `"two_day"` - `"three_day"` - `"four_day"` - `"five_day"` - `linked_bank_account_id: string` The unique identifier of the linked bank account associated with charges. This value is defined by Straddle. - `max_amount: number` The maximum amount of a single charge. - `monthly_amount: number` The maximum dollar amount of charges in a calendar month. - `monthly_count: number` The maximum number of charges in a calendar month. - `payouts: Payouts` - `daily_amount: number` The maximum dollar amount of payouts in a day. - `funding_time: "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. - `"immediate"` - `"next_day"` - `"one_day"` - `"two_day"` - `"three_day"` - `"four_day"` - `"five_day"` - `linked_bank_account_id: string` The unique identifier of the linked bank account to use for payouts. - `max_amount: number` The maximum amount of a single payout. - `monthly_amount: number` The maximum dollar amount of payouts in a month. - `monthly_count: number` The maximum number of payouts in a month. - `terms_of_service?: TermsOfServiceV1` - `accepted_date: string` The datetime of when the terms of service were accepted, in ISO 8601 format. - `agreement_type: "embedded" | "direct"` The type or version of the agreement accepted. Use `embedded` unless your platform was specifically enabled for `direct` agreements. - `"embedded"` - `"direct"` - `agreement_url: string | null` The URL where the full text of the accepted agreement can be found. - `accepted_ip?: string | null` The IP address from which the terms of service were accepted. - `accepted_user_agent?: string | null` The user agent string of the browser or application used to accept the terms. - `updated_at?: string | null` Timestamp of the most recent update to the account. - `meta: ResponseMetadata` Metadata about the API request, including an identifier and timestamp. - `api_request_id: string` Unique identifier for this API request, useful for troubleshooting. - `api_request_timestamp: string` Timestamp for this API request, useful for troubleshooting. - `response_type: "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. - `"object"` - `"array"` - `"error"` - `"none"` ### Example ```typescript import Straddle from '@straddlecom/straddle'; const client = new Straddle({ apiKey: process.env['STRADDLE_API_KEY'], // This is the default and can be omitted }); const accountV1 = await client.embed.accounts.simulate('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e'); console.log(accountV1.data); ``` #### Response ```json { "data": { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "access_level": "standard", "organization_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "status": "created", "status_detail": { "code": "code", "message": "message", "reason": "unverified", "source": "watchtower" }, "type": "business", "business_profile": { "name": "name", "website": "https://example.com", "address": { "city": "city", "line1": "line1", "postal_code": "21029-1360", "state": "SE", "country": "country", "line2": "line2" }, "description": "description", "industry": { "category": "category", "mcc": "mcc", "sector": "sector" }, "legal_name": "legal_name", "phone": "+46991022", "support_channels": { "email": "dev@stainless.com", "phone": "+46991022", "url": "https://example.com" }, "tax_id": "210297980", "use_case": "use_case" }, "capabilities": { "consent_types": { "internet": { "capability_status": "active" }, "signed_agreement": { "capability_status": "active" } }, "customer_types": { "businesses": { "capability_status": "active" }, "individuals": { "capability_status": "active" } }, "payment_types": { "charges": { "capability_status": "active" }, "payouts": { "capability_status": "active" } } }, "created_at": "2019-12-27T18:11:19.117Z", "external_id": "external_id", "metadata": { "foo": "string" }, "settings": { "charges": { "daily_amount": 0, "funding_time": "immediate", "linked_bank_account_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "max_amount": 0, "monthly_amount": 0, "monthly_count": 0 }, "payouts": { "daily_amount": 0, "funding_time": "immediate", "linked_bank_account_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "max_amount": 0, "monthly_amount": 0, "monthly_count": 0 } }, "terms_of_service": { "accepted_date": "2019-12-27T18:11:19.117Z", "agreement_type": "embedded", "agreement_url": "agreement_url", "accepted_ip": "accepted_ip", "accepted_user_agent": "accepted_user_agent" }, "updated_at": "2019-12-27T18:11:19.117Z" }, "meta": { "api_request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "api_request_timestamp": "2019-12-27T18:11:19.117Z" }, "response_type": "object" } ``` ## Domain Types ### Account Paged V1 - `AccountPagedV1` - `data: Array` - `id: string` Unique identifier for the account. - `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. - `"standard"` - `"managed"` - `organization_id: string` The unique identifier of the organization this account belongs to. - `status: "created" | "onboarding" | "active" | 2 more` The current status of the account (e.g., 'active', 'inactive', 'pending'). - `"created"` - `"onboarding"` - `"active"` - `"rejected"` - `"inactive"` - `status_detail: StatusDetail` - `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. - `"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. - `"watchtower"` - `type: "business"` The type of account (e.g., 'individual', 'business'). - `"business"` - `business_profile?: BusinessProfileV1` - `name: string` The operating or trade name of the business. - `website: string` URL of the business's primary marketing website. - `address?: AddressV1 | null` The address object is optional. If provided, it must be a valid address. - `city: string | null` City, district, suburb, town, or village. - `line1: string | null` Primary address line (e.g., street, PO Box). - `postal_code: string | null` Postal or ZIP code. - `state: string | null` Two-letter state code. - `country?: string | null` The country of the address, in ISO 3166-1 alpha-2 format. - `line2?: string | null` Secondary address line (e.g., apartment, suite, unit, or building). - `description?: string | null` A brief description of the business and its products or services. - `industry?: IndustryV1` - `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?: string | null` The email address for customer support inquiries. - `phone?: string | null` The phone number for customer support. - `url?: string | null` The URL of the business's customer support page or contact form. - `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: ConsentTypes` - `internet: CapabilityV1` Whether the internet payment authorization capability is enabled for the account. - `capability_status: "active" | "inactive"` - `"active"` - `"inactive"` - `signed_agreement: CapabilityV1` Whether the signed agreement payment authorization capability is enabled for the account. - `customer_types: CustomerTypes` - `businesses: CapabilityV1` - `individuals: CapabilityV1` - `payment_types: PaymentTypes` - `charges: CapabilityV1` - `payouts: CapabilityV1` - `created_at?: string | null` Timestamp of when the account was created. - `external_id?: string | null` Unique identifier for the account in your database, used for cross-referencing between Straddle and your systems. - `metadata?: Record | null` Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the account in a structured format. - `settings?: Settings` - `charges: Charges` - `daily_amount: number` The maximum dollar amount of charges in a calendar day. - `funding_time: "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. - `"immediate"` - `"next_day"` - `"one_day"` - `"two_day"` - `"three_day"` - `"four_day"` - `"five_day"` - `linked_bank_account_id: string` The unique identifier of the linked bank account associated with charges. This value is defined by Straddle. - `max_amount: number` The maximum amount of a single charge. - `monthly_amount: number` The maximum dollar amount of charges in a calendar month. - `monthly_count: number` The maximum number of charges in a calendar month. - `payouts: Payouts` - `daily_amount: number` The maximum dollar amount of payouts in a day. - `funding_time: "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. - `"immediate"` - `"next_day"` - `"one_day"` - `"two_day"` - `"three_day"` - `"four_day"` - `"five_day"` - `linked_bank_account_id: string` The unique identifier of the linked bank account to use for payouts. - `max_amount: number` The maximum amount of a single payout. - `monthly_amount: number` The maximum dollar amount of payouts in a month. - `monthly_count: number` The maximum number of payouts in a month. - `terms_of_service?: TermsOfServiceV1` - `accepted_date: string` The datetime of when the terms of service were accepted, in ISO 8601 format. - `agreement_type: "embedded" | "direct"` The type or version of the agreement accepted. Use `embedded` unless your platform was specifically enabled for `direct` agreements. - `"embedded"` - `"direct"` - `agreement_url: string | null` The URL where the full text of the accepted agreement can be found. - `accepted_ip?: string | null` The IP address from which the terms of service were accepted. - `accepted_user_agent?: string | null` The user agent string of the browser or application used to accept the terms. - `updated_at?: string | null` Timestamp of the most recent update to the account. - `meta: PagedResponseMetadata` Metadata about the API request, including an identifier, timestamp, and pagination details. - `api_request_id: string` Unique identifier for this API request, useful for troubleshooting. - `api_request_timestamp: string` Timestamp for this API request, useful for troubleshooting. - `max_page_size: number` Maximum allowed page size for this endpoint. - `page_number: number` Page number for paginated results. - `page_size: number` Number of items per page in this response. - `sort_by: string` The field that the results were sorted by. - `sort_order: "asc" | "desc"` - `"asc"` - `"desc"` - `total_items: number` Total number of items returned in this response. - `total_pages: number` The number of pages available. - `response_type: "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. - `"object"` - `"array"` - `"error"` - `"none"` ### Account V1 - `AccountV1` - `data: Data` - `id: string` Unique identifier for the account. - `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. - `"standard"` - `"managed"` - `organization_id: string` The unique identifier of the organization this account belongs to. - `status: "created" | "onboarding" | "active" | 2 more` The current status of the account (e.g., 'active', 'inactive', 'pending'). - `"created"` - `"onboarding"` - `"active"` - `"rejected"` - `"inactive"` - `status_detail: StatusDetail` - `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. - `"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. - `"watchtower"` - `type: "business"` The type of account (e.g., 'individual', 'business'). - `"business"` - `business_profile?: BusinessProfileV1` - `name: string` The operating or trade name of the business. - `website: string` URL of the business's primary marketing website. - `address?: AddressV1 | null` The address object is optional. If provided, it must be a valid address. - `city: string | null` City, district, suburb, town, or village. - `line1: string | null` Primary address line (e.g., street, PO Box). - `postal_code: string | null` Postal or ZIP code. - `state: string | null` Two-letter state code. - `country?: string | null` The country of the address, in ISO 3166-1 alpha-2 format. - `line2?: string | null` Secondary address line (e.g., apartment, suite, unit, or building). - `description?: string | null` A brief description of the business and its products or services. - `industry?: IndustryV1` - `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?: string | null` The email address for customer support inquiries. - `phone?: string | null` The phone number for customer support. - `url?: string | null` The URL of the business's customer support page or contact form. - `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: ConsentTypes` - `internet: CapabilityV1` Whether the internet payment authorization capability is enabled for the account. - `capability_status: "active" | "inactive"` - `"active"` - `"inactive"` - `signed_agreement: CapabilityV1` Whether the signed agreement payment authorization capability is enabled for the account. - `customer_types: CustomerTypes` - `businesses: CapabilityV1` - `individuals: CapabilityV1` - `payment_types: PaymentTypes` - `charges: CapabilityV1` - `payouts: CapabilityV1` - `created_at?: string | null` Timestamp of when the account was created. - `external_id?: string | null` Unique identifier for the account in your database, used for cross-referencing between Straddle and your systems. - `metadata?: Record | null` Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the account in a structured format. - `settings?: Settings` - `charges: Charges` - `daily_amount: number` The maximum dollar amount of charges in a calendar day. - `funding_time: "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. - `"immediate"` - `"next_day"` - `"one_day"` - `"two_day"` - `"three_day"` - `"four_day"` - `"five_day"` - `linked_bank_account_id: string` The unique identifier of the linked bank account associated with charges. This value is defined by Straddle. - `max_amount: number` The maximum amount of a single charge. - `monthly_amount: number` The maximum dollar amount of charges in a calendar month. - `monthly_count: number` The maximum number of charges in a calendar month. - `payouts: Payouts` - `daily_amount: number` The maximum dollar amount of payouts in a day. - `funding_time: "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. - `"immediate"` - `"next_day"` - `"one_day"` - `"two_day"` - `"three_day"` - `"four_day"` - `"five_day"` - `linked_bank_account_id: string` The unique identifier of the linked bank account to use for payouts. - `max_amount: number` The maximum amount of a single payout. - `monthly_amount: number` The maximum dollar amount of payouts in a month. - `monthly_count: number` The maximum number of payouts in a month. - `terms_of_service?: TermsOfServiceV1` - `accepted_date: string` The datetime of when the terms of service were accepted, in ISO 8601 format. - `agreement_type: "embedded" | "direct"` The type or version of the agreement accepted. Use `embedded` unless your platform was specifically enabled for `direct` agreements. - `"embedded"` - `"direct"` - `agreement_url: string | null` The URL where the full text of the accepted agreement can be found. - `accepted_ip?: string | null` The IP address from which the terms of service were accepted. - `accepted_user_agent?: string | null` The user agent string of the browser or application used to accept the terms. - `updated_at?: string | null` Timestamp of the most recent update to the account. - `meta: ResponseMetadata` Metadata about the API request, including an identifier and timestamp. - `api_request_id: string` Unique identifier for this API request, useful for troubleshooting. - `api_request_timestamp: string` Timestamp for this API request, useful for troubleshooting. - `response_type: "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. - `"object"` - `"array"` - `"error"` - `"none"` ### Address V1 - `AddressV1` The address object is optional. If provided, it must be a valid address. - `city: string | null` City, district, suburb, town, or village. - `line1: string | null` Primary address line (e.g., street, PO Box). - `postal_code: string | null` Postal or ZIP code. - `state: string | null` Two-letter state code. - `country?: string | null` The country of the address, in ISO 3166-1 alpha-2 format. - `line2?: string | null` Secondary address line (e.g., apartment, suite, unit, or building). ### Business Profile V1 - `BusinessProfileV1` - `name: string` The operating or trade name of the business. - `website: string` URL of the business's primary marketing website. - `address?: AddressV1 | null` The address object is optional. If provided, it must be a valid address. - `city: string | null` City, district, suburb, town, or village. - `line1: string | null` Primary address line (e.g., street, PO Box). - `postal_code: string | null` Postal or ZIP code. - `state: string | null` Two-letter state code. - `country?: string | null` The country of the address, in ISO 3166-1 alpha-2 format. - `line2?: string | null` Secondary address line (e.g., apartment, suite, unit, or building). - `description?: string | null` A brief description of the business and its products or services. - `industry?: IndustryV1` - `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?: string | null` The email address for customer support inquiries. - `phone?: string | null` The phone number for customer support. - `url?: string | null` The URL of the business's customer support page or contact form. - `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. ### Capability V1 - `CapabilityV1` - `capability_status: "active" | "inactive"` - `"active"` - `"inactive"` ### Industry V1 - `IndustryV1` - `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. ### Support Channels V1 - `SupportChannelsV1` - `email?: string | null` The email address for customer support inquiries. - `phone?: string | null` The phone number for customer support. - `url?: string | null` The URL of the business's customer support page or contact form. ### Terms Of Service V1 - `TermsOfServiceV1` - `accepted_date: string` The datetime of when the terms of service were accepted, in ISO 8601 format. - `agreement_type: "embedded" | "direct"` The type or version of the agreement accepted. Use `embedded` unless your platform was specifically enabled for `direct` agreements. - `"embedded"` - `"direct"` - `agreement_url: string | null` The URL where the full text of the accepted agreement can be found. - `accepted_ip?: string | null` The IP address from which the terms of service were accepted. - `accepted_user_agent?: string | null` The user agent string of the browser or application used to accept the terms. # Capability Requests ## Request a capability `client.embed.accounts.capabilityRequests.create(stringaccountID, CapabilityRequestCreateParamsparams?, RequestOptionsoptions?): CapabilityRequestPagedV1` **post** `/v1/accounts/{account_id}/capability_requests` Submits a request to enable a specific capability for an account. Use this endpoint to request additional features or services for an account. ### Parameters - `accountID: string` - `params: CapabilityRequestCreateParams` - `businesses?: Businesses` Body param: Allows the account to accept payments from businesses. - `enable: boolean` - `charges?: Charges` Body param: The charges capability settings for the account. - `daily_amount: number` The maximum dollar amount of charges in a calendar day. - `enable: boolean` Determines whether `charges` are enabled for the account. - `max_amount: number` The maximum amount of a single charge. - `monthly_amount: number` The maximum dollar amount of charges in a calendar month. - `monthly_count: number` The maximum number of charges in a calendar month. - `individuals?: Individuals` Body param: Allows the account to accept payments from individuals. - `enable: boolean` - `internet?: Internet` Body param: Allows the account to accept payments authorized via the internet or mobile applications. - `enable: boolean` - `payouts?: Payouts` Body param: The payouts capability settings for the account. - `daily_amount: number` The maximum dollar amount of payouts in a day. - `enable: boolean` Determines whether `payouts` are enabled for the account. - `max_amount: number` The maximum amount of a single payout. - `monthly_amount: number` The maximum dollar amount of payouts in a month. - `monthly_count: number` The maximum number of payouts in a month. - `signed_agreement?: SignedAgreement` Body param: Allows the account to accept payments authorized by signed agreements or contracts. - `enable: boolean` - `correlationID?: string` Header param: Optional client generated identifier to trace and debug a series of requests. - `idempotencyKey?: string` Header param: Optional client generated value to use for idempotent requests. - `requestID?: string` Header param: Optional client generated identifier to trace and debug a request. ### Returns - `CapabilityRequestPagedV1` - `data: Array` - `id: string` Unique identifier for the capability request. - `account_id: string` The unique identifier of the account associated with this capability request. - `category: "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. - `"payment_type"` - `"customer_type"` - `"consent_type"` - `created_at: string` Timestamp of when the capability request was created. - `enable: boolean` Whether this capability request is to enable or disable the capability. - `status: "active" | "inactive" | "in_review" | 3 more` The current status of the capability request. - `"active"` - `"inactive"` - `"in_review"` - `"rejected"` - `"approved"` - `"reviewing"` - `type: "charges" | "payouts" | "individuals" | 3 more` The specific type of capability being requested within the category. - `"charges"` - `"payouts"` - `"individuals"` - `"businesses"` - `"signed_agreement"` - `"internet"` - `updated_at: string` Timestamp of the most recent update to the capability request. - `settings?: Record | null` Any specific settings or configurations related to the requested capability. - `meta: PagedResponseMetadata` Metadata about the API request, including an identifier, timestamp, and pagination details. - `api_request_id: string` Unique identifier for this API request, useful for troubleshooting. - `api_request_timestamp: string` Timestamp for this API request, useful for troubleshooting. - `max_page_size: number` Maximum allowed page size for this endpoint. - `page_number: number` Page number for paginated results. - `page_size: number` Number of items per page in this response. - `sort_by: string` The field that the results were sorted by. - `sort_order: "asc" | "desc"` - `"asc"` - `"desc"` - `total_items: number` Total number of items returned in this response. - `total_pages: number` The number of pages available. - `response_type: "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. - `"object"` - `"array"` - `"error"` - `"none"` ### Example ```typescript import Straddle from '@straddlecom/straddle'; const client = new Straddle({ apiKey: process.env['STRADDLE_API_KEY'], // This is the default and can be omitted }); const capabilityRequestPagedV1 = await client.embed.accounts.capabilityRequests.create( '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', ); console.log(capabilityRequestPagedV1.data); ``` #### Response ```json { "data": [ { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "account_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "category": "payment_type", "created_at": "2019-12-27T18:11:19.117Z", "enable": true, "status": "active", "type": "charges", "updated_at": "2019-12-27T18:11:19.117Z", "settings": { "foo": "bar" } } ], "meta": { "api_request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "api_request_timestamp": "2019-12-27T18:11:19.117Z", "max_page_size": 0, "page_number": 0, "page_size": 0, "sort_by": "sort_by", "sort_order": "asc", "total_items": 0, "total_pages": 0 }, "response_type": "object" } ``` ## List capability requests `client.embed.accounts.capabilityRequests.list(stringaccountID, CapabilityRequestListParamsparams?, RequestOptionsoptions?): PageNumberSchema` **get** `/v1/accounts/{account_id}/capability_requests` Retrieves a list of capability requests associated with an account. The requests are returned sorted by creation date, with the most recent requests appearing first. This endpoint supports advanced sorting and filtering options. ### Parameters - `accountID: string` - `params: CapabilityRequestListParams` - `category?: "payment_type" | "customer_type" | "consent_type"` Query param: Filter capability requests by category. - `"payment_type"` - `"customer_type"` - `"consent_type"` - `page_number?: number` Query param: Results page number. Starts at page 1. - `page_size?: number` Query param: Page size.Max value: 1000 - `sort_by?: string` Query param: Sort By. - `sort_order?: "asc" | "desc"` Query param: Sort Order. - `"asc"` - `"desc"` - `status?: "active" | "inactive" | "in_review" | "rejected"` Query param: Filter capability requests by their current status. - `"active"` - `"inactive"` - `"in_review"` - `"rejected"` - `type?: "charges" | "payouts" | "individuals" | 3 more` Query param: Filter capability requests by the specific type of capability. - `"charges"` - `"payouts"` - `"individuals"` - `"businesses"` - `"signed_agreement"` - `"internet"` - `correlationID?: string` Header param: Optional client generated identifier to trace and debug a series of requests. - `requestID?: string` Header param: Optional client generated identifier to trace and debug a request. ### Returns - `Data` - `id: string` Unique identifier for the capability request. - `account_id: string` The unique identifier of the account associated with this capability request. - `category: "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. - `"payment_type"` - `"customer_type"` - `"consent_type"` - `created_at: string` Timestamp of when the capability request was created. - `enable: boolean` Whether this capability request is to enable or disable the capability. - `status: "active" | "inactive" | "in_review" | 3 more` The current status of the capability request. - `"active"` - `"inactive"` - `"in_review"` - `"rejected"` - `"approved"` - `"reviewing"` - `type: "charges" | "payouts" | "individuals" | 3 more` The specific type of capability being requested within the category. - `"charges"` - `"payouts"` - `"individuals"` - `"businesses"` - `"signed_agreement"` - `"internet"` - `updated_at: string` Timestamp of the most recent update to the capability request. - `settings?: Record | null` Any specific settings or configurations related to the requested capability. ### Example ```typescript import Straddle from '@straddlecom/straddle'; const client = new Straddle({ apiKey: process.env['STRADDLE_API_KEY'], // This is the default and can be omitted }); // Automatically fetches more pages as needed. for await (const capabilityRequest of client.embed.accounts.capabilityRequests.list( '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', )) { console.log(capabilityRequest.id); } ``` #### Response ```json { "data": [ { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "account_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "category": "payment_type", "created_at": "2019-12-27T18:11:19.117Z", "enable": true, "status": "active", "type": "charges", "updated_at": "2019-12-27T18:11:19.117Z", "settings": { "foo": "bar" } } ], "meta": { "api_request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "api_request_timestamp": "2019-12-27T18:11:19.117Z", "max_page_size": 0, "page_number": 0, "page_size": 0, "sort_by": "sort_by", "sort_order": "asc", "total_items": 0, "total_pages": 0 }, "response_type": "object" } ``` ## Domain Types ### Capability Request Paged V1 - `CapabilityRequestPagedV1` - `data: Array` - `id: string` Unique identifier for the capability request. - `account_id: string` The unique identifier of the account associated with this capability request. - `category: "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. - `"payment_type"` - `"customer_type"` - `"consent_type"` - `created_at: string` Timestamp of when the capability request was created. - `enable: boolean` Whether this capability request is to enable or disable the capability. - `status: "active" | "inactive" | "in_review" | 3 more` The current status of the capability request. - `"active"` - `"inactive"` - `"in_review"` - `"rejected"` - `"approved"` - `"reviewing"` - `type: "charges" | "payouts" | "individuals" | 3 more` The specific type of capability being requested within the category. - `"charges"` - `"payouts"` - `"individuals"` - `"businesses"` - `"signed_agreement"` - `"internet"` - `updated_at: string` Timestamp of the most recent update to the capability request. - `settings?: Record | null` Any specific settings or configurations related to the requested capability. - `meta: PagedResponseMetadata` Metadata about the API request, including an identifier, timestamp, and pagination details. - `api_request_id: string` Unique identifier for this API request, useful for troubleshooting. - `api_request_timestamp: string` Timestamp for this API request, useful for troubleshooting. - `max_page_size: number` Maximum allowed page size for this endpoint. - `page_number: number` Page number for paginated results. - `page_size: number` Number of items per page in this response. - `sort_by: string` The field that the results were sorted by. - `sort_order: "asc" | "desc"` - `"asc"` - `"desc"` - `total_items: number` Total number of items returned in this response. - `total_pages: number` The number of pages available. - `response_type: "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. - `"object"` - `"array"` - `"error"` - `"none"` # Linked Bank Accounts ## Create a linked bank account `client.embed.linkedBankAccounts.create(LinkedBankAccountCreateParamsparams, RequestOptionsoptions?): LinkedBankAccountV1` **post** `/v1/linked_bank_accounts` Creates a new linked bank account associated with a Straddle account. This endpoint allows you to associate external bank accounts with a Straddle account for various payment operations such as payment deposits, payout withdrawals, and more. ### Parameters - `params: LinkedBankAccountCreateParams` - `account_id: string | null` Body param: The unique identifier of the Straddle account to associate this bank account with. - `bank_account: BankAccount` Body param - `account_holder: string` The name of the account holder as it appears on the bank account. Typically, this is the legal name of the business associated with the account. - `account_number: string` The bank account number. - `routing_number: string` The routing number of the bank account. - `description?: string | null` Body param: Optional description for the bank account. - `metadata?: Record | null` Body param: 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?: string | null` Body param: The unique identifier of the Straddle Platform to associate this bank account with. - `purposes?: Array<"charges" | "payouts" | "billing"> | null` Body param: The purposes for the linked bank account. - `"charges"` - `"payouts"` - `"billing"` - `correlationID?: string` Header param: Optional client generated identifier to trace and debug a series of requests. - `idempotencyKey?: string` Header param: Optional client generated value to use for idempotent requests. - `requestID?: string` Header param: Optional client generated identifier to trace and debug a request. ### Returns - `LinkedBankAccountV1` - `data: Data` - `id: string` Unique identifier for the linked bank account. - `account_id: string | null` The unique identifier of the Straddle account related to this bank account. - `bank_account: BankAccount` - `account_holder: string` - `account_mask: string` - `institution_name: string` - `routing_number: string` - `created_at: string` Timestamp of when the bank account object was created. - `purposes: Array<"charges" | "payouts" | "billing">` The purposes for the linked bank account. - `"charges"` - `"payouts"` - `"billing"` - `status: "created" | "onboarding" | "active" | 3 more` The current status of the linked bank account. - `"created"` - `"onboarding"` - `"active"` - `"rejected"` - `"inactive"` - `"canceled"` - `status_detail: StatusDetail` - `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" | 5 more` A machine-readable identifier for the specific status, useful for programmatic handling. - `"unverified"` - `"in_review"` - `"pending"` - `"stuck"` - `"verified"` - `"failed_verification"` - `"disabled"` - `"new"` - `source: "watchtower"` Identifies the origin of the status change (e.g., `watchtower`). This helps in tracking the cause of status updates. - `"watchtower"` - `updated_at: string` Timestamp of the most recent update to the linked bank account. - `description?: string | null` Optional description for the bank account. - `metadata?: Record | null` 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?: string | null` The unique identifier of the Straddle Platform relatd to this bank account. - `meta: ResponseMetadata` Metadata about the API request, including an identifier and timestamp. - `api_request_id: string` Unique identifier for this API request, useful for troubleshooting. - `api_request_timestamp: string` Timestamp for this API request, useful for troubleshooting. - `response_type: "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. - `"object"` - `"array"` - `"error"` - `"none"` ### Example ```typescript import Straddle from '@straddlecom/straddle'; const client = new Straddle({ apiKey: process.env['STRADDLE_API_KEY'], // This is the default and can be omitted }); const linkedBankAccountV1 = await client.embed.linkedBankAccounts.create({ account_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', bank_account: { account_holder: 'account_holder', account_number: 'account_number', routing_number: 'xxxxxxxxx', }, }); console.log(linkedBankAccountV1.data); ``` #### Response ```json { "data": { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "account_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "bank_account": { "account_holder": "account_holder", "account_mask": "account_mask", "institution_name": "institution_name", "routing_number": "routing_number" }, "created_at": "2019-12-27T18:11:19.117Z", "purposes": [ "charges" ], "status": "created", "status_detail": { "code": "code", "message": "message", "reason": "unverified", "source": "watchtower" }, "updated_at": "2019-12-27T18:11:19.117Z", "description": "description", "metadata": { "foo": "string" }, "platform_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e" }, "meta": { "api_request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "api_request_timestamp": "2019-12-27T18:11:19.117Z" }, "response_type": "object" } ``` ## List linked bank accounts `client.embed.linkedBankAccounts.list(LinkedBankAccountListParamsparams?, RequestOptionsoptions?): PageNumberSchema` **get** `/v1/linked_bank_accounts` Returns a list of bank accounts associated with a specific Straddle account. The linked bank accounts are returned sorted by creation date, with the most recently created appearing first. This endpoint supports pagination to handle accounts with multiple linked bank accounts. ### Parameters - `params: LinkedBankAccountListParams` - `account_id?: string` Query param: The unique identifier of the related account. - `level?: "account" | "platform"` Query param - `"account"` - `"platform"` - `page_number?: number` Query param: Results page number. Starts at page 1. - `page_size?: number` Query param: Page size. Max value: 1000 - `purpose?: "charges" | "payouts" | "billing"` Query param: The purpose of the linked bank accounts to return. Possible values: 'charges', 'payouts', 'billing'. - `"charges"` - `"payouts"` - `"billing"` - `sort_by?: string` Query param: Sort By. - `sort_order?: "asc" | "desc"` Query param: Sort Order. - `"asc"` - `"desc"` - `status?: "created" | "onboarding" | "active" | 3 more` Query param: The status of the linked bank accounts to return. Possible values: 'created', 'onboarding', 'active', 'inactive', 'rejected'. - `"created"` - `"onboarding"` - `"active"` - `"rejected"` - `"inactive"` - `"canceled"` - `correlationID?: string` Header param: Optional client generated identifier to trace and debug a series of requests. - `requestID?: string` Header param: Optional client generated identifier to trace and debug a request. ### Returns - `Data` - `id: string` Unique identifier for the linked bank account. - `account_id: string | null` The unique identifier of the Straddle account related to this bank account. - `bank_account: BankAccount` - `account_holder: string` - `account_mask: string` - `institution_name: string` - `routing_number: string` - `created_at: string` Timestamp of when the bank account object was created. - `purposes: Array<"charges" | "payouts" | "billing">` The purposes for the linked bank account. - `"charges"` - `"payouts"` - `"billing"` - `status: "created" | "onboarding" | "active" | 3 more` The current status of the linked bank account. - `"created"` - `"onboarding"` - `"active"` - `"rejected"` - `"inactive"` - `"canceled"` - `status_detail: StatusDetail` - `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" | 5 more` A machine-readable identifier for the specific status, useful for programmatic handling. - `"unverified"` - `"in_review"` - `"pending"` - `"stuck"` - `"verified"` - `"failed_verification"` - `"disabled"` - `"new"` - `source: "watchtower"` Identifies the origin of the status change (e.g., `watchtower`). This helps in tracking the cause of status updates. - `"watchtower"` - `updated_at: string` Timestamp of the most recent update to the linked bank account. - `description?: string | null` Optional description for the bank account. - `metadata?: Record | null` 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?: string | null` The unique identifier of the Straddle Platform relatd to this bank account. ### Example ```typescript import Straddle from '@straddlecom/straddle'; const client = new Straddle({ apiKey: process.env['STRADDLE_API_KEY'], // This is the default and can be omitted }); // Automatically fetches more pages as needed. for await (const linkedBankAccount of client.embed.linkedBankAccounts.list()) { console.log(linkedBankAccount.id); } ``` #### Response ```json { "data": [ { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "account_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "bank_account": { "account_holder": "account_holder", "account_mask": "account_mask", "institution_name": "institution_name", "routing_number": "routing_number" }, "created_at": "2019-12-27T18:11:19.117Z", "purposes": [ "charges" ], "status": "created", "status_detail": { "code": "code", "message": "message", "reason": "unverified", "source": "watchtower" }, "updated_at": "2019-12-27T18:11:19.117Z", "description": "description", "metadata": { "foo": "string" }, "platform_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e" } ], "meta": { "api_request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "api_request_timestamp": "2019-12-27T18:11:19.117Z", "max_page_size": 0, "page_number": 0, "page_size": 0, "sort_by": "sort_by", "sort_order": "asc", "total_items": 0, "total_pages": 0 }, "response_type": "object" } ``` ## Update a linked bank account `client.embed.linkedBankAccounts.update(stringlinkedBankAccountID, LinkedBankAccountUpdateParamsparams, RequestOptionsoptions?): LinkedBankAccountV1` **put** `/v1/linked_bank_accounts/{linked_bank_account_id}` Updates an existing linked bank account's information. This can be used to update account details during onboarding or to update metadata associated with the linked account. The linked bank account must be in 'created' or 'onboarding' status. ### Parameters - `linkedBankAccountID: string` - `params: LinkedBankAccountUpdateParams` - `bank_account: BankAccount` Body param - `account_holder: string` The name of the account holder as it appears on the bank account. Typically, this is the legal name of the business associated with the account. - `account_number: string` The bank account number. - `routing_number: string` The routing number of the bank account. - `metadata?: Record | null` Body param: Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the linked bank account in a structured format. - `correlationID?: string` Header param: Optional client generated identifier to trace and debug a series of requests. - `idempotencyKey?: string` Header param: Optional client generated value to use for idempotent requests. - `requestID?: string` Header param: Optional client generated identifier to trace and debug a request. ### Returns - `LinkedBankAccountV1` - `data: Data` - `id: string` Unique identifier for the linked bank account. - `account_id: string | null` The unique identifier of the Straddle account related to this bank account. - `bank_account: BankAccount` - `account_holder: string` - `account_mask: string` - `institution_name: string` - `routing_number: string` - `created_at: string` Timestamp of when the bank account object was created. - `purposes: Array<"charges" | "payouts" | "billing">` The purposes for the linked bank account. - `"charges"` - `"payouts"` - `"billing"` - `status: "created" | "onboarding" | "active" | 3 more` The current status of the linked bank account. - `"created"` - `"onboarding"` - `"active"` - `"rejected"` - `"inactive"` - `"canceled"` - `status_detail: StatusDetail` - `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" | 5 more` A machine-readable identifier for the specific status, useful for programmatic handling. - `"unverified"` - `"in_review"` - `"pending"` - `"stuck"` - `"verified"` - `"failed_verification"` - `"disabled"` - `"new"` - `source: "watchtower"` Identifies the origin of the status change (e.g., `watchtower`). This helps in tracking the cause of status updates. - `"watchtower"` - `updated_at: string` Timestamp of the most recent update to the linked bank account. - `description?: string | null` Optional description for the bank account. - `metadata?: Record | null` 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?: string | null` The unique identifier of the Straddle Platform relatd to this bank account. - `meta: ResponseMetadata` Metadata about the API request, including an identifier and timestamp. - `api_request_id: string` Unique identifier for this API request, useful for troubleshooting. - `api_request_timestamp: string` Timestamp for this API request, useful for troubleshooting. - `response_type: "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. - `"object"` - `"array"` - `"error"` - `"none"` ### Example ```typescript import Straddle from '@straddlecom/straddle'; const client = new Straddle({ apiKey: process.env['STRADDLE_API_KEY'], // This is the default and can be omitted }); const linkedBankAccountV1 = await client.embed.linkedBankAccounts.update( '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', { bank_account: { account_holder: 'account_holder', account_number: 'account_number', routing_number: 'xxxxxxxxx', }, }, ); console.log(linkedBankAccountV1.data); ``` #### Response ```json { "data": { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "account_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "bank_account": { "account_holder": "account_holder", "account_mask": "account_mask", "institution_name": "institution_name", "routing_number": "routing_number" }, "created_at": "2019-12-27T18:11:19.117Z", "purposes": [ "charges" ], "status": "created", "status_detail": { "code": "code", "message": "message", "reason": "unverified", "source": "watchtower" }, "updated_at": "2019-12-27T18:11:19.117Z", "description": "description", "metadata": { "foo": "string" }, "platform_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e" }, "meta": { "api_request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "api_request_timestamp": "2019-12-27T18:11:19.117Z" }, "response_type": "object" } ``` ## Lookup a linked bank account `client.embed.linkedBankAccounts.get(stringlinkedBankAccountID, LinkedBankAccountGetParamsparams?, RequestOptionsoptions?): LinkedBankAccountV1` **get** `/v1/linked_bank_accounts/{linked_bank_account_id}` Retrieves the details of a linked bank account that has previously been created. Supply the unique linked bank account `id`, and Straddle will return the corresponding information. The response includes masked account details for security purposes. ### Parameters - `linkedBankAccountID: string` - `params: LinkedBankAccountGetParams` - `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. ### Returns - `LinkedBankAccountV1` - `data: Data` - `id: string` Unique identifier for the linked bank account. - `account_id: string | null` The unique identifier of the Straddle account related to this bank account. - `bank_account: BankAccount` - `account_holder: string` - `account_mask: string` - `institution_name: string` - `routing_number: string` - `created_at: string` Timestamp of when the bank account object was created. - `purposes: Array<"charges" | "payouts" | "billing">` The purposes for the linked bank account. - `"charges"` - `"payouts"` - `"billing"` - `status: "created" | "onboarding" | "active" | 3 more` The current status of the linked bank account. - `"created"` - `"onboarding"` - `"active"` - `"rejected"` - `"inactive"` - `"canceled"` - `status_detail: StatusDetail` - `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" | 5 more` A machine-readable identifier for the specific status, useful for programmatic handling. - `"unverified"` - `"in_review"` - `"pending"` - `"stuck"` - `"verified"` - `"failed_verification"` - `"disabled"` - `"new"` - `source: "watchtower"` Identifies the origin of the status change (e.g., `watchtower`). This helps in tracking the cause of status updates. - `"watchtower"` - `updated_at: string` Timestamp of the most recent update to the linked bank account. - `description?: string | null` Optional description for the bank account. - `metadata?: Record | null` 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?: string | null` The unique identifier of the Straddle Platform relatd to this bank account. - `meta: ResponseMetadata` Metadata about the API request, including an identifier and timestamp. - `api_request_id: string` Unique identifier for this API request, useful for troubleshooting. - `api_request_timestamp: string` Timestamp for this API request, useful for troubleshooting. - `response_type: "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. - `"object"` - `"array"` - `"error"` - `"none"` ### Example ```typescript import Straddle from '@straddlecom/straddle'; const client = new Straddle({ apiKey: process.env['STRADDLE_API_KEY'], // This is the default and can be omitted }); const linkedBankAccountV1 = await client.embed.linkedBankAccounts.get( '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', ); console.log(linkedBankAccountV1.data); ``` #### Response ```json { "data": { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "account_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "bank_account": { "account_holder": "account_holder", "account_mask": "account_mask", "institution_name": "institution_name", "routing_number": "routing_number" }, "created_at": "2019-12-27T18:11:19.117Z", "purposes": [ "charges" ], "status": "created", "status_detail": { "code": "code", "message": "message", "reason": "unverified", "source": "watchtower" }, "updated_at": "2019-12-27T18:11:19.117Z", "description": "description", "metadata": { "foo": "string" }, "platform_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e" }, "meta": { "api_request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "api_request_timestamp": "2019-12-27T18:11:19.117Z" }, "response_type": "object" } ``` ## Unmask a linked bank account `client.embed.linkedBankAccounts.unmask(stringlinkedBankAccountID, LinkedBankAccountUnmaskParamsparams?, RequestOptionsoptions?): LinkedBankAccountUnmaskV1` **get** `/v1/linked_bank_accounts/{linked_bank_account_id}/unmask` Retrieves the unmasked details of a linked bank account that has previously been created. Supply the unique linked bank account `id`, and Straddle will return the corresponding information, including sensitive details. This endpoint needs to be enabled by Straddle for your account and should only be used when absolutely necessary. ### Parameters - `linkedBankAccountID: string` - `params: LinkedBankAccountUnmaskParams` - `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. ### Returns - `LinkedBankAccountUnmaskV1` - `data: Data` - `id: string` Unique identifier for the linked bank account. - `account_id: string` Unique identifier for the Straddle account related to this bank account. - `bank_account: BankAccount` The bank account details associated with the linked bank account. - `account_holder: string` - `account_number: string` - `institution_name: string` - `routing_number: string` - `created_at: string` Timestamp of when the linked bank account was created. - `status: "created" | "onboarding" | "active" | 3 more` The current status of the linked bank account. - `"created"` - `"onboarding"` - `"active"` - `"rejected"` - `"inactive"` - `"canceled"` - `status_detail: StatusDetail` Additional details about the current status of the linked bank account. - `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" | 5 more` A machine-readable identifier for the specific status, useful for programmatic handling. - `"unverified"` - `"in_review"` - `"pending"` - `"stuck"` - `"verified"` - `"failed_verification"` - `"disabled"` - `"new"` - `source: "watchtower"` Identifies the origin of the status change (e.g., `watchtower`). This helps in tracking the cause of status updates. - `"watchtower"` - `updated_at: string` Timestamp of when the linked bank account was last updated. - `metadata?: Record | null` - `meta: ResponseMetadata` Metadata about the API request, including an identifier and timestamp. - `api_request_id: string` Unique identifier for this API request, useful for troubleshooting. - `api_request_timestamp: string` Timestamp for this API request, useful for troubleshooting. - `response_type: "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. - `"object"` - `"array"` - `"error"` - `"none"` ### Example ```typescript import Straddle from '@straddlecom/straddle'; const client = new Straddle({ apiKey: process.env['STRADDLE_API_KEY'], // This is the default and can be omitted }); const linkedBankAccountUnmaskV1 = await client.embed.linkedBankAccounts.unmask( '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', ); console.log(linkedBankAccountUnmaskV1.data); ``` #### Response ```json { "data": { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "account_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "bank_account": { "account_holder": "account_holder", "account_number": "account_number", "institution_name": "institution_name", "routing_number": "routing_number" }, "created_at": "2019-12-27T18:11:19.117Z", "status": "created", "status_detail": { "code": "code", "message": "message", "reason": "unverified", "source": "watchtower" }, "updated_at": "2019-12-27T18:11:19.117Z", "metadata": { "foo": "string" } }, "meta": { "api_request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "api_request_timestamp": "2019-12-27T18:11:19.117Z" }, "response_type": "object" } ``` ## Cancel a linked bank account `client.embed.linkedBankAccounts.cancel(stringlinkedBankAccountID, LinkedBankAccountCancelParamsparams?, RequestOptionsoptions?): LinkedBankAccountV1` **patch** `/v1/linked_bank_accounts/{linked_bank_account_id}/cancel` Cancels an existing linked bank account. This can be used to cancel a linked bank account before it has been reviewed. The linked bank account must be in 'created' status. ### Parameters - `linkedBankAccountID: string` - `params: LinkedBankAccountCancelParams` - `correlationID?: string` Optional client generated identifier to trace and debug a series of requests. - `idempotencyKey?: string` Optional client generated value to use for idempotent requests. - `requestID?: string` Optional client generated identifier to trace and debug a request. ### Returns - `LinkedBankAccountV1` - `data: Data` - `id: string` Unique identifier for the linked bank account. - `account_id: string | null` The unique identifier of the Straddle account related to this bank account. - `bank_account: BankAccount` - `account_holder: string` - `account_mask: string` - `institution_name: string` - `routing_number: string` - `created_at: string` Timestamp of when the bank account object was created. - `purposes: Array<"charges" | "payouts" | "billing">` The purposes for the linked bank account. - `"charges"` - `"payouts"` - `"billing"` - `status: "created" | "onboarding" | "active" | 3 more` The current status of the linked bank account. - `"created"` - `"onboarding"` - `"active"` - `"rejected"` - `"inactive"` - `"canceled"` - `status_detail: StatusDetail` - `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" | 5 more` A machine-readable identifier for the specific status, useful for programmatic handling. - `"unverified"` - `"in_review"` - `"pending"` - `"stuck"` - `"verified"` - `"failed_verification"` - `"disabled"` - `"new"` - `source: "watchtower"` Identifies the origin of the status change (e.g., `watchtower`). This helps in tracking the cause of status updates. - `"watchtower"` - `updated_at: string` Timestamp of the most recent update to the linked bank account. - `description?: string | null` Optional description for the bank account. - `metadata?: Record | null` 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?: string | null` The unique identifier of the Straddle Platform relatd to this bank account. - `meta: ResponseMetadata` Metadata about the API request, including an identifier and timestamp. - `api_request_id: string` Unique identifier for this API request, useful for troubleshooting. - `api_request_timestamp: string` Timestamp for this API request, useful for troubleshooting. - `response_type: "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. - `"object"` - `"array"` - `"error"` - `"none"` ### Example ```typescript import Straddle from '@straddlecom/straddle'; const client = new Straddle({ apiKey: process.env['STRADDLE_API_KEY'], // This is the default and can be omitted }); const linkedBankAccountV1 = await client.embed.linkedBankAccounts.cancel( '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', ); console.log(linkedBankAccountV1.data); ``` #### Response ```json { "data": { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "account_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "bank_account": { "account_holder": "account_holder", "account_mask": "account_mask", "institution_name": "institution_name", "routing_number": "routing_number" }, "created_at": "2019-12-27T18:11:19.117Z", "purposes": [ "charges" ], "status": "created", "status_detail": { "code": "code", "message": "message", "reason": "unverified", "source": "watchtower" }, "updated_at": "2019-12-27T18:11:19.117Z", "description": "description", "metadata": { "foo": "string" }, "platform_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e" }, "meta": { "api_request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "api_request_timestamp": "2019-12-27T18:11:19.117Z" }, "response_type": "object" } ``` ## Domain Types ### Linked Bank Account Paged V1 - `LinkedBankAccountPagedV1` - `data: Array` - `id: string` Unique identifier for the linked bank account. - `account_id: string | null` The unique identifier of the Straddle account related to this bank account. - `bank_account: BankAccount` - `account_holder: string` - `account_mask: string` - `institution_name: string` - `routing_number: string` - `created_at: string` Timestamp of when the bank account object was created. - `purposes: Array<"charges" | "payouts" | "billing">` The purposes for the linked bank account. - `"charges"` - `"payouts"` - `"billing"` - `status: "created" | "onboarding" | "active" | 3 more` The current status of the linked bank account. - `"created"` - `"onboarding"` - `"active"` - `"rejected"` - `"inactive"` - `"canceled"` - `status_detail: StatusDetail` - `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" | 5 more` A machine-readable identifier for the specific status, useful for programmatic handling. - `"unverified"` - `"in_review"` - `"pending"` - `"stuck"` - `"verified"` - `"failed_verification"` - `"disabled"` - `"new"` - `source: "watchtower"` Identifies the origin of the status change (e.g., `watchtower`). This helps in tracking the cause of status updates. - `"watchtower"` - `updated_at: string` Timestamp of the most recent update to the linked bank account. - `description?: string | null` Optional description for the bank account. - `metadata?: Record | null` 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?: string | null` The unique identifier of the Straddle Platform relatd to this bank account. - `meta: PagedResponseMetadata` Metadata about the API request, including an identifier, timestamp, and pagination details. - `api_request_id: string` Unique identifier for this API request, useful for troubleshooting. - `api_request_timestamp: string` Timestamp for this API request, useful for troubleshooting. - `max_page_size: number` Maximum allowed page size for this endpoint. - `page_number: number` Page number for paginated results. - `page_size: number` Number of items per page in this response. - `sort_by: string` The field that the results were sorted by. - `sort_order: "asc" | "desc"` - `"asc"` - `"desc"` - `total_items: number` Total number of items returned in this response. - `total_pages: number` The number of pages available. - `response_type: "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. - `"object"` - `"array"` - `"error"` - `"none"` ### Linked Bank Account Unmask V1 - `LinkedBankAccountUnmaskV1` - `data: Data` - `id: string` Unique identifier for the linked bank account. - `account_id: string` Unique identifier for the Straddle account related to this bank account. - `bank_account: BankAccount` The bank account details associated with the linked bank account. - `account_holder: string` - `account_number: string` - `institution_name: string` - `routing_number: string` - `created_at: string` Timestamp of when the linked bank account was created. - `status: "created" | "onboarding" | "active" | 3 more` The current status of the linked bank account. - `"created"` - `"onboarding"` - `"active"` - `"rejected"` - `"inactive"` - `"canceled"` - `status_detail: StatusDetail` Additional details about the current status of the linked bank account. - `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" | 5 more` A machine-readable identifier for the specific status, useful for programmatic handling. - `"unverified"` - `"in_review"` - `"pending"` - `"stuck"` - `"verified"` - `"failed_verification"` - `"disabled"` - `"new"` - `source: "watchtower"` Identifies the origin of the status change (e.g., `watchtower`). This helps in tracking the cause of status updates. - `"watchtower"` - `updated_at: string` Timestamp of when the linked bank account was last updated. - `metadata?: Record | null` - `meta: ResponseMetadata` Metadata about the API request, including an identifier and timestamp. - `api_request_id: string` Unique identifier for this API request, useful for troubleshooting. - `api_request_timestamp: string` Timestamp for this API request, useful for troubleshooting. - `response_type: "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. - `"object"` - `"array"` - `"error"` - `"none"` ### Linked Bank Account V1 - `LinkedBankAccountV1` - `data: Data` - `id: string` Unique identifier for the linked bank account. - `account_id: string | null` The unique identifier of the Straddle account related to this bank account. - `bank_account: BankAccount` - `account_holder: string` - `account_mask: string` - `institution_name: string` - `routing_number: string` - `created_at: string` Timestamp of when the bank account object was created. - `purposes: Array<"charges" | "payouts" | "billing">` The purposes for the linked bank account. - `"charges"` - `"payouts"` - `"billing"` - `status: "created" | "onboarding" | "active" | 3 more` The current status of the linked bank account. - `"created"` - `"onboarding"` - `"active"` - `"rejected"` - `"inactive"` - `"canceled"` - `status_detail: StatusDetail` - `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" | 5 more` A machine-readable identifier for the specific status, useful for programmatic handling. - `"unverified"` - `"in_review"` - `"pending"` - `"stuck"` - `"verified"` - `"failed_verification"` - `"disabled"` - `"new"` - `source: "watchtower"` Identifies the origin of the status change (e.g., `watchtower`). This helps in tracking the cause of status updates. - `"watchtower"` - `updated_at: string` Timestamp of the most recent update to the linked bank account. - `description?: string | null` Optional description for the bank account. - `metadata?: Record | null` 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?: string | null` The unique identifier of the Straddle Platform relatd to this bank account. - `meta: ResponseMetadata` Metadata about the API request, including an identifier and timestamp. - `api_request_id: string` Unique identifier for this API request, useful for troubleshooting. - `api_request_timestamp: string` Timestamp for this API request, useful for troubleshooting. - `response_type: "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. - `"object"` - `"array"` - `"error"` - `"none"` # Organizations ## Create an organization `client.embed.organizations.create(OrganizationCreateParamsparams, RequestOptionsoptions?): OrganizationV1` **post** `/v1/organizations` Creates a new organization related to your Straddle integration. Organizations can be used to group related accounts and manage permissions across multiple users. ### Parameters - `params: OrganizationCreateParams` - `name: string` Body param: The name of the organization. - `external_id?: string | null` Body param: Unique identifier for the organization in your database, used for cross-referencing between Straddle and your systems. - `metadata?: Record | null` Body param: Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the organization in a structured format. - `correlationID?: string` Header param: Optional client generated identifier to trace and debug a series of requests. - `idempotencyKey?: string` Header param: Optional client generated value to use for idempotent requests. - `requestID?: string` Header param: Optional client generated identifier to trace and debug a request. ### Returns - `OrganizationV1` - `data: Data` - `id: string` Straddle's unique identifier for the organization. - `created_at: string` Timestamp of when the organization was created. - `name: string` The name of the organization. - `updated_at: string` Timestamp of the most recent update to the organization. - `external_id?: string | null` Unique identifier for the organization in your database, used for cross-referencing between Straddle and your systems. - `metadata?: Record | null` Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the organization in a structured format. - `meta: ResponseMetadata` Metadata about the API request, including an identifier and timestamp. - `api_request_id: string` Unique identifier for this API request, useful for troubleshooting. - `api_request_timestamp: string` Timestamp for this API request, useful for troubleshooting. - `response_type: "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. - `"object"` - `"array"` - `"error"` - `"none"` ### Example ```typescript import Straddle from '@straddlecom/straddle'; const client = new Straddle({ apiKey: process.env['STRADDLE_API_KEY'], // This is the default and can be omitted }); const organizationV1 = await client.embed.organizations.create({ name: 'name' }); console.log(organizationV1.data); ``` #### Response ```json { "data": { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "created_at": "2019-12-27T18:11:19.117Z", "name": "name", "updated_at": "2019-12-27T18:11:19.117Z", "external_id": "external_id", "metadata": { "foo": "string" } }, "meta": { "api_request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "api_request_timestamp": "2019-12-27T18:11:19.117Z" }, "response_type": "object" } ``` ## List organizations `client.embed.organizations.list(OrganizationListParamsparams?, RequestOptionsoptions?): PageNumberSchema` **get** `/v1/organizations` Retrieves a list of organizations associated with your Straddle integration. The organizations are returned sorted by creation date, with the most recently created organizations appearing first. This endpoint supports advanced sorting and filtering options to help you find specific organizations. ### Parameters - `params: OrganizationListParams` - `external_id?: string` Query param: List organizations by their external ID. - `name?: string` Query param: List organizations by name (partial match supported). - `page_number?: number` Query param: Results page number. Starts at page 1. - `page_size?: number` Query param: Page size. Max value: 1000 - `sort_by?: string` Query param: Sort By. - `sort_order?: "asc" | "desc"` Query param: Sort Order. - `"asc"` - `"desc"` - `correlationID?: string` Header param: Optional client generated identifier to trace and debug a series of requests. - `requestID?: string` Header param: Optional client generated identifier to trace and debug a request. ### Returns - `Data` - `id: string` Straddle's unique identifier for the organization. - `created_at: string` Timestamp of when the organization was created. - `name: string` The name of the organization. - `updated_at: string` Timestamp of the most recent update to the organization. - `external_id?: string | null` Unique identifier for the organization in your database, used for cross-referencing between Straddle and your systems. - `metadata?: Record | null` Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the organization in a structured format. ### Example ```typescript import Straddle from '@straddlecom/straddle'; const client = new Straddle({ apiKey: process.env['STRADDLE_API_KEY'], // This is the default and can be omitted }); // Automatically fetches more pages as needed. for await (const organization of client.embed.organizations.list()) { console.log(organization.id); } ``` #### Response ```json { "data": [ { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "created_at": "2019-12-27T18:11:19.117Z", "name": "name", "updated_at": "2019-12-27T18:11:19.117Z", "external_id": "external_id", "metadata": { "foo": "string" } } ], "meta": { "api_request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "api_request_timestamp": "2019-12-27T18:11:19.117Z", "max_page_size": 0, "page_number": 0, "page_size": 0, "sort_by": "sort_by", "sort_order": "asc", "total_items": 0, "total_pages": 0 }, "response_type": "object" } ``` ## Retrieve organization details `client.embed.organizations.get(stringorganizationID, OrganizationGetParamsparams?, RequestOptionsoptions?): OrganizationV1` **get** `/v1/organizations/{organization_id}` Retrieves the details of an Organization that has previously been created. Supply the unique organization ID that was returned from your previous request, and Straddle will return the corresponding organization information. ### Parameters - `organizationID: string` - `params: OrganizationGetParams` - `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. ### Returns - `OrganizationV1` - `data: Data` - `id: string` Straddle's unique identifier for the organization. - `created_at: string` Timestamp of when the organization was created. - `name: string` The name of the organization. - `updated_at: string` Timestamp of the most recent update to the organization. - `external_id?: string | null` Unique identifier for the organization in your database, used for cross-referencing between Straddle and your systems. - `metadata?: Record | null` Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the organization in a structured format. - `meta: ResponseMetadata` Metadata about the API request, including an identifier and timestamp. - `api_request_id: string` Unique identifier for this API request, useful for troubleshooting. - `api_request_timestamp: string` Timestamp for this API request, useful for troubleshooting. - `response_type: "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. - `"object"` - `"array"` - `"error"` - `"none"` ### Example ```typescript import Straddle from '@straddlecom/straddle'; const client = new Straddle({ apiKey: process.env['STRADDLE_API_KEY'], // This is the default and can be omitted }); const organizationV1 = await client.embed.organizations.get('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e'); console.log(organizationV1.data); ``` #### Response ```json { "data": { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "created_at": "2019-12-27T18:11:19.117Z", "name": "name", "updated_at": "2019-12-27T18:11:19.117Z", "external_id": "external_id", "metadata": { "foo": "string" } }, "meta": { "api_request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "api_request_timestamp": "2019-12-27T18:11:19.117Z" }, "response_type": "object" } ``` ## Domain Types ### Organization Paged V1 - `OrganizationPagedV1` - `data: Array` - `id: string` Straddle's unique identifier for the organization. - `created_at: string` Timestamp of when the organization was created. - `name: string` The name of the organization. - `updated_at: string` Timestamp of the most recent update to the organization. - `external_id?: string | null` Unique identifier for the organization in your database, used for cross-referencing between Straddle and your systems. - `metadata?: Record | null` Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the organization in a structured format. - `meta: PagedResponseMetadata` Metadata about the API request, including an identifier, timestamp, and pagination details. - `api_request_id: string` Unique identifier for this API request, useful for troubleshooting. - `api_request_timestamp: string` Timestamp for this API request, useful for troubleshooting. - `max_page_size: number` Maximum allowed page size for this endpoint. - `page_number: number` Page number for paginated results. - `page_size: number` Number of items per page in this response. - `sort_by: string` The field that the results were sorted by. - `sort_order: "asc" | "desc"` - `"asc"` - `"desc"` - `total_items: number` Total number of items returned in this response. - `total_pages: number` The number of pages available. - `response_type: "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. - `"object"` - `"array"` - `"error"` - `"none"` ### Organization V1 - `OrganizationV1` - `data: Data` - `id: string` Straddle's unique identifier for the organization. - `created_at: string` Timestamp of when the organization was created. - `name: string` The name of the organization. - `updated_at: string` Timestamp of the most recent update to the organization. - `external_id?: string | null` Unique identifier for the organization in your database, used for cross-referencing between Straddle and your systems. - `metadata?: Record | null` Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the organization in a structured format. - `meta: ResponseMetadata` Metadata about the API request, including an identifier and timestamp. - `api_request_id: string` Unique identifier for this API request, useful for troubleshooting. - `api_request_timestamp: string` Timestamp for this API request, useful for troubleshooting. - `response_type: "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. - `"object"` - `"array"` - `"error"` - `"none"` # Representatives ## Create a representative `client.embed.representatives.create(RepresentativeCreateParamsparams, RequestOptionsoptions?): Representative` **post** `/v1/representatives` Creates a new representative associated with an account. Representatives are individuals who have legal authority or significant responsibility within the business. ### Parameters - `params: RepresentativeCreateParams` - `account_id: string` Body param: The unique identifier of the account this representative is associated with. - `dob: string` Body param: Date of birth for the representative in ISO 8601 format (YYYY-MM-DD). - `email: string` Body param: The company email address of the representative. - `first_name: string` Body param: The first name of the representative. - `last_name: string` Body param: The last name of the representative. - `mobile_number: string` Body param: The mobile phone number of the representative. - `relationship: Relationship` Body param - `control: boolean` 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: boolean` Whether the representative owns any percentage of of the equity interests of the legal entity. - `primary: boolean` 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?: number | null` The percentage of ownership the representative has. Required if 'Owner' is true. - `title?: string | null` The job title of the representative. - `ssn_last4: string` Body param: The last 4 digits of the representative's Social Security Number. - `external_id?: string | null` Body param: Unique identifier for the representative in your database, used for cross-referencing between Straddle and your systems. - `metadata?: Record | null` Body param: Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the represetative in a structured format. - `correlationID?: string` Header param: Optional client generated identifier to trace and debug a series of requests. - `idempotencyKey?: string` Header param: Optional client generated value to use for idempotent requests. - `requestID?: string` Header param: Optional client generated identifier to trace and debug a request. ### Returns - `Representative` - `data: Data` - `id: string` Unique identifier for the representative. - `account_id: string` The unique identifier of the account this representative is associated with. - `created_at: string` Timestamp of when the representative was created. - `dob: string` The date of birth of the representative, in ISO 8601 format (YYYY-MM-DD). - `email: string | null` The email address of the representative. - `first_name: string` The first name of the representative. - `last_name: string` The last name of the representative. - `mobile_number: string` The mobile phone number of the representative. - `name: string` - `relationship: Relationship` - `control: boolean` 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: boolean` Whether the representative owns any percentage of of the equity interests of the legal entity. - `primary: boolean` 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?: number | null` The percentage of ownership the representative has. Required if 'Owner' is true. - `title?: string | null` The job title of the representative. - `ssn_last4: string` The last 4 digits of the representative's Social Security Number. - `status: "created" | "onboarding" | "active" | 2 more` The current status of the representative. - `"created"` - `"onboarding"` - `"active"` - `"rejected"` - `"inactive"` - `status_detail: StatusDetail` - `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" | 5 more` A machine-readable identifier for the specific status, useful for programmatic handling. - `"unverified"` - `"in_review"` - `"pending"` - `"stuck"` - `"verified"` - `"failed_verification"` - `"disabled"` - `"new"` - `source: "watchtower"` Identifies the origin of the status change (e.g., `watchtower`). This helps in tracking the cause of status updates. - `"watchtower"` - `updated_at: string` Timestamp of the most recent update to the representative. - `external_id?: string | null` Unique identifier for the representative in your database, used for cross-referencing between Straddle and your systems. - `metadata?: Record | null` Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the represetative in a structured format. - `phone?: string | null` - `user_id?: string | null` The unique identifier of the user account associated with this representative, if applicable. - `meta: ResponseMetadata` Metadata about the API request, including an identifier and timestamp. - `api_request_id: string` Unique identifier for this API request, useful for troubleshooting. - `api_request_timestamp: string` Timestamp for this API request, useful for troubleshooting. - `response_type: "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. - `"object"` - `"array"` - `"error"` - `"none"` ### Example ```typescript import Straddle from '@straddlecom/straddle'; const client = new Straddle({ apiKey: process.env['STRADDLE_API_KEY'], // This is the default and can be omitted }); const representative = await client.embed.representatives.create({ account_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', dob: '1980-01-01', email: 'ron.swanson@pawnee.com', first_name: 'first_name', last_name: 'last_name', mobile_number: '+12128675309', relationship: { control: true, owner: true, primary: true, }, ssn_last4: '1234', }); console.log(representative.data); ``` #### Response ```json { "data": { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "account_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "created_at": "2019-12-27T18:11:19.117Z", "dob": "1980-01-01", "email": "ron.swanson@pawnee.com", "first_name": "Ron", "last_name": "Swanson", "mobile_number": "+12128675309", "name": "name", "relationship": { "control": true, "owner": true, "primary": true, "percent_ownership": 0, "title": "title" }, "ssn_last4": "1234", "status": "created", "status_detail": { "code": "code", "message": "message", "reason": "unverified", "source": "watchtower" }, "updated_at": "2019-12-27T18:11:19.117Z", "external_id": "external_id", "metadata": { "foo": "string" }, "phone": "phone", "user_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e" }, "meta": { "api_request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "api_request_timestamp": "2019-12-27T18:11:19.117Z" }, "response_type": "object" } ``` ## List representatives `client.embed.representatives.list(RepresentativeListParamsparams?, RequestOptionsoptions?): PageNumberSchema` **get** `/v1/representatives` Returns a list of representatives associated with a specific account or organization. The representatives are returned sorted by creation date, with the most recently created representatives appearing first. This endpoint supports advanced sorting and filtering options. ### Parameters - `params: RepresentativeListParams` - `account_id?: string` Query param: The unique identifier of the account to list representatives for. - `level?: "account" | "platform"` Query param - `"account"` - `"platform"` - `organization_id?: string` Query param - `page_number?: number` Query param: Results page number. Starts at page 1. - `page_size?: number` Query param: Page size. Max value: 1000 - `platform_id?: string` Query param - `sort_by?: string` Query param: Sort By. - `sort_order?: "asc" | "desc"` Query param: Sort Order. - `"asc"` - `"desc"` - `correlationID?: string` Header param: Optional client generated identifier to trace and debug a series of requests. - `requestID?: string` Header param: Optional client generated identifier to trace and debug a request. ### Returns - `Data` - `id: string` Unique identifier for the representative. - `account_id: string` The unique identifier of the account this representative is associated with. - `created_at: string` Timestamp of when the representative was created. - `dob: string` The date of birth of the representative, in ISO 8601 format (YYYY-MM-DD). - `email: string | null` The email address of the representative. - `first_name: string` The first name of the representative. - `last_name: string` The last name of the representative. - `mobile_number: string` The mobile phone number of the representative. - `name: string` - `relationship: Relationship` - `control: boolean` 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: boolean` Whether the representative owns any percentage of of the equity interests of the legal entity. - `primary: boolean` 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?: number | null` The percentage of ownership the representative has. Required if 'Owner' is true. - `title?: string | null` The job title of the representative. - `ssn_last4: string` The last 4 digits of the representative's Social Security Number. - `status: "created" | "onboarding" | "active" | 2 more` The current status of the representative. - `"created"` - `"onboarding"` - `"active"` - `"rejected"` - `"inactive"` - `status_detail: StatusDetail` - `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" | 5 more` A machine-readable identifier for the specific status, useful for programmatic handling. - `"unverified"` - `"in_review"` - `"pending"` - `"stuck"` - `"verified"` - `"failed_verification"` - `"disabled"` - `"new"` - `source: "watchtower"` Identifies the origin of the status change (e.g., `watchtower`). This helps in tracking the cause of status updates. - `"watchtower"` - `updated_at: string` Timestamp of the most recent update to the representative. - `external_id?: string | null` Unique identifier for the representative in your database, used for cross-referencing between Straddle and your systems. - `metadata?: Record | null` Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the represetative in a structured format. - `phone?: string | null` - `user_id?: string | null` The unique identifier of the user account associated with this representative, if applicable. ### Example ```typescript import Straddle from '@straddlecom/straddle'; const client = new Straddle({ apiKey: process.env['STRADDLE_API_KEY'], // This is the default and can be omitted }); // Automatically fetches more pages as needed. for await (const representative of client.embed.representatives.list()) { console.log(representative.id); } ``` #### Response ```json { "data": [ { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "account_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "created_at": "2019-12-27T18:11:19.117Z", "dob": "1980-01-01", "email": "ron.swanson@pawnee.com", "first_name": "Ron", "last_name": "Swanson", "mobile_number": "+12128675309", "name": "name", "relationship": { "control": true, "owner": true, "primary": true, "percent_ownership": 0, "title": "title" }, "ssn_last4": "1234", "status": "created", "status_detail": { "code": "code", "message": "message", "reason": "unverified", "source": "watchtower" }, "updated_at": "2019-12-27T18:11:19.117Z", "external_id": "external_id", "metadata": { "foo": "string" }, "phone": "phone", "user_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e" } ], "meta": { "api_request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "api_request_timestamp": "2019-12-27T18:11:19.117Z", "max_page_size": 0, "page_number": 0, "page_size": 0, "sort_by": "sort_by", "sort_order": "asc", "total_items": 0, "total_pages": 0 }, "response_type": "object" } ``` ## Update a representative `client.embed.representatives.update(stringrepresentativeID, RepresentativeUpdateParamsparams, RequestOptionsoptions?): Representative` **put** `/v1/representatives/{representative_id}` Updates an existing representative's information. This can be used to update personal details, contact information, or the relationship to the account or organization. ### Parameters - `representativeID: string` - `params: RepresentativeUpdateParams` - `dob: string` Body param: The date of birth of the representative, in ISO 8601 format (YYYY-MM-DD). - `email: string` Body param: The email address of the representative. - `first_name: string` Body param: The first name of the representative. - `last_name: string` Body param: The last name of the representative. - `mobile_number: string` Body param: The mobile phone number of the representative. - `relationship: Relationship` Body param - `control: boolean` 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: boolean` Whether the representative owns any percentage of of the equity interests of the legal entity. - `primary: boolean` 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?: number | null` The percentage of ownership the representative has. Required if 'Owner' is true. - `title?: string | null` The job title of the representative. - `ssn_last4: string` Body param: The last 4 digits of the representative's Social Security Number. - `external_id?: string | null` Body param: Unique identifier for the representative in your database, used for cross-referencing between Straddle and your systems. - `metadata?: Record | null` Body param: Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the represetative in a structured format. - `correlationID?: string` Header param: Optional client generated identifier to trace and debug a series of requests. - `idempotencyKey?: string` Header param: Optional client generated value to use for idempotent requests. - `requestID?: string` Header param: Optional client generated identifier to trace and debug a request. ### Returns - `Representative` - `data: Data` - `id: string` Unique identifier for the representative. - `account_id: string` The unique identifier of the account this representative is associated with. - `created_at: string` Timestamp of when the representative was created. - `dob: string` The date of birth of the representative, in ISO 8601 format (YYYY-MM-DD). - `email: string | null` The email address of the representative. - `first_name: string` The first name of the representative. - `last_name: string` The last name of the representative. - `mobile_number: string` The mobile phone number of the representative. - `name: string` - `relationship: Relationship` - `control: boolean` 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: boolean` Whether the representative owns any percentage of of the equity interests of the legal entity. - `primary: boolean` 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?: number | null` The percentage of ownership the representative has. Required if 'Owner' is true. - `title?: string | null` The job title of the representative. - `ssn_last4: string` The last 4 digits of the representative's Social Security Number. - `status: "created" | "onboarding" | "active" | 2 more` The current status of the representative. - `"created"` - `"onboarding"` - `"active"` - `"rejected"` - `"inactive"` - `status_detail: StatusDetail` - `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" | 5 more` A machine-readable identifier for the specific status, useful for programmatic handling. - `"unverified"` - `"in_review"` - `"pending"` - `"stuck"` - `"verified"` - `"failed_verification"` - `"disabled"` - `"new"` - `source: "watchtower"` Identifies the origin of the status change (e.g., `watchtower`). This helps in tracking the cause of status updates. - `"watchtower"` - `updated_at: string` Timestamp of the most recent update to the representative. - `external_id?: string | null` Unique identifier for the representative in your database, used for cross-referencing between Straddle and your systems. - `metadata?: Record | null` Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the represetative in a structured format. - `phone?: string | null` - `user_id?: string | null` The unique identifier of the user account associated with this representative, if applicable. - `meta: ResponseMetadata` Metadata about the API request, including an identifier and timestamp. - `api_request_id: string` Unique identifier for this API request, useful for troubleshooting. - `api_request_timestamp: string` Timestamp for this API request, useful for troubleshooting. - `response_type: "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. - `"object"` - `"array"` - `"error"` - `"none"` ### Example ```typescript import Straddle from '@straddlecom/straddle'; const client = new Straddle({ apiKey: process.env['STRADDLE_API_KEY'], // This is the default and can be omitted }); const representative = await client.embed.representatives.update( '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', { dob: '1980-01-01', email: 'ron.swanson@pawnee.com', first_name: 'Ron', last_name: 'Swanson', mobile_number: '+12128675309', relationship: { control: true, owner: true, primary: true, }, ssn_last4: '1234', }, ); console.log(representative.data); ``` #### Response ```json { "data": { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "account_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "created_at": "2019-12-27T18:11:19.117Z", "dob": "1980-01-01", "email": "ron.swanson@pawnee.com", "first_name": "Ron", "last_name": "Swanson", "mobile_number": "+12128675309", "name": "name", "relationship": { "control": true, "owner": true, "primary": true, "percent_ownership": 0, "title": "title" }, "ssn_last4": "1234", "status": "created", "status_detail": { "code": "code", "message": "message", "reason": "unverified", "source": "watchtower" }, "updated_at": "2019-12-27T18:11:19.117Z", "external_id": "external_id", "metadata": { "foo": "string" }, "phone": "phone", "user_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e" }, "meta": { "api_request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "api_request_timestamp": "2019-12-27T18:11:19.117Z" }, "response_type": "object" } ``` ## Lookup a representative `client.embed.representatives.get(stringrepresentativeID, RepresentativeGetParamsparams?, RequestOptionsoptions?): Representative` **get** `/v1/representatives/{representative_id}` Retrieves the details of an existing representative. Supply the unique representative ID, and Straddle will return the corresponding representative information. ### Parameters - `representativeID: string` - `params: RepresentativeGetParams` - `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. ### Returns - `Representative` - `data: Data` - `id: string` Unique identifier for the representative. - `account_id: string` The unique identifier of the account this representative is associated with. - `created_at: string` Timestamp of when the representative was created. - `dob: string` The date of birth of the representative, in ISO 8601 format (YYYY-MM-DD). - `email: string | null` The email address of the representative. - `first_name: string` The first name of the representative. - `last_name: string` The last name of the representative. - `mobile_number: string` The mobile phone number of the representative. - `name: string` - `relationship: Relationship` - `control: boolean` 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: boolean` Whether the representative owns any percentage of of the equity interests of the legal entity. - `primary: boolean` 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?: number | null` The percentage of ownership the representative has. Required if 'Owner' is true. - `title?: string | null` The job title of the representative. - `ssn_last4: string` The last 4 digits of the representative's Social Security Number. - `status: "created" | "onboarding" | "active" | 2 more` The current status of the representative. - `"created"` - `"onboarding"` - `"active"` - `"rejected"` - `"inactive"` - `status_detail: StatusDetail` - `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" | 5 more` A machine-readable identifier for the specific status, useful for programmatic handling. - `"unverified"` - `"in_review"` - `"pending"` - `"stuck"` - `"verified"` - `"failed_verification"` - `"disabled"` - `"new"` - `source: "watchtower"` Identifies the origin of the status change (e.g., `watchtower`). This helps in tracking the cause of status updates. - `"watchtower"` - `updated_at: string` Timestamp of the most recent update to the representative. - `external_id?: string | null` Unique identifier for the representative in your database, used for cross-referencing between Straddle and your systems. - `metadata?: Record | null` Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the represetative in a structured format. - `phone?: string | null` - `user_id?: string | null` The unique identifier of the user account associated with this representative, if applicable. - `meta: ResponseMetadata` Metadata about the API request, including an identifier and timestamp. - `api_request_id: string` Unique identifier for this API request, useful for troubleshooting. - `api_request_timestamp: string` Timestamp for this API request, useful for troubleshooting. - `response_type: "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. - `"object"` - `"array"` - `"error"` - `"none"` ### Example ```typescript import Straddle from '@straddlecom/straddle'; const client = new Straddle({ apiKey: process.env['STRADDLE_API_KEY'], // This is the default and can be omitted }); const representative = await client.embed.representatives.get( '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', ); console.log(representative.data); ``` #### Response ```json { "data": { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "account_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "created_at": "2019-12-27T18:11:19.117Z", "dob": "1980-01-01", "email": "ron.swanson@pawnee.com", "first_name": "Ron", "last_name": "Swanson", "mobile_number": "+12128675309", "name": "name", "relationship": { "control": true, "owner": true, "primary": true, "percent_ownership": 0, "title": "title" }, "ssn_last4": "1234", "status": "created", "status_detail": { "code": "code", "message": "message", "reason": "unverified", "source": "watchtower" }, "updated_at": "2019-12-27T18:11:19.117Z", "external_id": "external_id", "metadata": { "foo": "string" }, "phone": "phone", "user_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e" }, "meta": { "api_request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "api_request_timestamp": "2019-12-27T18:11:19.117Z" }, "response_type": "object" } ``` ## Retrieve unmasked representative details `client.embed.representatives.unmask(stringrepresentativeID, RepresentativeUnmaskParamsparams?, RequestOptionsoptions?): Representative` **get** `/v1/representatives/{representative_id}/unmask` Retrieves the unmasked details of a representative that has previously been created. Supply the unique representative ID, and Straddle will return the corresponding representative information, including sensitive details. This endpoint requires additional authentication and should be used with caution. ### Parameters - `representativeID: string` - `params: RepresentativeUnmaskParams` - `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. ### Returns - `Representative` - `data: Data` - `id: string` Unique identifier for the representative. - `account_id: string` The unique identifier of the account this representative is associated with. - `created_at: string` Timestamp of when the representative was created. - `dob: string` The date of birth of the representative, in ISO 8601 format (YYYY-MM-DD). - `email: string | null` The email address of the representative. - `first_name: string` The first name of the representative. - `last_name: string` The last name of the representative. - `mobile_number: string` The mobile phone number of the representative. - `name: string` - `relationship: Relationship` - `control: boolean` 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: boolean` Whether the representative owns any percentage of of the equity interests of the legal entity. - `primary: boolean` 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?: number | null` The percentage of ownership the representative has. Required if 'Owner' is true. - `title?: string | null` The job title of the representative. - `ssn_last4: string` The last 4 digits of the representative's Social Security Number. - `status: "created" | "onboarding" | "active" | 2 more` The current status of the representative. - `"created"` - `"onboarding"` - `"active"` - `"rejected"` - `"inactive"` - `status_detail: StatusDetail` - `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" | 5 more` A machine-readable identifier for the specific status, useful for programmatic handling. - `"unverified"` - `"in_review"` - `"pending"` - `"stuck"` - `"verified"` - `"failed_verification"` - `"disabled"` - `"new"` - `source: "watchtower"` Identifies the origin of the status change (e.g., `watchtower`). This helps in tracking the cause of status updates. - `"watchtower"` - `updated_at: string` Timestamp of the most recent update to the representative. - `external_id?: string | null` Unique identifier for the representative in your database, used for cross-referencing between Straddle and your systems. - `metadata?: Record | null` Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the represetative in a structured format. - `phone?: string | null` - `user_id?: string | null` The unique identifier of the user account associated with this representative, if applicable. - `meta: ResponseMetadata` Metadata about the API request, including an identifier and timestamp. - `api_request_id: string` Unique identifier for this API request, useful for troubleshooting. - `api_request_timestamp: string` Timestamp for this API request, useful for troubleshooting. - `response_type: "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. - `"object"` - `"array"` - `"error"` - `"none"` ### Example ```typescript import Straddle from '@straddlecom/straddle'; const client = new Straddle({ apiKey: process.env['STRADDLE_API_KEY'], // This is the default and can be omitted }); const representative = await client.embed.representatives.unmask( '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', ); console.log(representative.data); ``` #### Response ```json { "data": { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "account_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "created_at": "2019-12-27T18:11:19.117Z", "dob": "1980-01-01", "email": "ron.swanson@pawnee.com", "first_name": "Ron", "last_name": "Swanson", "mobile_number": "+12128675309", "name": "name", "relationship": { "control": true, "owner": true, "primary": true, "percent_ownership": 0, "title": "title" }, "ssn_last4": "1234", "status": "created", "status_detail": { "code": "code", "message": "message", "reason": "unverified", "source": "watchtower" }, "updated_at": "2019-12-27T18:11:19.117Z", "external_id": "external_id", "metadata": { "foo": "string" }, "phone": "phone", "user_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e" }, "meta": { "api_request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "api_request_timestamp": "2019-12-27T18:11:19.117Z" }, "response_type": "object" } ``` ## Domain Types ### Representative - `Representative` - `data: Data` - `id: string` Unique identifier for the representative. - `account_id: string` The unique identifier of the account this representative is associated with. - `created_at: string` Timestamp of when the representative was created. - `dob: string` The date of birth of the representative, in ISO 8601 format (YYYY-MM-DD). - `email: string | null` The email address of the representative. - `first_name: string` The first name of the representative. - `last_name: string` The last name of the representative. - `mobile_number: string` The mobile phone number of the representative. - `name: string` - `relationship: Relationship` - `control: boolean` 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: boolean` Whether the representative owns any percentage of of the equity interests of the legal entity. - `primary: boolean` 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?: number | null` The percentage of ownership the representative has. Required if 'Owner' is true. - `title?: string | null` The job title of the representative. - `ssn_last4: string` The last 4 digits of the representative's Social Security Number. - `status: "created" | "onboarding" | "active" | 2 more` The current status of the representative. - `"created"` - `"onboarding"` - `"active"` - `"rejected"` - `"inactive"` - `status_detail: StatusDetail` - `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" | 5 more` A machine-readable identifier for the specific status, useful for programmatic handling. - `"unverified"` - `"in_review"` - `"pending"` - `"stuck"` - `"verified"` - `"failed_verification"` - `"disabled"` - `"new"` - `source: "watchtower"` Identifies the origin of the status change (e.g., `watchtower`). This helps in tracking the cause of status updates. - `"watchtower"` - `updated_at: string` Timestamp of the most recent update to the representative. - `external_id?: string | null` Unique identifier for the representative in your database, used for cross-referencing between Straddle and your systems. - `metadata?: Record | null` Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the represetative in a structured format. - `phone?: string | null` - `user_id?: string | null` The unique identifier of the user account associated with this representative, if applicable. - `meta: ResponseMetadata` Metadata about the API request, including an identifier and timestamp. - `api_request_id: string` Unique identifier for this API request, useful for troubleshooting. - `api_request_timestamp: string` Timestamp for this API request, useful for troubleshooting. - `response_type: "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. - `"object"` - `"array"` - `"error"` - `"none"` ### Representative Paged - `RepresentativePaged` - `data: Array` - `id: string` Unique identifier for the representative. - `account_id: string` The unique identifier of the account this representative is associated with. - `created_at: string` Timestamp of when the representative was created. - `dob: string` The date of birth of the representative, in ISO 8601 format (YYYY-MM-DD). - `email: string | null` The email address of the representative. - `first_name: string` The first name of the representative. - `last_name: string` The last name of the representative. - `mobile_number: string` The mobile phone number of the representative. - `name: string` - `relationship: Relationship` - `control: boolean` 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: boolean` Whether the representative owns any percentage of of the equity interests of the legal entity. - `primary: boolean` 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?: number | null` The percentage of ownership the representative has. Required if 'Owner' is true. - `title?: string | null` The job title of the representative. - `ssn_last4: string` The last 4 digits of the representative's Social Security Number. - `status: "created" | "onboarding" | "active" | 2 more` The current status of the representative. - `"created"` - `"onboarding"` - `"active"` - `"rejected"` - `"inactive"` - `status_detail: StatusDetail` - `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" | 5 more` A machine-readable identifier for the specific status, useful for programmatic handling. - `"unverified"` - `"in_review"` - `"pending"` - `"stuck"` - `"verified"` - `"failed_verification"` - `"disabled"` - `"new"` - `source: "watchtower"` Identifies the origin of the status change (e.g., `watchtower`). This helps in tracking the cause of status updates. - `"watchtower"` - `updated_at: string` Timestamp of the most recent update to the representative. - `external_id?: string | null` Unique identifier for the representative in your database, used for cross-referencing between Straddle and your systems. - `metadata?: Record | null` Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the represetative in a structured format. - `phone?: string | null` - `user_id?: string | null` The unique identifier of the user account associated with this representative, if applicable. - `meta: PagedResponseMetadata` Metadata about the API request, including an identifier, timestamp, and pagination details. - `api_request_id: string` Unique identifier for this API request, useful for troubleshooting. - `api_request_timestamp: string` Timestamp for this API request, useful for troubleshooting. - `max_page_size: number` Maximum allowed page size for this endpoint. - `page_number: number` Page number for paginated results. - `page_size: number` Number of items per page in this response. - `sort_by: string` The field that the results were sorted by. - `sort_order: "asc" | "desc"` - `"asc"` - `"desc"` - `total_items: number` Total number of items returned in this response. - `total_pages: number` The number of pages available. - `response_type: "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. - `"object"` - `"array"` - `"error"` - `"none"`