CHcheckout
Business details

Update a sub-entity's business details

Submit a change to the business details of one of your sub-entities, onboarded through our <a href="https://www.checkout.com/docs/platforms" target="_blank">Platforms solution</a>.

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.

put/accounts/entities/{id}/business-details

Request

Path parameters

idstring required

The sub-entity's ID.

Request body

OR

Example request

{
  "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"
  ]
}

Response

Change submitted successfully and is now under review

OR

Example response

{
  "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"
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.