> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.aurasos.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.aurasos.com/_mcp/server.

# Create a customer

POST https://staging-panic.aura.services/panic-api/v2/customers
Content-Type: application/json

Creates a customer profile for the authenticated customer source. Add a subscription separately unless your integration uses a combined onboarding flow.

Reference: https://docs.aurasos.com/api-reference/customers/create-customer

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Servers

- `https://staging-panic.aura.services` (Staging, default)
- `https://panic.aura.services` (Production)

## Request

### Body (application/json)

This endpoint expects a CustomerCreateRequest.

- `customer` (CustomerCreateRequestCustomer, required)
- `subscription` (CustomerCreateRequestSubscription, optional) — Optionally activate a subscription in the same call.

## Response

### 200

Successful.

- `message` (string, optional)
- `customer` (Customer, optional) — A customer profile. Read responses include the request profile fields plus the server-managed fields below.

## Errors

### 400 Bad Request Error

Bad request.

- `message` (string, optional)
- `errors` (ErrorResponseErrors, optional) — Error detail. May be a string, an array of strings, or an object (some routes return a serialized error object).

### 401 Unauthorized Error

Unauthorized.

- `message` (string, optional)
- `errors` (ErrorResponseErrors, optional) — Error detail. May be a string, an array of strings, or an object (some routes return a serialized error object).

## Types

### CustomerCreateRequestCustomer

- `name` (string, required)
- `surname` (string, required)
- `mobile` (string, required) — The customer's unique identifier.
- `email` (string, optional)
- `gender` (string, optional)
- `dateOfBirth` (datetime, optional)
- `businessName` (string, optional)
- `duressCode` (string, optional) — Safe word used to confirm a customer-initiated cancellation.
- `externalReferenceId` (string, optional) — Your own reference for the customer.
- `vehicleMake` (string, optional)
- `vehicleModel` (string, optional)
- `vehicleColour` (string, optional)
- `vehicleLicensePlate` (string, optional)
- `hasMedicalAid` (boolean, optional)
- `medicalConditions` (string, optional)
- `medications` (string, optional)
- `allergies` (string, optional)
- `medicalAidNumber` (string, optional)
- `medicalAidScheme` (string, optional)
- `nextOfKinName` (string, optional)
- `nextOfKinNumber` (string, optional)
- `bloodType` (string, optional)
- `familyDoctorPhoneNumber` (string, optional)
- `medicalOther` (string, optional)

### CustomerCreateRequestSubscription

Optionally activate a subscription in the same call.

- `subscriptionTypeId` (integer, optional)
- `validFrom` (datetime, optional)
- `validTo` (datetime, optional)
- `dependantCustomerIds` (list of integer, optional)

### Customer

A customer profile. Read responses include the request profile fields plus the server-managed fields below.

- `name` (string, optional)
- `surname` (string, optional)
- `mobile` (string, optional) — The customer's unique identifier.
- `email` (string, optional)
- `gender` (string, optional)
- `dateOfBirth` (datetime, optional)
- `businessName` (string, optional)
- `duressCode` (string, optional) — Safe word used to confirm a customer-initiated cancellation.
- `externalReferenceId` (string, optional) — Your own reference for the customer.
- `vehicleMake` (string, optional)
- `vehicleModel` (string, optional)
- `vehicleColour` (string, optional)
- `vehicleLicensePlate` (string, optional)
- `hasMedicalAid` (boolean, optional)
- `medicalConditions` (string, optional)
- `medications` (string, optional)
- `allergies` (string, optional)
- `medicalAidNumber` (string, optional)
- `medicalAidScheme` (string, optional)
- `nextOfKinName` (string, optional)
- `nextOfKinNumber` (string, optional)
- `bloodType` (string, optional)
- `familyDoctorPhoneNumber` (string, optional)
- `medicalOther` (string, optional)
- `id` (integer, optional)
- `customerSourceId` (integer, optional)
- `auth0UserId` (string, optional, nullable)
- `createdAt` (datetime, optional)
- `updatedAt` (datetime, optional)
- `imageId` (integer, optional, nullable)
- `customerTypeId` (integer, optional, nullable)
- `referredByCodeId` (integer, optional, nullable)
- `referredByCustomerId` (integer, optional, nullable)
- `stripeCustomerId` (string, optional, nullable)
- `medicalAidPlan` (string, optional, nullable)
- `hasVehicle` (boolean, optional, nullable)
- `referralCode` (string, optional, nullable) — Present on customer GET responses.
- `hasPanicked` (boolean, optional) — Present on customer GET responses.
- `subscriptions` (list of Subscription, optional) — Present when the customer was created with a subscription or when subscriptions are embedded.

