CHcheckout
Onboarding
Platforms

Update entity details

Update an entity.

Note: when you update a entity we may conduct further due diligence checks when necessary. During these checks, your payment capabilities will remain the same.

put/accounts/entities/{id}

Request

Request body

OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR

Example request

{
  "reference": "isv-seller-example001",
  "agreed_terms": {
    "date": "2026-07-02T10:30:00.0000000+00:00",
    "ip_address": "8.8.8.8",
    "name": "Toby Arden",
    "email": "toby.arden@example.com",
    "version": "cko-platform-terms-1.0.0"
  },
  "seller_category": "cat_retail_001",
  "processing_details": {
    "annual_processing_volume": 1000,
    "average_transaction_value": 2000,
    "average_order_fulfillment_time": 3,
    "target_countries": [
      "US"
    ],
    "currency": "USD",
    "payments": {
      "ach": {
        "annual_ach_volume": 100000,
        "average_ach_transaction_size": 5000,
        "estimated_monthly_credit_volume": 50000,
        "average_credit_amount": 2500
      }
    }
  },
  "contact_details": {
    "phone": {
      "number": "4155678900",
      "country_code": "US"
    },
    "email_addresses": {
      "primary": "toby.arden@example.com",
      "pci_compliance_contact": "pci.contact@example.com"
    }
  },
  "profile": {
    "urls": [
      "https://www.isv-seller-example.com"
    ],
    "mccs": [
      "5551"
    ],
    "holding_currencies": [
      "USD"
    ],
    "default_holding_currency": "USD"
  },
  "company": {
    "business_registration_number": "12-3456789",
    "business_type": "private_corporation",
    "legal_name": "ISV Seller Example Inc",
    "trading_name": "ISV Seller Example",
    "registered_address": {
      "address_line1": "123 Main Street",
      "city": "San Francisco",
      "state": "CA",
      "zip": "94105",
      "country": "US"
    },
    "principal_address": {
      "address_line1": "123 Main Street",
      "city": "San Francisco",
      "state": "CA",
      "zip": "94105",
      "country": "US"
    },
    "date_of_incorporation": {
      "year": 2025,
      "month": 10,
      "day": 1
    },
    "tax_details": {
      "tax_classification": "c_corporation"
    },
    "representatives": [
      {
        "roles": [
          "ubo",
          "control_person"
        ],
        "ownership_percentage": 25,
        "company_position": "ceo",
        "individual": {
          "first_name": "Toby",
          "last_name": "Arden",
          "email_address": "toby.arden@example.com",
          "national_id_type": "ssn",
          "national_id_number": "123456789",
          "date_of_birth": {
            "day": 15,
            "month": 1,
            "year": 1990
          },
          "place_of_birth": {
            "country": "US"
          },
          "citizenships": [
            {
              "country": "US"
            }
          ],
          "phone": {
            "country_code": "US",
            "number": "4155678901"
          },
          "address": {
            "address_line1": "123 Main Street",
            "city": "San Francisco",
            "state": "CA",
            "zip": "94105",
            "country": "US"
          }
        }
      },
      {
        "roles": [
          "authorised_signatory"
        ],
        "individual": {
          "first_name": "Alex",
          "last_name": "Morgan",
          "email_address": "alex.morgan@example.com",
          "national_id_type": "ssn",
          "national_id_number": "987654321",
          "date_of_birth": {
            "day": 22,
            "month": 6,
            "year": 1985
          },
          "place_of_birth": {
            "country": "US"
          },
          "citizenships": [
            {
              "country": "US"
            }
          ],
          "phone": {
            "country_code": "US",
            "number": "4155678902"
          },
          "address": {
            "address_line1": "123 Main Street",
            "city": "San Francisco",
            "state": "CA",
            "zip": "94105",
            "country": "US"
          }
        }
      }
    ]
  }
}

Response

Entity updated successfully

OR

Example response

{
  "id": "ent_wxglze3wwywujg4nna5fb7ldli",
  "reference": "superhero1234",
  "requirements_due": [
    {
      "field": "individual.identification.document",
      "reason": "required",
      "message": "required"
    }
  ],
  "_links": {
    "self": {
      "href": "https://{prefix}.api.checkout.com/accounts/entities/ent_wxglze3wwywujg4nna5fb7ldli"
    }
  }
}

Changes

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