getstarted.ae

Create a customer

POSThttps://api.getstarted.ae/v1/customers

Creates a customer: the account on your platform that incorporations, people and entities belong to.

  • Use externalReference to store your own account ID. It is returned on every read and is unique per environment.

Body parameters

  • namestringrequired

    Display name for the customer.

  • emailstringrequired

    Primary contact email.

  • externalReferencestring

    Your ID for this customer. Must be unique.

  • metadataobject

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

Responses

  • 201Created. Returns the object shown in the example.
  • 400unknown_field The body contains a key the endpoint does not accept.
  • 409duplicate_external_reference Another customer already uses this externalReference.
  • 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 POST "https://api.getstarted.ae/v1/customers" \
  -H "Authorization: Bearer $GETSTARTED_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Northwind Labs",
  "email": "ops@northwindlabs.com",
  "externalReference": "acct_48213",
  "metadata": {
    "plan": "growth"
  }
}'
Response · 201
{
  "id": "cus_01J9ZK4R7Q2M8X",
  "object": "customer",
  "name": "Northwind Labs",
  "email": "ops@northwindlabs.com",
  "externalReference": "acct_48213",
  "metadata": {
    "plan": "growth"
  },
  "livemode": false,
  "createdAt": "2026-09-20T08:14:22Z"
}