Skip to content

Last updated: March 1, 2023

During the onboarding process on the Full account type, your sub-entities go through several statuses and undergo full due diligence checks. This includes:

  • Card scheme screening (CSS)
  • Politically exposed persons (PEP) and sanctions
  • Know your customer (KYC)
  • Know your business (KYB)

We'll notify you of any sub-entity status changes via the relevant webhook notifications. The following diagram shows the possible sub-entity statuses and webhooks you may receive during the onboarding process:

Full onboarding flow

Resolve requirements_due status

Before due diligence checks can start, sub-entities must contain all the required fields. If any of these checks do not pass the review, we'll notify you via the status_changed and full_dd_failed webhooks. You can then take action to correct this and continue the review.

Information

We strongly suggest that you subscribe to the status_changed and full_dd_failed webhooks so that you are notified when action is required.

If action is required to continue sub-entity onboarding, this will be flagged with a "status": "requirements_due" field:

1
{
2
"id": "evt_htielsmgcwgejgqaunl4yb2pou",
3
"type": "status_changed",
4
"version": "1.0.0",
5
"created_on": "2020-08-20T15:24:13.8431084Z",
6
"data": {
7
"sub_entity_id": "ent_vjmdzvijizs7o26kiuiakywvyi",
8
"status": "requirements_due",
9
"reference": "tmvhWvvZfFSkJy4",
10
"legal_name": "Acme Corporation Inc."
11
},
12
"_links": {
13
"self": {
14
"href": "https://api.checkout.com/workflows/events/evt_htielsmgcwgejgqaunl4yb2pou"
15
}
16
}
17
}

You can see the reason for this status:

To see the details in the Dashboard:

  1. Sign in to your Dashboard account.
  2. Navigate to the Sub-entities section.
  3. Select the sub-entity in REQUIREMENTS_DUE status.

The Sub-entity Details page appears. The banner at the top of the page highlights the reasons for the REQUIREMENTS_DUE status and the actions you need to take.

To see the details via the Accounts API:

  1. Retrieve the sub-entity details using the

    get

    /accounts/entities/{entityId} endpoint.
  2. In the response, check the requirements_due array for impacted fields and corresponding reasons.

Response examples

1
{
2
"id": "ent_sea5kqczeqvnznx5lqsbbsnlq4",
3
"reference": "HEjzSLlfjLuvx5l",
4
"status": "requirements_due",
5
"instruments": [],
6
"requirements_due": [
7
{
8
"field": "company.document",
9
"reason": "required"
10
},
11
{
12
"field": "company.financial_details.documents.bank_statement",
13
"reason": "required"
14
},
15
{
16
"field": "company.representatives[0].identification.document",
17
"reason": "required"
18
}
19
],
20
"contact_details": {
21
"phone": {
22
"number": "1234 567890"
23
}
24
},
25
"profile": {
26
"default_holding_currency": "GBP",
27
"urls": [
28
"https://www.exampleurl.com"
29
],
30
"mccs": [
31
"5551"
32
]
33
},
34
"company": {
35
"business_registration_number": "12345678",
36
"legal_name": "Acme Corporation LTD",
37
"trading_name": "Acme Corporation",
38
"principal_address": {
39
"address_line1": "111 Example Road",
40
"city": "London",
41
"zip": "SW1A 1AA",
42
"country": "GB"
43
},
44
"registered_address": {
45
"address_line1": "111 Example Road",
46
"city": "London",
47
"zip": "SW1A 1AA",
48
"country": "GB"
49
},
50
"representatives": [
51
{
52
"id": "rep_3ipq26zsxt3n24rh2vojjkfez4",
53
"address": {
54
"address_line1": "111 Example Road",
55
"city": "London",
56
"zip": "SW1A 1AA",
57
"country": "GB"
58
},
59
"phone": {
60
"number": "1234 567890"
61
},
62
"first_name": "Jane",
63
"last_name": "Doe",
64
"date_of_birth": {
65
"day": 5,
66
"month": 6,
67
"year": 1995
68
},
69
"place_of_birth": {
70
"country": "GB"
71
},
72
"identification": {
73
"document": {
74
"type": "passport",
75
"front": "file_a2waebevmihts7s74bie3w3nf4"
76
}
77
}
78
}
79
]
80
},
81
"capabilities": {
82
"payments": {
83
"enabled": false,
84
"available": true
85
},
86
"payouts": {
87
"enabled": false,
88
"available": true
89
},
90
"issuing": {
91
"enabled": false,
92
"available": false
93
}
94
},
95
"_links": {
96
"self": {
97
"href": "https://api.checkout.com/accounts/entities/ent_sea5kqczeqvnznx5lqsbbsnlq4"
98
},
99
"schema": {
100
"href": "https://api.checkout.com/accounts/entities/_schema?resource_type=Entity&type=Company&schema_version=&country=GB"
101
}
102
}
103
}

The following table lists the possible reasons for the requirements_due status, and describes the action you will need to take to continue the review.

ReasonAction required

required

The field is required to trigger due diligence for the first time. Input the required data and resubmit.

unidentified_details

Individual details, such as address or date of birth, couldn't be verified against our provider databases. Upload an identification document for the individual or representative.

document_expired

The document provided is expired. Upload a new identification document for the individual or representative.

document_do_not_match_user_data

The details on the document provided do not match the data that was provided. Upload a new identification document for the individual or representative.

invalid_document

This can be caused by an invalid file format or document type, or a similar document issue. Upload a new identification document for the individual or representative.

verification_failed

Company details, such as legal name or registered address, couldn't be verified against our provider databases. Upload a new certificate of incorporation (COI).