POST
/entity_onboarding_sessions/{entity_onboarding_session_id}/expireExpire an entity onboarding session
Expires an entity onboarding session so the customer can no longer use it to complete the hosted onboarding form. Use entity_onboarding_session_id to identify the session to expire.
- IdempotentThe SDK sends
Idempotency-Key, so a retried request is only applied once.
entity_onboarding_session_idstringrequired
The identifier of the entity onboarding session to expire.
200Returns the entity onboarding session object, including its status and expiration time.
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.
typestringrequired
A constant representing the object's type. For this resource it will always be `entity_onboarding_session`.
4XXReturned when the request has a client-side error.
5XXReturned when the request encounters a server-side error.
Error handling
The entity_onboarding_session_id path parameter must identify an existing entity onboarding session.