Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Increase Entity Supplemental Documents API

The Entity Supplemental Documents API from Increase — 1 operation(s) for entity supplemental documents.

Increase Entity Supplemental Documents API is one of 56 APIs that Increase publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Entity Supplemental Documents. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 2 operations across 1 path, 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.

2 operations 1 paths 4 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.0.1
Base URL
https://api.increase.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Increase Entity Supplemental Documents API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

Paths & Operations 2

Across 1 path, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Entity Supplemental Documents 2
GET
/entity_supplemental_documents
List Entity Supplemental Document Submissions
list_entity_supplemental_document_submissions 4 params → 2004XX5XX
POST
/entity_supplemental_documents
Create a supplemental document for an Entity
create_a_supplemental_document_for_an_entity body → 2004XX5XX

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are entity_supplemental_document (5 properties), create_a_supplemental_document_for_an_entity_parameters (2 properties), entity_supplemental_document_list (2 properties). Each schema is shown below with its type and property counts.

error
entity_supplemental_document_list
object
A list of Supplemental Document objects.
2 properties 2 required
create_a_supplemental_document_for_an_entity_parameters
object
2 properties 2 required
entity_supplemental_document
object
Supplemental Documents are uploaded files connected to an Entity during onboarding.
5 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

increase-entity-supplemental-documents-api-openapi.yml Raw ↑

Other APIs Increase publishes across the network.

Increase Account Numbers API
Increase Account Statements API
Increase Account Transfers API
Increase Accounts API
Increase Ach Prenotifications API
Increase Ach Transfers API
Increase Card Disputes API
Increase Card Payments API
Increase Card Purchase Supplements API
Increase Card Push Transfers API
Increase Card Tokens API
Increase Card Validations API