getstarted.ae

Get the status workflow

GEThttps://api.getstarted.ae/v1/incorporations/status-workflow

Returns the ordered public stages an incorporation of this jurisdiction and type moves through.

  • Use it to draw a progress tracker. Every stage value you receive on an incorporation or in a webhook is one of these keys.

Query parameters

  • jurisdictionstringrequired

    Jurisdiction code from the catalog, e.g. SG, AE, US-DE.

  • typestringrequired

    Incorporation type from the catalog, e.g. PRIVATE_LIMITED_COMPANY.

Responses

  • 200OK. Returns the object shown in the example.
  • 404unsupported_jurisdiction The jurisdiction and type pair is not in the catalog.
  • Every endpoint can also return 401 for a missing or invalid key. See Errors.
curl -X GET "https://api.getstarted.ae/v1/incorporations/status-workflow?jurisdiction=SG&type=PRIVATE_LIMITED_COMPANY" \
  -H "Authorization: Bearer $GETSTARTED_API_KEY"
Response · 200
{
  "object": "status_workflow",
  "jurisdiction": "SG",
  "type": "PRIVATE_LIMITED_COMPANY",
  "stages": [
    {
      "key": "draft",
      "status": "DRAFT",
      "title": "Draft",
      "description": "You are collecting requirements. Nothing has been filed."
    },
    {
      "key": "submitted",
      "status": "SUBMITTED",
      "title": "Submitted",
      "description": "The application is locked and queued for review."
    },
    {
      "key": "compliance_review",
      "status": "IN_PROGRESS",
      "title": "Compliance review",
      "description": "People, documents and ownership are being checked."
    },
    {
      "key": "name_reservation",
      "status": "IN_PROGRESS",
      "title": "Name reservation",
      "description": "The first available company name option is being reserved."
    },
    {
      "key": "registry_filing",
      "status": "IN_PROGRESS",
      "title": "Registry filing",
      "description": "The incorporation has been filed with the registry."
    },
    {
      "key": "incorporated",
      "status": "COMPLETED",
      "title": "Incorporated",
      "description": "The company exists. Registration details and documents are attached to the business entity."
    }
  ],
  "sideStatuses": [
    {
      "status": "ACTION_REQUIRED",
      "description": "An open issue needs your input. The stage is paused until it is resolved."
    },
    {
      "status": "CANCELLED",
      "description": "The incorporation was cancelled and will not proceed."
    }
  ]
}