> 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 customer signup session

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

Creates an Aura-hosted signup session for a customer onboarding flow. Use this when Aura should host part of the registration experience.

Reference: https://docs.aurasos.com/api-reference/customer-sessions/create-customer-signup-session

## 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 CustomerSignupSessionRequest.

- `returnUrl` (string, required) — Your URL that AURA redirects the customer back to once signup completes.
- `email` (string, optional)
- `customerReferenceId` (string, optional) — Your own reference for the customer.
- `siteDetails` (CustomerSignupSessionRequestSiteDetails, optional) — Optional site details to pre-fill during signup.

## Response

### 200

Successful.

- `sessionId` (string, optional)
- `customerId` (integer, optional, nullable)
- `returnUrl` (string, optional) — The AURA-hosted onboarding URL to redirect the customer to.

## 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

### CustomerSignupSessionRequestSiteDetails

Optional site details to pre-fill during signup.

- `siteName` (string, optional)
- `siteReferenceId` (string, optional)

### 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

## Examples

**Request**

```json
{
  "returnUrl": "https://partner.example/signup/complete",
  "email": "customer@example.com",
  "customerReferenceId": "12345"
}
```

**Response**

```json
{
  "sessionId": "12345",
  "customerId": 12345,
  "returnUrl": "string"
}
```

**SDK Code**

```python Success
import requests

url = "https://staging-panic.aura.services/panic-api/v2/customer-signup/sessions"

payload = {
    "returnUrl": "https://partner.example/signup/complete",
    "email": "customer@example.com",
    "customerReferenceId": "12345"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.json())
```

```javascript Success
const url = 'https://staging-panic.aura.services/panic-api/v2/customer-signup/sessions';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"returnUrl":"https://partner.example/signup/complete","email":"customer@example.com","customerReferenceId":"12345"}'
};

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

```go Success
package main

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

func main() {

	url := "https://staging-panic.aura.services/panic-api/v2/customer-signup/sessions"

	payload := strings.NewReader("{\n  \"returnUrl\": \"https://partner.example/signup/complete\",\n  \"email\": \"customer@example.com\",\n  \"customerReferenceId\": \"12345\"\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 Success
require 'uri'
require 'net/http'

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

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  \"returnUrl\": \"https://partner.example/signup/complete\",\n  \"email\": \"customer@example.com\",\n  \"customerReferenceId\": \"12345\"\n}"

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

```java Success
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/customer-signup/sessions")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"returnUrl\": \"https://partner.example/signup/complete\",\n  \"email\": \"customer@example.com\",\n  \"customerReferenceId\": \"12345\"\n}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://staging-panic.aura.services/panic-api/v2/customer-signup/sessions', [
  'body' => '{
  "returnUrl": "https://partner.example/signup/complete",
  "email": "customer@example.com",
  "customerReferenceId": "12345"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp Success
using RestSharp;

var client = new RestClient("https://staging-panic.aura.services/panic-api/v2/customer-signup/sessions");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"returnUrl\": \"https://partner.example/signup/complete\",\n  \"email\": \"customer@example.com\",\n  \"customerReferenceId\": \"12345\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Success
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "returnUrl": "https://partner.example/signup/complete",
  "email": "customer@example.com",
  "customerReferenceId": "12345"
] as [String : Any]

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

let request = NSMutableURLRequest(url: NSURL(string: "https://staging-panic.aura.services/panic-api/v2/customer-signup/sessions")! 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()
```