getstarted.ae

Update a business entity

PATCHhttps://api.getstarted.ae/v1/customers/{customerId}/business-entities/{id}

Updates the fields you send. Omitted fields are unchanged.

  • Entities formed through GetStarted have registry-issued fields (legalName, registrationNumber, dateOfIncorporation) that cannot be changed here.

Path parameters

  • customerIdstringrequired

    ID of the customer, e.g. cus_01J9ZK4R7Q2M8X.

  • idstringrequired

    ID of the business entity, e.g. ent_01J9ZKC5TR8F4K.

Body parameters

  • legalNamestring

    Registered legal name.

  • entityTypestring

    e.g. PRIVATE_LIMITED_COMPANY, LLC, C_CORPORATION.

  • countryOfIncorporationstring

    ISO 3166-1 alpha-2 country code.

  • registrationNumberstring

    Number issued by the registry the entity is incorporated in.

  • dateOfIncorporationstring (date)

    YYYY-MM-DD.

  • emailstring

    Contact email for the entity.

  • metadataobject

    Up to 20 string key-value pairs for your own use.

Responses

  • 200OK. Returns the object shown in the example.
  • 400unknown_field The body contains a key the endpoint does not accept.
  • 404resource_not_found No business entity with that ID exists in this environment.
  • 409registry_field_locked The field was issued by a registry and is read-only.
  • Every endpoint can also return 401 for a missing or invalid key. See Errors.
curl -X PATCH "https://api.getstarted.ae/v1/customers/cus_01J9ZK4R7Q2M8X/business-entities/ent_01J9ZKC5TR8F4K" \
  -H "Authorization: Bearer $GETSTARTED_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "email": "company-secretary@northwindlabs.com"
}'
Response · 200
{
  "id": "ent_01J9ZKC5TR8F4K",
  "object": "business_entity",
  "customerId": "cus_01J9ZK4R7Q2M8X",
  "legalName": "Northwind Holdings Ltd",
  "entityType": "PRIVATE_LIMITED_COMPANY",
  "countryOfIncorporation": "GB",
  "registrationNumber": "14820391",
  "dateOfIncorporation": "2023-02-09",
  "email": "company-secretary@northwindlabs.com",
  "createdAt": "2026-09-20T08:22:40Z",
  "updatedAt": "2026-09-21T10:05:00Z"
}