Increase Files API
Files are objects that represent a file hosted on Increase's servers. The file may have been uploaded by you (for example, when uploading a check image) or it may have been created by Increase (for example, an autogenerated statement PDF). If you need to download a File, create a File Link.
Increase Files API is one of 56 APIs that Increase publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Files. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 3 operations across 2 paths, and defines 4 schemas. It is described by OpenAPI 3.1.0, at version 0.0.1.
Requests are made against 2 base URLs: https://api.increase.com, https://sandbox.increase.com.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Increase Files API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (bearerAuth).
By default, every request must be authenticated.
Paths & Operations 3
Across 2 paths, the API surfaces 3 operations — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Files are objects that represent a file hosted on Increase's servers. The file may have been uploaded by you (for example, when uploading a check image) or it may have been create…
Schemas 4
The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are file (9 properties), create_a_file_parameters (3 properties), file_list (2 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Increase 12
Other APIs Increase publishes across the network.