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/file_links

List all file links

Returns a list of file links.

Request parameters

Parameter	Location	Type	Description
`created`	query	one of multiple schemas	Only return links that were created during the given date interval.
`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.
`expired`	query	boolean	Filter links by their expiration status. By default, Stripe returns all links.
`file`	query	string	Only return links for the given file.
`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.
`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 file_link	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/file_links

Create a file link

Creates a new file link object.

Request parameters

Field	Type	Description
`expand`	array of string	Specifies which fields in the response should be expanded.
`expires_at`	integer	The link isn't usable after this future timestamp.
`file` required	string	The ID of the file. The file's `purpose` must be one of the following: `business_icon`, `business_logo`, `customer_signature`, `dispute_evidence`, `finance_report_run`, `financial_account_statement`, `identity_document_downloadable`, `issuing_regulatory_reporting`, `pci_document`, `selfie`, `sigma_scheduled_query`, `tax_document_user_upload`, `terminal_android_apk`, or `terminal_reader_splashscreen`.
`metadata`	one of multiple schemas	Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.

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.
`expired` required	boolean	Returns if the link is already expired.
`expires_at`	integer	Time that the link expires.
`file` required	one of multiple schemas	The file object this link points to.
`id` required	string	Unique identifier for the object.
`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`.
`metadata` required	object	Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
`object` required	string	String representing the object's type. Objects of the same type share the same value.
`url`	string	The publicly accessible URL to download the file.

HTTP default: Error response.

Field	Type	Description
`error` required	api_errors

GET /v1/file_links/{link}

Retrieve a file link

Retrieves the file link with the given ID.

Request parameters

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

object. See the OpenAPI specification for the complete schema.

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.
`expired` required	boolean	Returns if the link is already expired.
`expires_at`	integer	Time that the link expires.
`file` required	one of multiple schemas	The file object this link points to.
`id` required	string	Unique identifier for the object.
`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`.
`metadata` required	object	Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
`object` required	string	String representing the object's type. Objects of the same type share the same value.
`url`	string	The publicly accessible URL to download the file.

HTTP default: Error response.

Field	Type	Description
`error` required	api_errors

POST /v1/file_links/{link}

Update a file link

Updates an existing file link object. Expired links can no longer be updated.

Request parameters

Parameter	Location	Type	Description
`link`	path	string

Field	Type	Description
`expand`	array of string	Specifies which fields in the response should be expanded.
`expires_at`	one of multiple schemas	A future timestamp after which the link will no longer be usable, or `now` to expire the link immediately.
`metadata`	one of multiple schemas	Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.

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.
`expired` required	boolean	Returns if the link is already expired.
`expires_at`	integer	Time that the link expires.
`file` required	one of multiple schemas	The file object this link points to.
`id` required	string	Unique identifier for the object.
`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`.
`metadata` required	object	Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
`object` required	string	String representing the object's type. Objects of the same type share the same value.
`url`	string	The publicly accessible URL to download the file.

HTTP default: Error response.

Field	Type	Description
`error` required	api_errors