Retrieve sub-entity details
Beta

Last updated: May 20, 2026

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

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 all information about the sub-entity, including its status, and capabilities, which you can refer to to understand their processing abilities.

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


1{
2   "contact_details":{
3      "phone":{
4         "country_code":"US",
5         "number":"5550005550"
6      },
7      "email_addresses":{
8         "primary":"theonlineretailer@example.com"
9      }
10   },
11   "profile":{
12      "default_holding_currency":"USD",
13      "holding_currencies":[
14         "USD"
15      ],
16      "urls":[
17         "https://www.theonlineretailer.com"
18      ],
19      "mccs":[
20         "5551"
21      ]
22   },
23   "company":{
24      "is_registered_company":true,
25      "legal_name":"The Online Retailer",
26      "trading_name":"The Online Retailer",
27      "principal_address":{
28         "address_line1":"123 Anywhere St.",
29         "city":"Anytown",
30         "state":"AL",
31         "zip":"12345",
32         "country":"US"
33      },
34      "representatives":[
35         {
36            "id":"rep_y6w7nu2glwicpmoxj4g74fho3i",
37            "roles":[
38               "ubo"
39            ],
40            "individual":{
41               "email_address":"hannah.bret@example.com",
42               "address":{
43                  "address_line1":"123 Anywhere St.",
44                  "city":"Anytown",
45                  "state":"AL",
46                  "zip":"12345",
47                  "country":"US"
48               },
49               "first_name":"Hannah",
50               "last_name":"Bret",
51               "date_of_birth":{
52                  "day":23,
53                  "month":1,
54                  "year":1990
55               },
56               "place_of_birth":{
57                  "country":"US"
58               }
59            }
60         }
61      ],
62      "business_type":"private_corporation",
63      "date_of_incorporation":{
64         "day":22,
65         "month":2,
66         "year":1990
67      }
68   },
69   "processing_details":{
70      "annual_processing_volume":125000,
71      "average_transaction_value":5000,
72      "average_order_fulfillment_time":3,
73      "currency":"USD",
74      "target_countries":[
75         "US",
76         "VI"
77      ]
78   },
79   "id":"ent_5nzolfdtzu4h62ilkl5vqycu3q",
80   "reference":"djBQD4bACGfkx3r",
81   "status":"pending",
82   "capabilities":{
83      "payments":{
84         "enabled":false,
85         "available":true
86      },
87      "payouts":{
88         "enabled":false,
89         "available":true
90      },
91      "issuing":{
92         "enabled":false,
93         "available":false
94      }
95   },
96   "requirements_due":[
97      
98   ],
99   "_links":{
100      "self":{
101         "href":"https://{prefix}.api.checkout.com/accounts/entities/ent_5nzolfdtzu4h62ilkl5vqycu3q"
102      },
103      "schema":{
104         "href":"https://{prefix}.api.checkout.com/accounts/_schema?operation=post&resource_type=entity&principal_country=US&type=company&business_type=private_corporation&db_status=requirements_due&schema_version=3.0&parent_entity_id=ent_rqj5j72ujsfuvlfbliczhvwqs4&entity_level=subentity"
105      }
106   }
107}


1{
2   "contact_details":{
3      "phone":{
4         "country_code":"US",
5         "number":"5550005550"
6      },
7      "email_addresses":{
8         "primary":"theonlineretailer@example.com"
9      }
10   },
11   "profile":{
12      "default_holding_currency":"USD",
13      "holding_currencies":[
14         "USD"
15      ],
16      "urls":[
17         "https://www.theonlineretailer.com"
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":"djBQD4bACGfkx3r",
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   "requirements_due":[
96      
97   ],
98   "_links":{
99      "self":{
100         "href":"https://{prefix}.api.checkout.com/accounts/entities/ent_5nzolfdtzu4h62ilkl5vqycu3q"
101      },
102      "schema":{
103         "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=requirements_due&schema_version=3.0&parent_entity_id=ent_rqj5j72ujsfuvlfbliczhvwqs4&entity_level=subentity"
104      }
105   }
106}

Information

Response examples