getstarted.ae

Update intake

PATCHhttps://api.getstarted.ae/v1/incorporations/{incorporationId}/intake

Merges incorporation-level field values into the draft.

  • The merge is key by key. Keys you omit keep their stored value. Set a key to null to clear it.
  • Collections are replaced whole, not merged by index.
  • Only keys from blocks[].fields in the requirements schema are accepted. Data about people and companies goes through the Entities endpoints instead.
  • Intake is locked once the incorporation is submitted, except for fields named in an open issue.

Path parameters

  • incorporationIdstringrequired

    ID of the incorporation, e.g. inc_01J9ZK7C3VYB5N.

Body parameters

  • requirementsobjectrequired

    Field values keyed by the key of each field in the requirements schema.

Responses

  • 200OK. Returns the object shown in the example.
  • 400unknown_field A key under requirements is not a field in this incorporation's schema.
  • 404resource_not_found No incorporation with that ID exists in this environment.
  • 409incorporation_locked The incorporation has been submitted and the field is not part of an open issue.
  • 422invalid_value A value fails type or format validation.
  • Every endpoint can also return 401 for a missing or invalid key. See Errors.
curl -X PATCH "https://api.getstarted.ae/v1/incorporations/inc_01J9ZK7C3VYB5N/intake" \
  -H "Authorization: Bearer $GETSTARTED_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "requirements": {
    "companyNameOptions": [
      "Northwind Asia Pte. Ltd.",
      "Northwind Labs Asia Pte. Ltd.",
      "Northwind Pacific Pte. Ltd."
    ],
    "businessActivity": "62011",
    "financialYearEnd": "12-31",
    "registeredOfficeAddressSource": "getstartedService"
  }
}'
Response · 200
{
  "id": "inc_01J9ZK7C3VYB5N",
  "object": "incorporation",
  "customerId": "cus_01J9ZK4R7Q2M8X",
  "jurisdiction": "SG",
  "type": "PRIVATE_LIMITED_COMPANY",
  "status": "DRAFT",
  "stage": "draft",
  "requirementsVersion": "2026-09-01",
  "requirements": {
    "companyNameOptions": [
      "Northwind Asia Pte. Ltd.",
      "Northwind Labs Asia Pte. Ltd.",
      "Northwind Pacific Pte. Ltd."
    ],
    "businessActivity": "62011",
    "financialYearEnd": "12-31",
    "registeredOfficeAddressSource": "getstartedService"
  },
  "businessEntityId": null,
  "submittedAt": null,
  "completedAt": null,
  "metadata": {
    "internalRef": "NW-SG-01"
  },
  "livemode": false,
  "createdAt": "2026-09-20T08:31:57Z",
  "updatedAt": "2026-09-20T08:40:12Z"
}