---
title: "Retrieve an Entity Onboarding Session"
method: GET
path: "/entity_onboarding_sessions/{entity_onboarding_session_id}"
---

# Retrieve an Entity Onboarding Session

`GET /entity_onboarding_sessions/{entity_onboarding_session_id}`

## Path parameters

- `entity_onboarding_session_id` string, required — The identifier of the Entity Onboarding Session.

## Response `200`

Entity Onboarding Session

- EntityOnboardingSession — 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).
  - `created_at` string, date-time, required — The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Entity Onboarding Session was created.
  - `entity_id` string, nullable, required — The identifier of the Entity associated with this session, if one has been created or was provided when creating the session.
  - `expires_at` string, date-time, required — The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Entity Onboarding Session will expire.
  - `id` string, required — The Entity Onboarding Session's identifier.
  - `idempotency_key` string, nullable, required — 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_id` string, required — The identifier of the Program the Entity will be onboarded to.
  - `redirect_url` string, required — 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` string, nullable, required — The URL containing the onboarding form. You should share this link with your customer. Only present when the session is active.
  - `status` 'active' | 'expired', required — The status of the onboarding session.
  - `type` 'entity_onboarding_session', required — A constant representing the object's type. For this resource it will always be `entity_onboarding_session`.

## Other responses

- `4XX` — Error
- `5XX` — Error

---

[API](https://skmtc.net/increase/apis/increase-api-2.md) · [All operations](https://skmtc.net/increase/apis/increase-api-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/increase/increase-api-2/versions/e968bcd4dcf9/schema)