--- title: "Get a sub-entity's business details" method: GET path: "/accounts/entities/{id}/business-details" tags: ["Business details"] --- # Get a sub-entity's business details `GET /accounts/entities/{id}/business-details` ## Request - Base URL: `https://{prefix}.api.sandbox.checkout.com` - URL: `https://{prefix}.api.sandbox.checkout.com/accounts/entities/{id}/business-details` - Auth: one of: - OAuth 2 - Client credentials - Token URL: `string` scopes: `accounts` - API key in header `Authorization` - TypeScript: (a function with typed inputs; its response is checked against the schema) Retrieve the business details of one of your sub-entities, onboarded through our Platforms solution. Business details are the parts of a sub-entity's company information that can change after onboarding. If a change to them is under review, this endpoint returns the submitted values with a `pending` status by default, so you can retrieve a change you've already submitted. To retrieve the values currently in effect while a change is under review, send `GET /accounts/entities/{id}/business-details?status=active`. To retrieve only a change under review, send `GET /accounts/entities/{id}/business-details?status=pending`. The `pending` values include the documents submitted with the change. ## Path parameters - `id` string, required ## Query parameters - `status` 'active' | 'pending' ## Response `200` Business details retrieved successfully - union - object: The mutable business details of a SaaS seller sub-entity that is a registered company. You can only change the fields below through this endpoint. `business_type`, `business_registration_number`, `date_of_incorporation`, `is_registered_company`, and `regulatory_license_expiration` cannot be changed after onboarding, so they are not part of this resource. If you send them, the request fails. - `status` 'active' | 'pending': The status of the business details. This describes the data in this response, not the sub-entity's own status. A suspended sub-entity can still have `active` business details. `active` means the values are live. `pending` means a change has been submitted and is still under review, so the values shown are the ones you submitted, not the ones currently in effect. Read-only on input. You can send a response body back unchanged in a `PUT` request, and this field is ignored. - `legal_name` string, required: The legal name of the sub-entity. - `trading_name` string, required: The trading name of the sub-entity, also known as the 'Doing Business As' name. - `additional_trading_names` string[]: The collection of additional trading names for the sub-entity. - `registered_address` object, required: The registered address of the company. - `address_line1` string, required: The first line of the address. - `address_line2` string, nullable: The second line of the address. - `city` string, required: The address city. - `state` string: The address state. Required for addresses in the US and France, and optional elsewhere. For US addresses, provide the two-letter ISO 3166-2 code. For French addresses, provide the department the address is in. - `zip` string, nullable, required: The address ZIP code or postal code. Required, but can be `null` for countries that do not use postal codes. - `country` string, iso-3166-1-alpha-2, required: The two-letter ISO 3166-1 alpha-2 country code. Returned by the `GET` request, and required when you submit an address, but you cannot change the sub-entity's country. For more information, see Country codes. - `principal_address` object, required: The primary location of the company where business is performed. - `address_line1` string, required: The first line of the address. - `address_line2` string, nullable: The second line of the address. - `city` string, required: The address city. - `state` string: The address state. Required for addresses in the US and France, and optional elsewhere. For US addresses, provide the two-letter ISO 3166-2 code. For French addresses, provide the department the address is in. - `zip` string, nullable, required: The address ZIP code or postal code. Required, but can be `null` for countries that do not use postal codes. - `country` string, iso-3166-1-alpha-2, required: The two-letter ISO 3166-1 alpha-2 country code. Returned by the `GET` request, and required when you submit an address, but you cannot change the sub-entity's country. For more information, see Country codes. - `documents` object: Supporting documents for the change you submit. Each document is required only when you change the fields it supports, and is not requested otherwise. A document already on file satisfies the requirement, so you do not need to upload a new one. Documents are not returned for `active` business details. For `pending` business details, the documents submitted with the change are returned. - `company_verification` object: A document certified by a power of attorney within the last three months. Required when you change `legal_name`, `trading_name`, or `additional_trading_names`. If you change any of those fields without providing this document, the request fails with a `422` error that names the missing document. - `type` 'incorporation_document', required: The type of document used for company verification. - `front` string, required: The ID of the front side of the document. - `proof_of_principal_address` object: Proof of the principal place of business. Required when you change `principal_address`. The registered office and the principal place of business are different, so this document does not cover a change to `registered_address`. - `type` 'proof_of_address', required: The type of document used for principal address verification. - `front` string, required: The ID of the front side of the document. - `proof_of_registered_address` object: Proof of the registered address of the company. Required when you change `registered_address`. If you change both addresses, provide this document and `proof_of_principal_address`. - `type` 'proof_of_address', required: The type of document used for registered address verification. - `front` string, required: The ID of the front side of the document. - object: The mutable business details of a SaaS seller sub-entity that is a sole trader. You can only change the fields below through this endpoint. A sole trader has no legal name and no registered address, so `legal_name` and `registered_address` are not part of this resource. `business_type`, `business_registration_number`, `date_of_incorporation`, `is_registered_company`, and `regulatory_license_expiration` cannot be changed after onboarding, so they are not part of this resource either. If you send any of these fields, the request fails. - `status` 'active' | 'pending': The status of the business details. This describes the data in this response, not the sub-entity's own status. A suspended sub-entity can still have `active` business details. `active` means the values are live. `pending` means a change has been submitted and is still under review, so the values shown are the ones you submitted, not the ones currently in effect. Read-only on input. You can send a response body back unchanged in a `PUT` request, and this field is ignored. - `trading_name` string, required: The trading name of the sub-entity, also known as the 'Doing Business As' name. - `additional_trading_names` string[]: The collection of additional trading names for the sub-entity. - `principal_address` object, required: The primary location where the sole trader performs business. - `address_line1` string, required: The first line of the address. - `address_line2` string, nullable: The second line of the address. - `city` string, required: The address city. - `state` string: The address state. Required for addresses in the US and France, and optional elsewhere. For US addresses, provide the two-letter ISO 3166-2 code. For French addresses, provide the department the address is in. - `zip` string, nullable, required: The address ZIP code or postal code. Required, but can be `null` for countries that do not use postal codes. - `country` string, iso-3166-1-alpha-2, required: The two-letter ISO 3166-1 alpha-2 country code. Returned by the `GET` request, and required when you submit an address, but you cannot change the sub-entity's country. For more information, see Country codes. - `documents` object: Supporting documents for the change you submit. Each document is required only when you change the fields it supports, and is not requested otherwise. A document already on file satisfies the requirement, so you do not need to upload a new one. Documents are not returned for `active` business details. For `pending` business details, the documents submitted with the change are returned. - `company_verification` object: A document certified by a power of attorney within the last three months. Required when you change `trading_name` or `additional_trading_names`. If you change either of those fields without providing this document, the request fails with a `422` error that names the missing document. - `type` 'incorporation_document', required: The type of document used for company verification. - `front` string, required: The ID of the front side of the document. - `proof_of_principal_address` object: Proof of the principal place of business. Required when you change `principal_address`. If you change this field without providing this document, the request fails with a `422` error that names the missing document. - `type` 'proof_of_address', required: The type of document used for principal address verification. - `front` string, required: The ID of the front side of the document. ## Other responses - `401`: Unauthorized - `404`: Sub-entity not found, or the sub-entity has no business details - `422`: Invalid data sent - `429`: Too many requests --- [API](https://skmtc.dev/checkout/apis/checkout-com-api-reference.md) - [All operations](https://skmtc.dev/checkout/apis/checkout-com-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/checkout/apis/checkout-com-api-reference/revisions/0f1abdb1c3e9?raw)