Increase.EntityOnboardingSessions.EntityOnboardingSession (Increase v1.0.0)

Copy Markdown View Source

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].

Fields

  • id - The Entity Onboarding Session's identifier.
  • created_at - The ISO 8601 date and time at which the Entity Onboarding Session was created.
  • entity_id - The identifier of the Entity associated with this session, if one has been created or was provided when creating the session.
  • expires_at - The ISO 8601 date and time at which the Entity Onboarding Session will expire.
  • idempotency_key - The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.
  • program_id - The identifier of the Program the Entity will be onboarded to.
  • redirect_url - The URL to redirect to after the onboarding session is complete. Increase will include the query parameters entity_onboarding_session_id and entity_id when redirecting.
  • session_url - The URL containing the onboarding form. You should share this link with your customer. Only present when the session is active.
  • status - The status of the onboarding session.
  • type - A constant representing the object's type. For this resource it will always be entity_onboarding_session.

Summary

Types

t()

Types

t()

@type t() :: %Increase.EntityOnboardingSessions.EntityOnboardingSession{
  created_at: DateTime.t(),
  entity_id: String.t() | nil,
  expires_at: DateTime.t(),
  id: String.t(),
  idempotency_key: String.t() | nil,
  program_id: String.t(),
  redirect_url: String.t(),
  session_url: String.t() | nil,
  status: String.t(),
  type: String.t()
}