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.

GET /v1/linked_accounts

List Accounts

Returns a list of Financial Connections Account objects.

Request parameters

Parameter	Location	Type	Description
`account_holder`	query	object	If present, only return accounts that belong to the specified account holder. `account_holder[customer]` and `account_holder[account]` are mutually exclusive.
`ending_before`	query	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
`expand`	query	array of string	Specifies which fields in the response should be expanded.
`limit`	query	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
`session`	query	string	If present, only return accounts that were collected as part of the given session.
`starting_after`	query	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

object. See the OpenAPI specification for the complete schema.

Responses

HTTP 200: Successful response.

Field	Type	Description
`data` required	array of financial_connections.account	Details about each object.
`has_more` required	boolean	True if this list has another page of items after this one that can be fetched.
`object` required	string	String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
`url` required	string	The URL where this list can be accessed.

HTTP default: Error response.

Field	Type	Description
`error` required	api_errors

GET /v1/linked_accounts/{account}

Retrieve an Account

Retrieves the details of an Financial Connections Account.

Request parameters

Parameter	Location	Type	Description
`account`	path	string
`expand`	query	array of string	Specifies which fields in the response should be expanded.

object. See the OpenAPI specification for the complete schema.

Responses

HTTP 200: Successful response.

Field	Type	Description
`account_holder`	one of multiple schemas	The account holder that this account belongs to.
`account_numbers`	array of bank_connections_resource_account_number_details	Details about the account numbers.
`balance`	one of multiple schemas	The most recent information about the account's balance.
`balance_refresh`	one of multiple schemas	The state of the most recent attempt to refresh the account balance.
`category` required	string	The type of the account. Account category is further divided in `subcategory`.
`created` required	integer	Time at which the object was created. Measured in seconds since the Unix epoch.
`display_name`	string	A human-readable name that has been assigned to this account, either by the account holder or by the institution.
`id` required	string	Unique identifier for the object.
`institution_name` required	string	The name of the institution that holds this account.
`last4`	string	The last 4 digits of the account number. If present, this will be 4 numeric characters.
`livemode` required	boolean	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
`object` required	string	String representing the object's type. Objects of the same type share the same value.
`ownership`	one of multiple schemas	The most recent information about the account's owners.
`ownership_refresh`	one of multiple schemas	The state of the most recent attempt to refresh the account owners.
`permissions`	array of string	The list of permissions granted by this account.
`status` required	string	The status of the link to the account.
`status_details`	bank_connections_resource_account_status_details
`subcategory` required	string	If `category` is `cash`, one of: - `checking` - `savings` - `other` If `category` is `credit`, one of: - `mortgage` - `line_of_credit` - `credit_card` - `other` If `category` is `investment` or `other`, this will be `other`.
`subscriptions`	array of string	The list of data refresh subscriptions requested on this account.
`supported_payment_method_types` required	array of string	The [PaymentMethod type](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type)(s) that can be created from this account.
`transaction_refresh`	one of multiple schemas	The state of the most recent attempt to refresh the account transactions.

HTTP default: Error response.

Field	Type	Description
`error` required	api_errors

POST /v1/linked_accounts/{account}/disconnect

Disconnect an Account

Disables your access to a Financial Connections Account. You will no longer be able to access data associated with the account (e.g. balances, transactions).

Request parameters

Parameter	Location	Type	Description
`account`	path	string

Field	Type	Description
`expand`	array of string	Specifies which fields in the response should be expanded.

Responses

HTTP 200: Successful response.

