> ## Documentation Index
> Fetch the complete documentation index at: https://readme.amana-dev.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Sign-up step 1: email

> Start sign-up with the user's email address. Returns a session ID for the following steps.

## Body

Content type: `application/json`

<ParamField body="email" type="string" required>
  User's email address.
</ParamField>

<ParamField body="hint" type="string" required />

<ParamField body="params" type="object" />

## Response

`200` Success.

<ResponseField name="sid" type="string" />

<ResponseField name="nextStep" type="enum<string>">
  Available options: `name`
</ResponseField>

## Possible Errors

| Error | Possible cause | What to do |
| - | - | - |
| 400 | Invalid or missing field | Check the request against the schema. |
| 403 | IP not whitelisted, or account restricted | Confirm your IP is whitelisted; otherwise contact Amana. |
| 429 / 5xx | Rate limit, or temporary issue on our side | Retry with backoff; contact support if it persists. |

<RequestExample>
  ```bash cURL theme={null}
  curl --request POST \
    --url 'https://gateway.amana.io/onboarding/step/email' \
    --header 'Content-Type: application/json' \
    --data '{
    "email": "<string>",
    "hint": "<string>",
    "params": {}
  }'
  ```

  ```python Python theme={null}
  import requests

  url = "https://gateway.amana.io/onboarding/step/email"
  headers = {"Content-Type": "application/json"}
  payload = {
      "email": "<string>",
      "hint": "<string>",
      "params": {}
  }

  response = requests.request("POST", url, json=payload, headers=headers)
  print(response.json())
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch('https://gateway.amana.io/onboarding/step/email', {
    method: 'POST',
    headers: {"Content-Type": "application/json"},
    body: JSON.stringify({"email": "<string>", "hint": "<string>", "params": {}}),
  });
  console.log(await response.json());
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "sid": "<string>",
    "nextStep": "name"
  }
  ```

  ```json 400 theme={null}
  {
    "error": "INVALID_REQUEST",
    "message": "<string>"
  }
  ```

  ```json 403 theme={null}
  {
    "error": "<string>",
    "message": "<string>"
  }
  ```

  ```json 429 theme={null}
  {
    "error": "<string>",
    "message": "<string>"
  }
  ```

  ```json 500 theme={null}
  {
    "error": "<string>",
    "message": "<string>"
  }
  ```
</ResponseExample>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.