### ErrorResponseErrors

Error detail. May be a string, an array of strings, or an object (some routes return a serialized error object).

- string
- list of string
- map from string to any

### Subscription

- `id` (integer, optional)
- `customerId` (integer, optional)
- `subscriptionTypeId` (integer, optional)
- `validFrom` (datetime, optional)
- `validTo` (datetime, optional)
- `CancelledDate` (datetime, optional, nullable) — Set when the subscription is cancelled. A subscription has no status field — it is active while within `validFrom`–`validTo` and not cancelled.
- `CancelledReason` (string, optional, nullable)
- `subscriptionToken` (string, optional, nullable)
- `dependantCustomerIds` (list of integer, optional)
- `membersFullName` (string, optional) — Present on customer subscription lookup responses.
- `relationship` (string, optional) — Present on customer subscription lookup responses; one of `MAIN` or `DEPENDANT`.
- `numberOfAddedDependents` (string, optional) — Present on customer subscription lookup responses.
- `subscriptionType` (SubscriptionType, optional)

### SubscriptionType

- `id` (integer, optional)
- `description` (string, optional)
- `value` (string, optional)
- `numberOfAllowedDependents` (SubscriptionTypeNumberOfAllowedDependents, optional, nullable)
- `recurringBilling` (boolean, optional)
- `period` (string, optional, nullable)
- `name` (string, optional, nullable)
- `createdAt` (datetime, optional)
- `updatedAt` (datetime, optional)

### SubscriptionTypeNumberOfAllowedDependents

- integer
- string

## Examples

### Minimal

**Request**

```json
{
  "customer": {
    "name": "Fogell",
    "surname": "McLovin",
    "mobile": "+27847493388"
  }
}
```

**Response**

```json
{
  "message": "string",
  "customer": {
    "name": "Fogell",
    "surname": "McLovin",
    "mobile": "+27847493388",
    "email": "string",
    "gender": "string",
    "dateOfBirth": "2024-01-15T09:30:00Z",
    "businessName": "string",
    "duressCode": "string",
    "externalReferenceId": "string",
    "vehicleMake": "string",
    "vehicleModel": "string",
    "vehicleColour": "string",
    "vehicleLicensePlate": "string",
    "hasMedicalAid": true,
    "medicalConditions": "string",
    "medications": "string",
    "allergies": "string",
    "medicalAidNumber": "string",
    "medicalAidScheme": "string",
    "nextOfKinName": "string",
    "nextOfKinNumber": "string",
    "bloodType": "string",
    "familyDoctorPhoneNumber": "string",
    "medicalOther": "string",
    "id": 12345,
    "customerSourceId": 12,
    "auth0UserId": "string",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "imageId": 1,
    "customerTypeId": 1,
    "referredByCodeId": 1,
    "referredByCustomerId": 1,
    "stripeCustomerId": "string",
    "medicalAidPlan": "string",
    "hasVehicle": true,
    "referralCode": "string",
    "hasPanicked": true,
    "subscriptions": [
      {
        "id": 12345,
        "customerId": 12345,
        "subscriptionTypeId": 4,
        "validFrom": "2024-01-15T09:30:00Z",
        "validTo": "2024-01-15T09:30:00Z",
        "CancelledDate": "2024-01-15T09:30:00Z",
        "CancelledReason": "string",
        "subscriptionToken": "string",
        "dependantCustomerIds": [
          1
        ],
        "membersFullName": "OpenAPI Sub",
        "relationship": "MAIN",
        "numberOfAddedDependents": "0",
        "subscriptionType": {
          "id": 2,
          "description": "API single subscription",
          "value": "API_SINGLE",
          "numberOfAllowedDependents": "4",
          "recurringBilling": false,
          "period": "string",
          "name": "string",
          "createdAt": "2024-01-15T09:30:00Z",
          "updatedAt": "2024-01-15T09:30:00Z"
        }
      }
    ]
  }
}
```

**SDK Code**

