Increase Entity Onboarding Sessions API
Entity Onboarding Sessions let your customers onboard themselves by completing Increase-hosted forms. Create a session and redirect your customer to the returned URL. When they're done, they'll be redirected back to your site. This API is used for [hosted onboarding](/documentation/hosted-onboarding).
Increase Entity Onboarding Sessions 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 Onboarding Sessions. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 4 operations across 3 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 Entity Onboarding Sessions API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (bearerAuth).
By default, every request must be authenticated.
Paths & Operations 4
Across 3 paths, the API surfaces 4 operations — 2 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.
Entity Onboarding Sessions let your customers onboard themselves by completing Increase-hosted forms. Create a session and redirect your customer to the returned URL. When they're…
Schemas 4
The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are entity_onboarding_session (10 properties), create_an_entity_onboarding_session_parameters (3 properties), entity_onboarding_session_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.