# Onboard with Hosted Onboarding

With our Hosted Onboarding feature, you can invite your sub-entities to onboard directly to your platform.

When you send an invite to a sub-entity, they'll be prompted to provide the required onboarding information themselves through the Dashboard.

You can send an invite using the Dashboard, or the API.

> **Information**
>
> To enable the Hosted Onboarding feature on your account, contact your account manager.

---

## Send an invite in the Dashboard

To send an invite in the Dashboard:

1. Sign in to the [Dashboard](https://dashboard.checkout.com).
2. Go to _Sub-entities_.
3. Select _+ Onboard a sub-entity_.
4. On the pop-up window that appears, select _Send invitation to sub-entity_, and then select _Continue_.
5. Select the parent entity for the sub-entity you're onboarding. This is the entity name assigned to your platform.
6. Enter a unique alphanumeric reference for the sub-entity.
7. Enter the email address to send the sub-entity's invitation to, and select _Send invitation_.
8. Select _Done_.

Checkout.com sends the recipient an email prompting them to sign in to the Dashboard to complete their application.

## Resend an invite in the Dashboard

You can only have one active invite per recipient email address. If the invitation link expires:

1. Go to _Sub-entities_.
2. Select _Resend invite_ on the required sub-entity to send them a new invite.

---

## Send an invite using the API

To send an invite using the API, call the [Onboard an entity](https://api-reference.checkout.com/tag/Platforms/#operation/onboardEntity) endpoint with only the following fields:

- `reference`
- `contact_details.invitee.email`
- `is_draft`, set to `true`

> **Information**
>
> Your base URL's `{prefix}` value is unique to your account and environment. To learn how to retrieve your base URLs for the sandbox and production environments, see [API endpoints](https://www.checkout.com/docs/developer-resources/api/api-endpoints.md).

**Production**

`POST` `https://{prefix}.api.checkout.com/accounts/entities`

**Sandbox**

`POST` `https://{prefix}.api.sandbox.checkout.com/accounts/entities`

### Request example

```json
{
  "reference": "REF23994",
  "is_draft": true,
  "contact_details": {
    "invitee": {
      "email": "jane.smith@example.com"
    }
  }
}
```

### Response example

```json
{
  "id": "ent_mrpeowpdytn62ypm6ekbch5wvq",
  "reference": "REF23994",
  "status": "draft",
  "requirements_due": [],
  "capabilities": {
    "payments": {
      "enabled": false,
      "available": true
    },
    "payouts": {
      "enabled": false,
      "available": true
    },
    "issuing": {
      "enabled": false,
      "available": false
    }
  },
  "_links": {
    "self": {
      "href": "https://{prefix}.api.sandbox.checkout.com/accounts/entities/ent_mrpeowpdytn62ypm6ekbch5wvq"
    }
  }
}
```

Checkout.com sends the recipient an email prompting them to sign in to the Dashboard to complete their application.

## Resend an invite using the API

You can only have one active invite per recipient email address. If the invitation link expires, call the [Reinvite a sub-entity member](https://api-reference.checkout.com/tag/Platforms/#operation/reinviteSubEntityMembers) endpoint with an empty body.

> **Information**
>
> Your base URL's `{prefix}` value is unique to your account and environment. To learn how to retrieve your base URLs for the sandbox and production environments, see [API endpoints](https://www.checkout.com/docs/developer-resources/api/api-endpoints.md).

**Production**

`PUT` `https://{prefix}.api.checkout.com/accounts/entities/{id}/members/{id}`

**Sandbox**

`PUT` `https://{prefix}.api.sandbox.checkout.com/accounts/entities/{id}/members/{id}`

---

## Update a sub-entity

If your sub-entity encounters issues when submitting their onboarding application, or is missing [required information](https://www.checkout.com/docs/platforms/onboard-sub-entities/collect-verification-information.md), you can update the sub-entity's details using the API. See [Update a sub-entity in a hosted onboarding flow](https://www.checkout.com/docs/platforms/manage-sub-entities/update-a-sub-entity.md#Update_a_sub-entity_in_a_hosted_onboarding_flow) for more information.

> **Information**
>
> You can only use the API to complete the sub-entity's application on their behalf, as the application is not accessible from the Dashboard.

---

## Sub-entity verification

When your sub-entity has submitted all of the required information, Checkout.com automatically triggers the verification process.

To find out what stage of the verification process your sub-entity is currently in, view its [status](https://www.checkout.com/docs/platforms/manage-sub-entities/sub-entity-status.md) on the _Sub-entities_ section of the Dashboard. Until the sub-entity submits all of the required information, they will continue to be in _Draft_ status.

If you've configured your [webhook server](https://www.checkout.com/docs/developer-resources/event-notifications/receive-webhooks/configure-your-webhook-server.md), we also notify you asynchronously of any changes to your sub-entity's status using the [Status changed](https://www.checkout.com/docs/developer-resources/event-notifications/event-types/status_changed.md) webhook.

If the sub-entity passes the checks, its capabilities are enabled, as per your Platforms [account type](https://www.checkout.com/docs/platforms/account-types.md). If you are on a `Lite` account, your sub-entity only has access to payment capabilities. If you are on a `Full` account, your sub-entity has access to payment and payout capabilities.

---

## Related topics

**[Handle webhooks](https://www.checkout.com/docs/platforms/onboard-sub-entities/handle-webhooks.md)**

Learn about the different webhooks you receive when onboarding sub-entities.

**[Sub-entity status](https://www.checkout.com/docs/platforms/manage-sub-entities/sub-entity-status.md)**

Learn about the different sub-entity statuses.