You're viewing documentation for our latest API. This will not impact your integration, but you will need the documentation relevant to you. If you have an account with Checkout.com you have received an email confirming which version to use.
Your account type is determined during onboarding and depends on whether you require payment capabilities (lite), or payment and payout capabilities (full).
To provide you with visibility to what's going on with your sub-entities, our API responses include a status field.
You can also subscribe to the status webhook notification to keep up to date with any asynchronous changes.
If we're expecting you to provide us with more information, your sub-entity will have a status of requirements_due. With this status, the requirements_due array will also be populated to inform you of the information that is missing.
Tip
Use the information required table to find out what information is required to trigger due diligence checks.
In this example, we have created a company sub-entity without any representatives or a registered address.
We will only trigger due diligence checks when we have all the information required. Once the checks are triggered, the sub-entity's status will be pending.
We may make changes to this sub-entity's capabilities based on the outcome of these checks.
If the due diligence checks have passed, we will enable the sub-entity's payments or payouts capabilities, which will give that sub-entity a status of active. This means there are no outstanding requirements at this time.
Information
This status change is asynchronous (happening behind the scenes), so you can optionally subscribe to the status_changedwebhook notification to keep up to date or see the status by retrieving the sub-entity.
If you update information after this point, new checks will be triggered and the status of this sub-entity will go back to pending.
If due diligence checks do not pass, we will disable the sub-entity's payment and payouts capabilities. This status will change from pending to rejected. A sub-entity is rejected if we have identified reasons during our due diligence checks – this decision is final and you will not be able to resume onboarding.
To challenge the direction, please contact us directly.
Information
This status change is asynchronous (happening behind the scenes), so you can optionally subscribe to the status_changedwebhook notification to keep up to date or see the status by retrieving the sub-entity.
An attempt to update a rejected sub-entity will return a 442 response with the error code status_invalid.
