Get a sub-entity's business details

​

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
    Type: string
    required

    The sub-entity's ID.

Query Parameters
  • status
    Type: string enum

    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.

    values
    • active
    • pending
Responses
  • application/json
  • 401

    Unauthorized

  • 404

    Sub-entity not found, or the sub-entity has no business details

  • 422

    Invalid data sent

  • 429

    Too many requests

Request Example for get/accounts/entities/{id}/business-details
Shell Curl
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"
  ]
}

Business details retrieved successfully