View and manage the business details of your SaaS seller sub-entities.
Business details Operations
View and manage the business details of your SaaS seller sub-entities.
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.
The sub-entity's ID.
The version of the sub-entity's business details to return. status selects which values are returned, but does not filter them.
Use active to retrieve the values currently in effect. This shows you the values a pending change would replace once approved.
Use pending to retrieve the values submitted in a change that is still under review. The request returns 404 if no change is under review.
If you omit this parameter and a change is under review, the endpoint returns the pending values. Otherwise, it returns the active values.
Unauthorized
Sub-entity not found, or the sub-entity has no business details
Invalid data sent
Too many requests
curl 'https://{prefix}.api.sandbox.checkout.com/accounts/entities/ent_w4jelhppmfiufdnatam37wrfc4/business-details' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
"legal_name": "The Online Retailer",
"trading_name": "Online Retail Co",
"registered_address": {
"address_line1": "444 Test Avenue",
"city": "Anytown",
"zip": "67890-1234",
"country": "US",
"state": "FL"
},
"principal_address": {
"address_line1": "123 Anywhere St.",
"city": "Anytown",
"zip": "12345-6789",
"country": "US",
"address_line2": "Apt. 456",
"state": "AL"
},
"status": "active",
"additional_trading_names": [
"Online Retail"
]
}Submit a change to the business details of one of your sub-entities, onboarded through our Platforms solution.
This endpoint opens a change request for review. The sub-entity keeps its current business details until the review completes, and the response returns the values you submitted with a pending status.
You can have only one change under review at a time. Provide the complete set of business details, not only the fields you want to change. You cannot change the sub-entity's country.
You cannot currently amend a change after you submit it. Until the change has been assessed, a further PUT request returns 409. To retrieve the change in progress, send a GET request with status=pending. If you submitted incorrect values, wait for the assessment outcome and submit the corrected values as a new change, or resolve any requirements the assessment raises, which you can retrieve from GET /accounts/entities/{id}/requirements. Support for amending a change that is under review is planned.
Some changes must include a supporting document. Changing legal_name, trading_name, or additional_trading_names requires documents.company_verification. Changing principal_address requires documents.proof_of_principal_address. Changing registered_address requires documents.proof_of_registered_address. The registered address and principal address require separate documents.
You do not need to provide a document if you have not changed the fields it supports, or if a valid document is already on file.
The sub-entity's ID.
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.
The legal name of the sub-entity.
The trading name of the sub-entity, also known as the 'Doing Business As' name.
The registered address of the company.
The primary location of the company where business is performed.
The collection of additional trading names for the sub-entity.
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.
Unauthorized
Sub-entity not found, or the sub-entity has no business details
Too many requests
We could not validate the change because an upstream service was unavailable. No change was created, so you can retry the request
curl 'https://{prefix}.api.sandbox.checkout.com/accounts/entities/ent_w4jelhppmfiufdnatam37wrfc4/business-details' \
--request PUT \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--data '{
"legal_name": "The Online Retailer",
"trading_name": "Online Retail Co",
"registered_address": {
"address_line1": "444 Test Avenue",
"city": "Anytown",
"zip": "67890-1234",
"country": "US",
"state": "FL"
},
"principal_address": {
"address_line1": "123 Anywhere St.",
"city": "Anytown",
"zip": "12345-6789",
"country": "US",
"address_line2": "Apt. 456",
"state": "AL"
},
"additional_trading_names": [
"Online Retail"
],
"documents": {
"company_verification": {
"type": "incorporation_document",
"front": "file_wxglze3wwywujg4nna5fb7ldli"
},
"proof_of_principal_address": {
"type": "proof_of_address",
"front": "file_6lbss42ezvoufcb2beo76rvwly"
},
"proof_of_registered_address": {
"type": "proof_of_address",
"front": "file_ovcw6dxu2rjecmb4nqzk3wtgli"
}
}
}'
{
"legal_name": "The Online Retailer",
"trading_name": "Online Retail Co",
"registered_address": {
"address_line1": "444 Test Avenue",
"city": "Anytown",
"zip": "67890-1234",
"country": "US",
"state": "FL"
},
"principal_address": {
"address_line1": "123 Anywhere St.",
"city": "Anytown",
"zip": "12345-6789",
"country": "US",
"address_line2": "Apt. 456",
"state": "AL"
},
"status": "pending",
"additional_trading_names": [
"Online Retail"
],
"documents": {
"company_verification": {
"type": "incorporation_document",
"front": "file_wxglze3wwywujg4nna5fb7ldli"
},
"proof_of_principal_address": {
"type": "proof_of_address",
"front": "file_6lbss42ezvoufcb2beo76rvwly"
},
"proof_of_registered_address": {
"type": "proof_of_address",
"front": "file_ovcw6dxu2rjecmb4nqzk3wtgli"
}
}
}