Onboard with Hosted Onboarding
Beta

Last updated: August 21, 2024

Our Hosted Onboarding feature allows your sub-entities to onboard directly with Checkout.com.

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.

Sign in to the Dashboard.
Go to Payments > Processing > Sub-entities.
Select the + Onboard a business option on the page.
Select the Send invitation to sub-entity option to request that the sub-entity provide the required information themselves. This process is referred to as Hosted Onboarding.
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.

The recipient will be sent 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, you can use the Resend invite option to send a new invite from the Dashboard's sub-entities list.

To send an invite with the API, send a request to the POST /accounts/entities endpoint, with only the following fields included:

reference
contact_details.invitee.email
is_draft, set to true

post

https://api.checkout.com/accounts/entities


1{
2  "reference": "REF23994",
3  "is_draft": true,
4  "contact_details": {
5    "invitee": {
6      "email": "[email protected]"
7    }
8  }
9}


1{
2  "id": "ent_mrpeowpdytn62ypm6ekbch5wvq",
3  "reference": "REF23994",
4  "status": "draft",
5  "requirements_due": [],
6  "capabilities": {
7    "payments": {
8      "enabled": false,
9      "available": true
10    },
11    "payouts": {
12      "enabled": false,
13      "available": true
14    },
15    "issuing": {
16      "enabled": false,
17      "available": false
18    }
19  },
20  "_links": {
21    "self": {
22      "href": "https://api.sandbox.checkout.com/accounts/entities/ent_mrpeowpdytn62ypm6ekbch5wvq"
23    }
24  }
25}

The recipient will be sent 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, send a request with an empty body to the following endpoint:

put

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

If your sub-entity encounters issues when submitting their application, or is missing required due diligence information, you can update the sub-entity's details yourself with the API.

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.

To make draft changes and allow the sub-entity to submit the application themselves at a later time, set the is_draft field to true. To submit the application on the sub-entity's behalf, set the field to false.

put

https://api.checkout.com/accounts/entities/{id}


1{
2  "reference": "acme0123456",
3  "is_draft": false,
4  "contact_details": {
5    "invitee": {
6      "email": "[email protected]"
7    },
8    "phone": {
9      "number": "1234567890"
10    },
11    "email_addresses": {
12      "primary": "[email protected]"
13    }
14  },
15  "profile": {
16    "urls": ["https://www.acme-corp.com"],
17    "mccs": ["5814"]
18  },
19  "individual": {
20    "first_name": "Jane",
21    "last_name": "Smith",
22    "trading_name": "Acme Corporation",
23    "national_tax_id": "1234567",
24    "registered_address": {
25      "address_line1": "123 High St.",
26      "city": "London",
27      "zip": "SW1A 1AA",
28      "country": "GB"
29    },
30    "date_of_birth": {
31      "day": 1,
32      "month": 1,
33      "year": 1990
34    }
35  }
36}


1{
2  "id": "ent_wxglze3wwywujg4nna5fb7ldli",
3  "reference": "acmeCorp1234",
4  "status": "pending",
5  "capabilities": {
6    "payments": {
7      "available": true,
8      "enabled": false
9    },
10    "payouts": {
11      "available": false,
12      "enabled": false
13    },
14    "requirements_due": [],
15    "_links": {
16      "self": {
17        "href": "https://api.sandbox.checkout.com/accounts/entities/ent_wxglze3wwywujg4nna5fb7ldli"
18      }
19    }
20  }
21}

Information

We may need to conduct additional due diligence checks when you update a sub-entity. Your sub-entity's capabilities will not be affected while the checks are being performed.

When your sub-entity has submitted all of the required information, we will automatically trigger the verification process.

If the sub-entity passes, their capabilities will be enabled, as determined by your Integrated Platforms account type. If you are on a Lite account, your sub-entity will have access to payment capabilities. If you are on a Full account, your sub-entity will have access to payment and payout capabilities.

To review the status of a sub-entity you've invited, go to the Payments > Processing > Sub-entities > Sub-entity details page on the Dashboard. Until the sub-entity submits all of the required information, they will continue to be in Draft status.

Onboard with Hosted Onboarding
Beta

Information

Send an invite with the Dashboard

Send an invite with the API

Request example

Response example

Resend an invite

Update a sub-entity

Information

Request example

Response example

Information

Sub-entity verification