> ## Documentation Index
> Fetch the complete documentation index at: https://rideshare.docs.sumit-dhondikar.in/llms.txt
> Use this file to discover all available pages before exploring further.

# Quick start

> Sign up, log in, and make your first authenticated request to the RideShare API.

<Note>
  All examples in this guide use the development base URL `http://localhost:8080`. Replace this with your production base URL when you deploy.
</Note>

<Steps>
  <Step title="Request an OTP">
    Before creating an account, verify your email address by requesting a one-time passcode.

    ```bash theme={null}
    curl -X POST http://localhost:8080/auth/signup/request-otp \
      -H "Content-Type: application/json" \
      -d '{"email": "you@example.com", "name": "Your Name"}'
    ```

    A successful response confirms that the OTP was generated and sent to your email:

    ```json theme={null}
    {
      "message": "OTP sent successfully.",
      "emailSent": true,
      "expiresAt": "2026-04-02T10:15:00Z"
    }
    ```
  </Step>

  <Step title="Create your account">
    Submit your name, email, password, and the OTP you received to create an account.

    ```bash theme={null}
    curl -X POST http://localhost:8080/auth/signup \
      -H "Content-Type: application/json" \
      -d '{
        "name": "Your Name",
        "email": "you@example.com",
        "password": "your-password",
        "otp": "123456"
      }'
    ```

    A successful response confirms account creation:

    ```json theme={null}
    {
      "message": "Account created/updated successfully."
    }
    ```
  </Step>

  <Step title="Log in and get your tokens">
    Log in with your email and password. The response includes a JWT access token and a refresh token.

    ```bash theme={null}
    curl -X POST http://localhost:8080/auth/login \
      -H "Content-Type: application/json" \
      -d '{
        "email": "you@example.com",
        "password": "your-password"
      }'
    ```

    Save the `accessToken` and `refreshToken` from the response:

    ```json theme={null}
    {
      "token": "eyJhbGciOiJIUzI1NiJ9...",
      "accessToken": "eyJhbGciOiJIUzI1NiJ9...",
      "refreshToken": "eyJhbGciOiJIUzI1NiJ9...",
      "tokenType": "Bearer",
      "expiresIn": 3600,
      "id": 42,
      "name": "Your Name",
      "role": "USER"
    }
    ```

    Use the `accessToken` to authorize subsequent requests. When it expires, use the `refreshToken` to get a new one — see [Authentication](/authentication) for details.
  </Step>

  <Step title="Make an authenticated request">
    Pass the access token in the `Authorization` header on every authenticated request. This example fetches a fare estimate for a 5 km trip.

    ```bash theme={null}
    curl -X GET "http://localhost:8080/rides/estimate?distanceKm=5" \
      -H "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9..."
    ```
  </Step>
</Steps>