Retrieve sub-entity details
Beta

Last updated: March 25, 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      "legal_name":"The Online Retailer",
25      "trading_name":"The Online Retailer",
26      "principal_address":{
27         "address_line1":"123 Anywhere St.",
28         "city":"Anytown",
29         "state":"AL",
30         "zip":"123456",
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                  "zip":"123456",
45                  "country":"AL"
46               },
47               "first_name":"Hannah",
48               "last_name":"Bret",
49               "date_of_birth":{
50                  "day":23,
51                  "month":1,
52                  "year":1990
53               },
54               "place_of_birth":{
55                  "country":"AL"
56               }
57            }
58         }
59      ],
60      "business_type":"private_corporation",
61      "date_of_incorporation":{
62         "day":22,
63         "month":2,
64         "year":1990
65      }
66   },
67   "processing_details":{
68      "annual_processing_volume":125000,
69      "average_transaction_value":5000,
70      "highest_transaction_value":10000,
71      "currency":"USD",
72      "settlement_country":"US",
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}


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      "legal_name":"The Online Retailer",
25      "trading_name":"The Online Retailer",
26      "principal_address":{
27         "address_line1":"123 Anywhere St.",
28         "city":"Anytown",
29         "state":"AL",
30         "zip":"123456",
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                  "zip":"123456",
45                  "country":"US"
46               },
47               "first_name":"Hannah",
48               "last_name":"Bret",
49               "date_of_birth":{
50                  "day":23,
51                  "month":1,
52                  "year":1990
53               },
54               "place_of_birth":{
55                  "country":"US"
56               }
57            }
58         }
59      ],
60      "business_type":"individual_or_sole_proprietorship",
61      "date_of_incorporation":{
62         "day":22,
63         "month":2,
64         "year":1990
65      }
66   },
67   "processing_details":{
68      "annual_processing_volume":125000,
69      "average_transaction_value":5000,
70      "highest_transaction_value":10000,
71      "currency":"USD",
72      "settlement_country":"US",
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