```python Minimal
import requests

url = "https://staging-panic.aura.services/panic-api/v2/customers"

payload = { "customer": {
        "name": "Fogell",
        "surname": "McLovin",
        "mobile": "+27847493388"
    } }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript Minimal
const url = 'https://staging-panic.aura.services/panic-api/v2/customers';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"customer":{"name":"Fogell","surname":"McLovin","mobile":"+27847493388"}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Minimal
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://staging-panic.aura.services/panic-api/v2/customers"

	payload := strings.NewReader("{\n  \"customer\": {\n    \"name\": \"Fogell\",\n    \"surname\": \"McLovin\",\n    \"mobile\": \"+27847493388\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Minimal
require 'uri'
require 'net/http'

url = URI("https://staging-panic.aura.services/panic-api/v2/customers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"customer\": {\n    \"name\": \"Fogell\",\n    \"surname\": \"McLovin\",\n    \"mobile\": \"+27847493388\"\n  }\n}"

response = http.request(request)
puts response.read_body
```

```java Minimal
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://staging-panic.aura.services/panic-api/v2/customers")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"customer\": {\n    \"name\": \"Fogell\",\n    \"surname\": \"McLovin\",\n    \"mobile\": \"+27847493388\"\n  }\n}")
  .asString();
```

```php Minimal
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://staging-panic.aura.services/panic-api/v2/customers', [
  'body' => '{
  "customer": {
    "name": "Fogell",
    "surname": "McLovin",
    "mobile": "+27847493388"
  }
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp Minimal
using RestSharp;

var client = new RestClient("https://staging-panic.aura.services/panic-api/v2/customers");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"customer\": {\n    \"name\": \"Fogell\",\n    \"surname\": \"McLovin\",\n    \"mobile\": \"+27847493388\"\n  }\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Minimal
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = ["customer": [
    "name": "Fogell",
    "surname": "McLovin",
    "mobile": "+27847493388"
  ]] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://staging-panic.aura.services/panic-api/v2/customers")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### With subscription

**Request**

```json
{
  "customer": {
    "name": "Fogell",
    "surname": "McLovin",
    "mobile": "+27847493388",
    "email": "customer@example.com"
  },
  "subscription": {
    "subscriptionTypeId": 4,
    "validFrom": "2026-06-08T15:33:38.000Z",
    "validTo": "2100-05-21T15:33:38.000Z"
  }
}
```

**Response**

```json
{
  "message": "string",
  "customer": {
    "name": "Fogell",
    "surname": "McLovin",
    "mobile": "+27847493388",
    "email": "string",
    "gender": "string",
    "dateOfBirth": "2024-01-15T09:30:00Z",
    "businessName": "string",
    "duressCode": "string",
    "externalReferenceId": "string",
    "vehicleMake": "string",
    "vehicleModel": "string",
    "vehicleColour": "string",
    "vehicleLicensePlate": "string",
    "hasMedicalAid": true,
    "medicalConditions": "string",
    "medications": "string",
    "allergies": "string",
    "medicalAidNumber": "string",
    "medicalAidScheme": "string",
    "nextOfKinName": "string",
    "nextOfKinNumber": "string",
    "bloodType": "string",
    "familyDoctorPhoneNumber": "string",
    "medicalOther": "string",
    "id": 12345,
    "customerSourceId": 12,
    "auth0UserId": "string",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "imageId": 1,
    "customerTypeId": 1,
    "referredByCodeId": 1,
    "referredByCustomerId": 1,
    "stripeCustomerId": "string",
    "medicalAidPlan": "string",
    "hasVehicle": true,
    "referralCode": "string",
    "hasPanicked": true,
    "subscriptions": [
      {
        "id": 12345,
        "customerId": 12345,
        "subscriptionTypeId": 4,
        "validFrom": "2024-01-15T09:30:00Z",
        "validTo": "2024-01-15T09:30:00Z",
        "CancelledDate": "2024-01-15T09:30:00Z",
        "CancelledReason": "string",
        "subscriptionToken": "string",
        "dependantCustomerIds": [
          1
        ],
        "membersFullName": "OpenAPI Sub",
        "relationship": "MAIN",
        "numberOfAddedDependents": "0",
        "subscriptionType": {
          "id": 2,
          "description": "API single subscription",
          "value": "API_SINGLE",
          "numberOfAllowedDependents": "4",
          "recurringBilling": false,
          "period": "string",
          "name": "string",
          "createdAt": "2024-01-15T09:30:00Z",
          "updatedAt": "2024-01-15T09:30:00Z"
        }
      }
    ]
  }
}
```

**SDK Code**

```python With subscription
import requests

