# Retrieve sub-entity details

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

## Retrieve sub-entity details in the Dashboard

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

1. Sign in to the [Dashboard](https://dashboard.checkout.com).
2. Go to _Sub-entities_.
3. Select the sub-entity to edit.
4. On the _Activity_ page, select _Manage account_.

The _Manage account_ page opens and displays all the details of the sub-entity.

---

## Retrieve sub-entity details using the API

To retrieve the details of a sub-entity, call the [Get entity details](https://api-reference.checkout.com/tag/Platforms/#operation/getEntityDetails) 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](https://www.checkout.com/docs/developer-resources/api/api-endpoints.md).

**Production**

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

**Sandbox**

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

### Response examples

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.

**Company - Lite**

```json
{
  "id": "ent_nofjig36ypra6236f4tfm5bvui",
  "reference": "CAKE12345",
  "status": "pending",
  "capabilities": {
    "payments": {
      "enabled": false
    },
    "payouts": {
      "enabled": false
    }
  },
  "profile": {
    "default_holding_currency": "GBP",
    "urls": ["https://www.thecakeshop.com"],
    "mccs": ["5814"]
  },
  "company": {
    "legal_name": "The Cake Shop Inc.",
    "trading_name": "The Cake Shop",
    "principal_address": {
      "address_line1": "654 Example St.",
      "city": "Edinburgh",
      "zip": "EH9 2XY",
      "country": "GB"
    },
    "representatives": []
  },
  "contact_details": {
    "phone": {
      "number": "7700900000"
    },
    "email_addresses": {
      "primary": "hello@thecakeshop.com"
    }
  },
  "instruments": [],
  "requirements_due": [],
  "_links": {
    "self": {
      "href": "https://{prefix}.api.checkout.com/accounts/entities/ent_nofjig36ypra6236f4tfm5bvui"
    }
  }
}
```

> **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.

**Sole trader - Lite**

```json
{
  "id": "ent_nofjig36ypra6236f4tfm5bvui",
  "reference": "DONUTS12345",
  "status": "active",
  "capabilities": {
    "payments": {
      "available": true,
      "enabled": true
    },
    "payouts": {
      "available": false,
      "enabled": false
    }
  },
  "profile": {
    "default_holding_currency": "GBP",
    "urls": ["https://www.alis-donuts.com"],
    "mccs": ["5814"]
  },
  "individual": {
    "first_name": "Ali",
    "last_name": "Farid",
    "trading_name": "Ali's Donuts",
    "legal_name": "Ali Farid",
    "national_tax_id": "1234567",
    "registered_address": {
      "address_line1": "123 High St.",
      "city": "London",
      "zip": "SW1A 1AA",
      "country": "GB"
    }
  },
  "contact_details": {
    "phone": {
      "number": "7700900000"
    },
    "email_addresses": {
      "primary": "ali.farid@example.com"
    }
  },
  "instruments": [],
  "requirements_due": [],
  "_links": {
    "self": {
      "href": "https://{prefix}.api.checkout.com/accounts/entities/ent_vv2jjkuf2gzj5tcw2x7ptua7zy"
    }
  }
}
```

> **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](https://dashboard.checkout.com/support/).

**Company - Full**

```json
{
  "id": "ent_nofjig36ypra6236f4tfm5bvui",
  "reference": "cakeshop678910",
  "status": "pending",
  "capabilities": {
    "payments": {
      "enabled": false
    },
    "payouts": {
      "enabled": false
    }
  },
  "profile": {
    "default_holding_currency": "GBP",
    "urls": ["https://www.thecakeshop.com"],
    "mccs": ["5814"]
  },
  "company": {
    "legal_name": "The Cake Shop Inc.",
    "trading_name": "The Cake Shop",
    "principal_address": {
      "address_line1": "90 Tottenham Court Road",
      "city": "London",
      "zip": "W1T4TJ",
      "country": "GB"
    },
    "representatives": []
  },
  "contact_details": {
    "phone": {
      "number": "111222333"
    },
    "email_addresses": {
      "primary": "hello@thecakeshop.com"
    }
  },
  "instruments": [],
  "requirements_due": [],
  "_links": {
    "self": {
      "href": "https://{prefix}.api.checkout.com/accounts/entities/ent_nofjig36ypra6236f4tfm5bvui"
    }
  }
}
```

> **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](https://dashboard.checkout.com/support/).

**Sole trader - Full**

```json
{
  "id": "ent_nofjig36ypra6236f4tfm5bvui",
  "reference": "danielsdonuts0123456",
  "status": "active",
  "capabilities": {
    "payments": {
      "available": true,
      "enabled": true
    },
    "payouts": {
      "available": true,
      "enabled": false
    }
  },
  "profile": {
    "default_holding_currency": "GBP",
    "urls": ["https://www.daniels-donuts.com"],
    "mccs": ["5814"]
  },
  "individual": {
    "first_name": "Daniel",
    "last_name": "Yubi",
    "trading_name": "Daniel's Donuts",
    "legal_name": "Daniel Yubi",
    "national_tax_id": "1234567",
    "registered_address": {
      "address_line1": "90 Tottenham Court Road",
      "city": "London",
      "zip": "W1T4TJ",
      "country": "GB"
    }
  },
  "contact_details": {
    "phone": {
      "number": "2345678910"
    },
    "email_addresses": {
      "primary": "hello@thecakeshop.com"
    }
  },
  "instruments": [],
  "requirements_due": [],
  "_links": {
    "self": {
      "href": "https://{prefix}.api.checkout.com/accounts/entities/ent_vv2jjkuf2gzj5tcw2x7ptua7zy"
    }
  }
}
```

> **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](https://dashboard.checkout.com/support/).

---