Retrieve sub-entity details
Beta

Last updated: October 7, 2026

As a SaaS platform, you can retrieve the details of an existing sub-entity by using the Dashboard or the API.

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

Sign in to the Dashboard.
Go to Sub-entities.
Select a sub-entity.

You can view the details of the sub-entity in the Overview tab that opens. Depending on the capabilities enabled, you can see more information in the Overview, Payments and Payouts tabs.

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's {prefix} value is unique to your account and environment. To learn how to retrieve your base URLs for the sandbox and production environments, see API endpoints.

get

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

The response returns the sub-entity's information, including status and processing capabilities.


1{
2  "company": {
3    "principal_address": {
4      "address_line1": "123 Main Street",
5      "city": "San Francisco",
6      "state": "CA",
7      "zip": "94105",
8      "country": "US"
9    },
10    "registered_address": {
11      "address_line1": "123 Main Street",
12      "city": "San Francisco",
13      "state": "CA",
14      "zip": "94105",
15      "country": "US"
16    },
17    "legal_name": "Approved business details change",
18    "trading_name": "Business details approved",
19    "business_registration_number": "12-3456789",
20    "business_type": "private_corporation",
21    "date_of_incorporation": {
22      "year": 2025,
23      "month": 10,
24      "day": 1
25    },
26    "representatives": [
27      {
28        "id": "rep_5321d3559be9c47408d7044c21",
29        "individual": {
30          "first_name": "Toby",
31          "last_name": "Arden",
32          "date_of_birth": {
33            "year": 1990,
34            "month": 1,
35            "day": 15
36          },
37          "place_of_birth": {
38            "country": "US"
39          },
40          "email_address": "toby.arden@example.com",
41          "address": {
42            "address_line1": "123 Main Street",
43            "city": "San Francisco",
44            "state": "CA",
45            "zip": "94105",
46            "country": "US"
47          },
48          "phone": {
49            "number": "4155678901",
50            "country_code": "US"
51          },
52          "citizenships": [
53            {
54              "type": "citizen",
55              "country": "US"
56            }
57          ],
58          "national_id_number": "043846687",
59          "national_id_type": "ssn"
60        },
61        "company_position": "ceo",
62        "roles": [
63          "ubo",
64          "control_person"
65        ],
66        "ownership_percentage": 25
67      },
68      {
69        "id": "rep_6c1da0d0f5e7f6059f67dd24e1",
70        "individual": {
71          "first_name": "Alex",
72          "last_name": "Morgan",
73          "date_of_birth": {
74            "year": 1985,
75            "month": 6,
76            "day": 22
77          },
78          "place_of_birth": {
79            "country": "US"
80          },
81          "email_address": "alex.morgan@example.com",
82          "address": {
83            "address_line1": "123 Main Street",
84            "city": "San Francisco",
85            "state": "CA",
86            "zip": "94105",
87            "country": "US"
88          },
89          "phone": {
90            "number": "4155678902",
91            "country_code": "US"
92          },
93          "citizenships": [
94            {
95              "type": "citizen",
96              "country": "US"
97            }
98          ],
99          "national_id_number": "043846687",
100          "national_id_type": "ssn"
101        },
102        "roles": [
103          "authorised_signatory"
104        ]
105      }
106    ]
107  },
108  "id": "ent_me5n7ceyb7vdvpqtexw32ytaca",
109  "profile": {
110    "urls": [
111      "https://www.isv-seller-example.com"
112    ],
113    "mccs": [
114      "5599"
115    ],
116    "holding_currencies": [
117      "USD"
118    ],
119    "default_holding_currency": "USD"
120  },
121  "contact_details": {
122    "phone": {
123      "country_code": "US",
124      "number": "4155678900"
125    },
126    "email_addresses": {
127      "primary": "toby.arden@example.com",
128      "pci_compliance_contact": "pci.contact@example.com"
129    }
130  },
131  "processing_details": {
132    "target_countries": [
133      "US"
134    ],
135    "annual_processing_volume": 1000,
136    "average_transaction_value": 2000,
137    "average_order_fulfillment_time": 3,
138    "currency": "USD"
139  },
140  "seller_category": "gold",
141  "status": "active",
142  "reference": "Wh7ML4QHQzjNaQr",
143  "capabilities": {
144    "payouts": {
145      "enabled": false,
146      "available": true
147    },
148    "payments": {
149      "enabled": true,
150      "available": true
151    },
152    "issuing": {
153      "enabled": false,
154      "available": false
155    }
156  },
157  "_links": {
158    "self": {
159      "href": "https://api.checkout.com/accounts/entities/ent_me5n7ceyb7vdvpqtexw32ytaca"
160    },
161    "requirements": {
162      "href": "https://api.checkout.com/accounts/entities/ent_me5n7ceyb7vdvpqtexw32ytaca/requirements"
163    }
164  }
165}


1{
2  "contact_details": {
3    "phone": {
4      "country_code": "US",
5      "number": "5550005550"
6    },
7    "email_addresses": {
8      "primary": "hannah.bret@example.com"
9    }
10  },
11  "profile": {
12    "default_holding_currency": "USD",
13    "holding_currencies": [
14      "USD"
15    ],
16    "urls": [
17      "https://www.example.net"
18    ],
19    "mccs": [
20      "5551"
21    ]
22  },
23  "company": {
24    "is_registered_company": false,
25    "trading_name": "The Online Retailer",
26    "principal_address": {
27      "address_line1": "123 Anywhere St.",
28      "city": "Anytown",
29      "state": "AL",
30      "zip": "12345",
31      "country": "US"
32    },
33    "representatives": [
34      {
35        "id": "rep_y6w7nu2glwicpmoxj4g74fho3i",
36        "roles": [
37          "ubo"
38        ],
39        "individual": {
40          "email_address": "hannah.bret@example.com",
41          "address": {
42            "address_line1": "123 Anywhere St.",
43            "city": "Anytown",
44            "state": "AL",
45            "zip": "12345",
46            "country": "US"
47          },
48          "first_name": "Hannah",
49          "last_name": "Bret",
50          "date_of_birth": {
51            "day": 23,
52            "month": 1,
53            "year": 1990
54          },
55          "place_of_birth": {
56            "country": "US"
57          }
58        }
59      }
60    ],
61    "business_type": "individual_or_sole_proprietorship",
62    "date_of_incorporation": {
63      "day": 1,
64      "month": 2,
65      "year": 2020
66    }
67  },
68  "processing_details": {
69    "annual_processing_volume": 125000,
70    "average_transaction_value": 5000,
71    "average_order_fulfillment_time": 3,
72    "currency": "USD",
73    "target_countries": [
74      "US",
75      "VI"
76    ]
77  },
78  "id": "ent_5nzolfdtzu4h62ilkl5vqycu3q",
79  "reference": "isv-sole-trader-example001",
80  "status": "pending",
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://{prefix}.api.checkout.com/accounts/entities/ent_5nzolfdtzu4h62ilkl5vqycu3q"
98    },
99    "schema": {
100      "href": "https://{prefix}.api.checkout.com/accounts/_schema?operation=post&resource_type=entity&principal_country=US&type=company&business_type=individual_or_sole_proprietorship&db_status=pending&schema_version=3.0&parent_entity_id=ent_rqj5j72ujsfuvlfbliczhvwqs4&entity_level=subentity"
101    }
102  }
103}

Retrieve sub-entity details
Beta

Retrieve sub-entity details in the Dashboard

Retrieve sub-entity details using the API

Information

Response examples