Onboard with Hosted Onboarding
Beta
Last updated: December 24, 2025
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.
To send an invite in the Dashboard:
- Sign in to the Dashboard.
- Go to Payments > Processing > Sub-entities.
- On the Sub-entities page, select + Onboard a sub-entity.
- On the pop-up window that appears, select Send invitation to sub-entity, and then select Continue.
- Select the parent entity for the sub-entity you're onboarding. This is the entity name assigned to your platform.
- Enter a unique alphanumeric reference for the sub-entity.
- Enter the email address to send the sub-entity's invitation to, and select Send invitation.
- Select Done.
Checkout.com sends the recipient an email prompting them to sign in to the Dashboard to complete their application.
You can only have one active invite per recipient email address. If the invitation link expires:
- Go to Payments > Processing > Sub-entities.
- On the Sub-entities page, select Resend invite on the required sub-entity to send them a new invite.
To send an invite using the API, call the Onboard an entity endpoint with only the following fields:
referencecontact_details.invitee.emailis_draft, set totrue
Information
Your base URL [prefix] is unique. To learn how to retrieve your unique base URLs for the sandbox and production environments, see API endpoints.
post
https://[prefix].api.checkout.com/accounts/entities
Checkout.com sends the recipient an email prompting them to sign in to the Dashboard to complete their application.
You can only have one active invite per recipient email address. If the invitation link expires, call the Reinvite a sub-entity member endpoint with an empty body.
Information
Your base URL [prefix] is unique. To learn how to retrieve your unique base URLs for the sandbox and production environments, see API endpoints.
put
https://[prefix].api.checkout.com/accounts/entities/{id}/members/{id}
If your sub-entity encounters issues when submitting their onboarding application, or is missing required information, you can update the sub-entity's details using the API. See 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.
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 on the Payments > Processing > 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, we also notify you asynchronously of any changes to your sub-entity's status using the Status changed webhook.
If the sub-entity passes the checks, its capabilities are enabled, as per your Platforms account type. 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.