Retrieve sub-entity details

Last updated: December 24, 2025

You can retrieve the details of an existing sub-entity on your platform by using the Dashboard, or the API.

To retrieve details of a sub-entity in the Dashboard:

Sign in to the Dashboard.
Go to Payments > Processing > Sub-entities.
On the Sub-entities page, select the sub-entity to edit.
On the Activity page, select Manage account.

The Manage account page opens and displays all the details of the sub-entity.

To retrieve the details of a sub-entity, call the Get entity details endpoint, and provide the sub-entity ID as the {id} path parameter. For example, https://[prefix].api.checkout.com/accounts/entities/ent_nofjig36ypra6236f4tfm5bvui.

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.

get

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

The response returns all data provided about the sub-entity, including its capabilities, which informs whether this sub-entity can process payments.

If the sub-entity is in requirements_due status, the response also returns a requirements_due object that lists the affected fields along with the reason each field was rejected.


1{
2  "id": "ent_nofjig36ypra6236f4tfm5bvui",
3  "reference": "CAKE12345",
4  "status": "pending",
5  "capabilities": {
6    "payments": {
7      "enabled": false
8    },
9    "payouts": {
10      "enabled": false
11    }
12  },
13  "profile": {
14    "default_holding_currency": "GBP",
15    "urls": ["https://www.thecakeshop.com"],
16    "mccs": ["5814"]
17  },
18  "company": {
19    "legal_name": "The Cake Shop Inc.",
20    "trading_name": "The Cake Shop",
21    "principal_address": {
22      "address_line1": "654 Example St.",
23      "city": "Edinburgh",
24      "zip": "EH9 2XY",
25      "country": "GB"
26    },
27    "representatives": []
28  },
29  "contact_details": {
30    "phone": {
31      "number": "7700900000"
32    },
33    "email_addresses": {
34      "primary": "[email protected]"
35    }
36  },
37  "instruments": [],
38  "requirements_due": [],
39  "_links": {
40    "self": {
41      "href": "https://[prefix].api.sandbox.checkout.com/accounts/entities/ent_nofjig36ypra6236f4tfm5bvui"
42    }
43  }
44}

Information

The profile.default_holding_currency field is required for Full account types. For Lite accounts, we set a default value in case you decide to upgrade to a Full account type later. This doesn't affect how funds are routed or held for this sub-entity.


1{
2  "id": "ent_nofjig36ypra6236f4tfm5bvui",
3  "reference": "DONUTS12345",
4  "status": "active",
5  "capabilities": {
6    "payments": {
7      "available": true,
8      "enabled": true
9    },
10    "payouts": {
11      "available": false,
12      "enabled": false
13    }
14  },
15  "profile": {
16    "default_holding_currency": "GBP",
17    "urls": ["https://www.alis-donuts.com"],
18    "mccs": ["5814"]
19  },
20  "individual": {
21    "first_name": "Ali",
22    "last_name": "Farid",
23    "trading_name": "Ali's Donuts",
24    "legal_name": "Ali Farid",
25    "national_tax_id": "1234567",
26    "registered_address": {
27      "address_line1": "123 High St.",
28      "city": "London",
29      "zip": "SW1A 1AA",
30      "country": "GB"
31    }
32  },
33  "contact_details": {
34    "phone": {
35      "number": "7700900000"
36    },
37    "email_addresses": {
38      "primary": "[email protected]"
39    }
40  },
41  "instruments": [],
42  "requirements_due": [],
43  "_links": {
44    "self": {
45      "href": "https://[prefix].api.sandbox.checkout.com/accounts/entities/ent_vv2jjkuf2gzj5tcw2x7ptua7zy"
46    }
47  }
48}

Information

The legal_name field is auto-generated based on the first_name, middle_name and last_name provided during onboarding.
The profile.default_holding_currency field is required for Full account types. For Lite accounts, we set a default value in case you decide to upgrade to a Full account type later. This doesn't affect how funds are routed or held for this sub-entity. Also, this field is not currently updatable. If you need to change it, contact support.


1{
2  "id": "ent_nofjig36ypra6236f4tfm5bvui",
3  "reference": "cakeshop678910",
4  "status": "pending",
5  "capabilities": {
6    "payments": {
7      "enabled": false
8    },
9    "payouts": {
10      "enabled": false
11    }
12  },
13  "profile": {
14    "default_holding_currency": "GBP",
15    "urls": ["https://www.thecakeshop.com"],
16    "mccs": ["5814"]
17  },
18  "company": {
19    "legal_name": "The Cake Shop Inc.",
20    "trading_name": "The Cake Shop",
21    "principal_address": {
22      "address_line1": "90 Tottenham Court Road",
23      "city": "London",
24      "zip": "W1T4TJ",
25      "country": "GB"
26    },
27    "representatives": []
28  },
29  "contact_details": {
30    "phone": {
31      "number": "111222333"
32    },
33    "email_addresses": {
34      "primary": "[email protected]"
35    }
36  },
37  "instruments": [],
38  "requirements_due": [],
39  "_links": {
40    "self": {
41      "href": "https://[prefix].api.sandbox.checkout.com/accounts/entities/ent_nofjig36ypra6236f4tfm5bvui"
42    }
43  }
44}

Information

The profile.default_holding_currency field is required for Full account types and is set to a default value. Also, this field is not currently updatable. If you need to change it, contact support.


1{
2  "id": "ent_nofjig36ypra6236f4tfm5bvui",
3  "reference": "danielsdonuts0123456",
4  "status": "active",
5  "capabilities": {
6    "payments": {
7      "available": true,
8      "enabled": true
9    },
10    "payouts": {
11      "available": true,
12      "enabled": false
13    }
14  },
15  "profile": {
16    "default_holding_currency": "GBP",
17    "urls": ["https://www.daniels-donuts.com"],
18    "mccs": ["5814"]
19  },
20  "individual": {
21    "first_name": "Daniel",
22    "last_name": "Yubi",
23    "trading_name": "Daniel's Donuts",
24    "legal_name": "Daniel Yubi",
25    "national_tax_id": "1234567",
26    "registered_address": {
27      "address_line1": "90 Tottenham Court Road",
28      "city": "London",
29      "zip": "W1T4TJ",
30      "country": "GB"
31    }
32  },
33  "contact_details": {
34    "phone": {
35      "number": "2345678910"
36    },
37    "email_addresses": {
38      "primary": "[email protected]"
39    }
40  },
41  "instruments": [],
42  "requirements_due": [],
43  "_links": {
44    "self": {
45      "href": "https://[prefix].api.sandbox.checkout.com/accounts/entities/ent_vv2jjkuf2gzj5tcw2x7ptua7zy"
46    }
47  }
48}

Information

The legal_name field is auto-generated based on the first_name, middle_name, and last_name provided during onboarding.
The profile.default_holding_currency field is required for Full account types and is set to a default value. Also, this field is not currently updatable. If you need to change it, contact support.

Retrieve sub-entity details