API reference

Test mode. Use your secret key on your server; live processing is currently disabled.

https://api.knoxapi.com

Send form-encoded requests with Authorization: Bearer sk_test_....

Complete OpenAPI specification · Integration guide

Operations and schemas are based on the pinned Stripe OpenAPI specification (MIT). Nested object definitions and enums are available in the complete specification.

POST /v1/account_links

Create an account link

Creates an AccountLink object that includes a single-use Stripe URL that the platform can redirect their user to in order to take them through the Connect Onboarding flow.

Request parameters

Field	Type	Description
`account` required	string	The identifier of the account to create an account link for.
`collect`	string	The collect parameter is deprecated. Use `collection_options` instead.
`collection_options`	object	Specifies the requirements that Stripe collects from connected accounts in the Connect Onboarding flow.
`expand`	array of string	Specifies which fields in the response should be expanded.
`refresh_url`	string	The URL the user will be redirected to if the account link is expired, has been previously-visited, or is otherwise invalid. The URL you specify should attempt to generate a new account link with the same parameters used to create the original account link, then redirect the user to the new account link's URL so they can continue with Connect Onboarding. If a new account link cannot be generated or the redirect fails you should display a useful error to the user.
`return_url`	string	The URL that the user will be redirected to upon leaving or completing the linked flow.
`type` required	string	The type of account link the user is requesting. You can create Account Links of type `account_update` only for connected accounts where your platform is responsible for collecting requirements, including Custom accounts. You can't create them for accounts that have access to a Stripe-hosted Dashboard. If you use [Connect embedded components](/connect/get-started-connect-embedded-components), you can include components that allow your connected accounts to update their own information. For an account without Stripe-hosted Dashboard access where Stripe is liable for negative balances, you must use embedded components.

Responses

HTTP 200: Successful response.

Field	Type	Description
`created` required	integer	Time at which the object was created. Measured in seconds since the Unix epoch.
`expires_at` required	integer	The timestamp at which this account link will expire.
`object` required	string	String representing the object's type. Objects of the same type share the same value.
`url` required	string	The URL for the account link.

HTTP default: Error response.

Field	Type	Description
`error` required	api_errors