url = "https://staging-panic.aura.services/panic-api/v2/customers"

payload = {
    "customer": {
        "name": "Fogell",
        "surname": "McLovin",
        "mobile": "+27847493388",
        "email": "customer@example.com"
    },
    "subscription": {
        "subscriptionTypeId": 4,
        "validFrom": "2026-06-08T15:33:38.000Z",
        "validTo": "2100-05-21T15:33:38.000Z"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript With subscription
const url = 'https://staging-panic.aura.services/panic-api/v2/customers';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"customer":{"name":"Fogell","surname":"McLovin","mobile":"+27847493388","email":"customer@example.com"},"subscription":{"subscriptionTypeId":4,"validFrom":"2026-06-08T15:33:38.000Z","validTo":"2100-05-21T15:33:38.000Z"}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go With subscription
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://staging-panic.aura.services/panic-api/v2/customers"

	payload := strings.NewReader("{\n  \"customer\": {\n    \"name\": \"Fogell\",\n    \"surname\": \"McLovin\",\n    \"mobile\": \"+27847493388\",\n    \"email\": \"customer@example.com\"\n  },\n  \"subscription\": {\n    \"subscriptionTypeId\": 4,\n    \"validFrom\": \"2026-06-08T15:33:38.000Z\",\n    \"validTo\": \"2100-05-21T15:33:38.000Z\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby With subscription
require 'uri'
require 'net/http'

url = URI("https://staging-panic.aura.services/panic-api/v2/customers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"customer\": {\n    \"name\": \"Fogell\",\n    \"surname\": \"McLovin\",\n    \"mobile\": \"+27847493388\",\n    \"email\": \"customer@example.com\"\n  },\n  \"subscription\": {\n    \"subscriptionTypeId\": 4,\n    \"validFrom\": \"2026-06-08T15:33:38.000Z\",\n    \"validTo\": \"2100-05-21T15:33:38.000Z\"\n  }\n}"

response = http.request(request)
puts response.read_body
```

```java With subscription
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://staging-panic.aura.services/panic-api/v2/customers")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"customer\": {\n    \"name\": \"Fogell\",\n    \"surname\": \"McLovin\",\n    \"mobile\": \"+27847493388\",\n    \"email\": \"customer@example.com\"\n  },\n  \"subscription\": {\n    \"subscriptionTypeId\": 4,\n    \"validFrom\": \"2026-06-08T15:33:38.000Z\",\n    \"validTo\": \"2100-05-21T15:33:38.000Z\"\n  }\n}")
  .asString();
```

```php With subscription
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://staging-panic.aura.services/panic-api/v2/customers', [
  'body' => '{
  "customer": {
    "name": "Fogell",
    "surname": "McLovin",
    "mobile": "+27847493388",
    "email": "customer@example.com"
  },
  "subscription": {
    "subscriptionTypeId": 4,
    "validFrom": "2026-06-08T15:33:38.000Z",
    "validTo": "2100-05-21T15:33:38.000Z"
  }
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp With subscription
using RestSharp;

var client = new RestClient("https://staging-panic.aura.services/panic-api/v2/customers");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"customer\": {\n    \"name\": \"Fogell\",\n    \"surname\": \"McLovin\",\n    \"mobile\": \"+27847493388\",\n    \"email\": \"customer@example.com\"\n  },\n  \"subscription\": {\n    \"subscriptionTypeId\": 4,\n    \"validFrom\": \"2026-06-08T15:33:38.000Z\",\n    \"validTo\": \"2100-05-21T15:33:38.000Z\"\n  }\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift With subscription
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "customer": [
    "name": "Fogell",
    "surname": "McLovin",
    "mobile": "+27847493388",
    "email": "customer@example.com"
  ],
  "subscription": [
    "subscriptionTypeId": 4,
    "validFrom": "2026-06-08T15:33:38.000Z",
    "validTo": "2100-05-21T15:33:38.000Z"
  ]
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://staging-panic.aura.services/panic-api/v2/customers")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```