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 Entities API

Entities are the legal entities that own accounts. They can be people, corporations, partnerships, government authorities, or trusts. To learn more, see [Entities](/documentation/entities).

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

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

This API exposes 5 operations across 3 paths, and defines 6 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.

5 operations 3 paths 6 schemas 2 GET1 PATCH2 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 Entities API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

Paths & Operations 5

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

Entities 5

Entities are the legal entities that own accounts. They can be people, corporations, partnerships, government authorities, or trusts. To learn more, see [Entities](/documentation/…

GET
/entities
List Entities
list_entities 8 params → 2004XX5XX
POST
/entities
Create an Entity
create_an_entity body → 2004XX5XX
GET
/entities/{entity_id}
Retrieve an Entity
retrieve_an_entity 1 param → 2004XX5XX
PATCH
/entities/{entity_id}
Update an Entity
update_an_entity 1 param body → 2004XX5XX
POST
/entities/{entity_id}/archive
Archive an Entity
archive_an_entity 1 param → 2004XX5XX

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are entity (19 properties), create_an_entity_parameters (11 properties), update_an_entity_parameters (8 properties), entity_supplemental_document (5 properties). Each schema is shown below with its type and property counts.

error
entity_list
object
A list of Entity objects.
2 properties 2 required
update_an_entity_parameters
object
8 properties
entity
object
Entities are the legal entities that own accounts. They can be people, corporations, partnerships, government authorities, or trusts. To learn more, see [Entit…
19 properties 19 required
create_an_entity_parameters
object
11 properties 1 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-entities-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