increase-test
POST/entity_onboarding_sessions

Create an entity onboarding session

Creates an entity onboarding session so a customer can complete an Increase-hosted onboarding form. Supply program_id and redirect_url; optionally provide entity_id to associate an existing entity and display its outstanding onboarding tasks. Redirect the customer to the returned session URL to begin onboarding.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

3 body fields

Configuration for the hosted entity onboarding session.

entity_idstringoptional
The identifier of an existing Entity to associate with the onboarding session. If provided, the onboarding form will display any outstanding tasks required to complete the Entity's onboarding.
program_idstringrequired
The identifier of the Program the Entity will be onboarded to.
redirect_urlstringrequired
The URL to redirect the customer to after they complete the onboarding form. The redirect will include `entity_onboarding_session_id` and `entity_id` query parameters.

3 status codes
200Returns the created entity onboarding session, including its identifier, status, expiration time, session URL, redirect URL, and program identifier.
created_atstringrequired
The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Entity Onboarding Session was created.
entity_idstringrequired
The identifier of the Entity associated with this session, if one has been created or was provided when creating the session.
expires_atstringrequired
The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Entity Onboarding Session will expire.
idstringrequired
The Entity Onboarding Session's identifier.
idempotency_keystringrequired
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](https://increase.com/documentation/idempotency-keys).
program_idstringrequired
The identifier of the Program the Entity will be onboarded to.
redirect_urlstringrequired
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_urlstringrequired
The URL containing the onboarding form. You should share this link with your customer. Only present when the session is active.
statusstringrequired
The status of the onboarding session.
Allowed:activeexpired
typestringrequired
A constant representing the object's type. For this resource it will always be `entity_onboarding_session`.
Allowed:entity_onboarding_session
4XXReturned when the request has a client-side error.
5XXReturned when the request encounters a server-side error.

Error handling

program_id and redirect_url are required. If supplied, entity_id must identify an existing entity.