Field	Type	Description
`account_holder`	one of multiple schemas	The account holder that this account belongs to.
`account_numbers`	array of bank_connections_resource_account_number_details	Details about the account numbers.
`balance`	one of multiple schemas	The most recent information about the account's balance.
`balance_refresh`	one of multiple schemas	The state of the most recent attempt to refresh the account balance.
`category` required	string	The type of the account. Account category is further divided in `subcategory`.
`created` required	integer	Time at which the object was created. Measured in seconds since the Unix epoch.
`display_name`	string	A human-readable name that has been assigned to this account, either by the account holder or by the institution.
`id` required	string	Unique identifier for the object.
`institution_name` required	string	The name of the institution that holds this account.
`last4`	string	The last 4 digits of the account number. If present, this will be 4 numeric characters.
`livemode` required	boolean	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
`object` required	string	String representing the object's type. Objects of the same type share the same value.
`ownership`	one of multiple schemas	The most recent information about the account's owners.
`ownership_refresh`	one of multiple schemas	The state of the most recent attempt to refresh the account owners.
`permissions`	array of string	The list of permissions granted by this account.
`status` required	string	The status of the link to the account.
`status_details`	bank_connections_resource_account_status_details
`subcategory` required	string	If `category` is `cash`, one of: - `checking` - `savings` - `other` If `category` is `credit`, one of: - `mortgage` - `line_of_credit` - `credit_card` - `other` If `category` is `investment` or `other`, this will be `other`.
`subscriptions`	array of string	The list of data refresh subscriptions requested on this account.
`supported_payment_method_types` required	array of string	The [PaymentMethod type](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type)(s) that can be created from this account.
`transaction_refresh`	one of multiple schemas	The state of the most recent attempt to refresh the account transactions.

HTTP default: Error response.

Field	Type	Description
`error` required	api_errors

GET /v1/linked_accounts/{account}/owners

List Account Owners

Lists all owners for a given Account

Request parameters

Parameter	Location	Type	Description
`account`	path	string
`ending_before`	query	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
`expand`	query	array of string	Specifies which fields in the response should be expanded.
`limit`	query	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
`ownership`	query	string	The ID of the ownership object to fetch owners from.
`starting_after`	query	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

object. See the OpenAPI specification for the complete schema.

Responses

HTTP 200: Successful response.

Field	Type	Description
`data` required	array of financial_connections.account_owner	Details about each object.
`has_more` required	boolean	True if this list has another page of items after this one that can be fetched.
`object` required	string	String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
`url` required	string	The URL where this list can be accessed.

HTTP default: Error response.

Field	Type	Description
`error` required	api_errors

POST /v1/linked_accounts/{account}/refresh

Refresh Account data

Refreshes the data associated with a Financial Connections Account.

Request parameters

Parameter	Location	Type	Description
`account`	path	string

Field	Type	Description
`expand`	array of string	Specifies which fields in the response should be expanded.
`features` required	array of string	The list of account features that you would like to refresh.

Responses

HTTP 200: Successful response.

Field	Type	Description
`account_holder`	one of multiple schemas	The account holder that this account belongs to.
`account_numbers`	array of bank_connections_resource_account_number_details	Details about the account numbers.
`balance`	one of multiple schemas	The most recent information about the account's balance.
`balance_refresh`	one of multiple schemas	The state of the most recent attempt to refresh the account balance.
`category` required	string	The type of the account. Account category is further divided in `subcategory`.
`created` required	integer	Time at which the object was created. Measured in seconds since the Unix epoch.
`display_name`	string	A human-readable name that has been assigned to this account, either by the account holder or by the institution.
`id` required	string	Unique identifier for the object.
`institution_name` required	string	The name of the institution that holds this account.
`last4`	string	The last 4 digits of the account number. If present, this will be 4 numeric characters.
`livemode` required	boolean	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
`object` required	string	String representing the object's type. Objects of the same type share the same value.
`ownership`	one of multiple schemas	The most recent information about the account's owners.
`ownership_refresh`	one of multiple schemas	The state of the most recent attempt to refresh the account owners.
`permissions`	array of string	The list of permissions granted by this account.
`status` required	string	The status of the link to the account.
`status_details`	bank_connections_resource_account_status_details
`subcategory` required	string	If `category` is `cash`, one of: - `checking` - `savings` - `other` If `category` is `credit`, one of: - `mortgage` - `line_of_credit` - `credit_card` - `other` If `category` is `investment` or `other`, this will be `other`.
`subscriptions`	array of string	The list of data refresh subscriptions requested on this account.
`supported_payment_method_types` required	array of string	The [PaymentMethod type](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type)(s) that can be created from this account.
`transaction_refresh`	one of multiple schemas	The state of the most recent attempt to refresh the account transactions.

HTTP default: Error response.

Field	Type	Description
`error` required	api_errors