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].
See https://increase.com/documentation/api/entity-onboarding-sessions for the full API reference for this resource.
Summary
Functions
Create an Entity Onboarding Session
Expire an Entity Onboarding Session
List Entity Onboarding Session
Retrieve an Entity Onboarding Session
Functions
@spec create(Increase.Client.t() | keyword() | nil, map() | keyword(), keyword()) :: {:ok, Increase.EntityOnboardingSessions.EntityOnboardingSession.t()} | {:error, Increase.Error.t()}
Create an Entity Onboarding Session
POST /entity_onboarding_sessions
@spec expire(Increase.Client.t() | keyword() | nil, String.t(), keyword()) :: {:ok, Increase.EntityOnboardingSessions.EntityOnboardingSession.t()} | {:error, Increase.Error.t()}
Expire an Entity Onboarding Session
POST /entity_onboarding_sessions/{entity_onboarding_session_id}/expire
@spec list(Increase.Client.t() | keyword() | nil, map() | keyword(), keyword()) :: {:ok, Increase.Page.t()} | {:error, Increase.Error.t()}
List Entity Onboarding Session
Returns a %Increase.Page{} whose data is a list of %__MODULE__. EntityOnboardingSession{} structs. Page through results with
Increase.Page.auto_paging_stream/1 or Increase.Page.auto_paging_each/2.
GET /entity_onboarding_sessions
@spec retrieve(Increase.Client.t() | keyword() | nil, String.t(), keyword()) :: {:ok, Increase.EntityOnboardingSessions.EntityOnboardingSession.t()} | {:error, Increase.Error.t()}
Retrieve an Entity Onboarding Session
GET /entity_onboarding_sessions/{entity_onboarding_session_id}