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

# Login or Register Customer

> Initiates the OTP login or registration flow using an email address or phone number.



## OpenAPI

````yaml https://api.craveup.com/swagger.json post /login-customer
openapi: 3.0.0
info:
  title: Crave API v2.0
  version: 2.0.0
  description: >

    ## 🔑 Generate an API Key

    Every request to the Storefront API must include an API key.


    1. Sign in to the [Crave Business Manager](https://partners.craveup.com).

    2. Open **Settings → Developer → API Keys**.

    3. Click **Generate Key**, give it a descriptive name (for example,
    `storefront-sdk-staging`), and confirm.

    4. Copy the key immediately—once you leave the page it cannot be viewed
    again.


    Add the key to each request header:


    ```http

    GET /merchant/crave-collective

    Host: api.craveup.com

    X-API-Key: <your-api-key>

    ```


    ### Best practices

    - Store keys in environment variables or a secrets manager; never commit
    them to source control.

    - Use separate keys for staging and production so they can be rotated
    independently.

    - If a key is exposed, revoke it from the dashboard and generate a fresh one
    right away.
  contact:
    name: Crave Support
    email: support@craveup.com
servers:
  - url: https://api.craveup.com/api/v1
    description: Production Storefront API
  - url: https://dev-api-43233223.craveup.com/api/v1
    description: Staging Storefront API
security:
  - ApiKeyAuth: []
tags:
  - name: Merchants
    description: Retrieve merchant metadata and enabled storefront locations.
  - name: Locations
    description: Access individual location information and configuration.
  - name: Ordering Sessions
    description: Create or resume ordering sessions and carts for a location.
  - name: Menus
    description: Fetch menu bundles, categories, and popular products for a location.
  - name: Products
    description: Request detailed storefront product data including modifiers.
  - name: Carts
    description: Manage cart state, totals, and cross-sell recommendations.
  - name: Customers
    description: Handle storefront customer authentication, profiles, and sessions.
paths:
  /login-customer:
    post:
      tags:
        - Customers
      summary: Login or Register Customer
      description: >-
        Initiates the OTP login or registration flow using an email address or
        phone number.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                profilePicture:
                  type: string
                  nullable: true
                  example: https://cdn.example.com/avatar.jpg
                identifierString:
                  type: string
                  example: user@example.com
                customerName:
                  type: string
                  example: John Doe
                provider:
                  type: string
                  nullable: true
                  example: google
                lastName:
                  type: string
                  nullable: true
                  example: Doe
              required:
                - identifierString
                - customerName
      responses:
        '200':
          description: OTP challenge initiated successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StorefrontLoginResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '500':
          $ref: '#/components/responses/GenericError'
      security: []
components:
  schemas:
    StorefrontLoginResponse:
      type: object
      properties:
        stytchUserId:
          type: string
          example: user-live-123
        methodId:
          type: string
          example: email-live-456
        created:
          type: boolean
          example: true
      required:
        - stytchUserId
        - methodId
        - created
      description: >-
        Response returned by Stytch when an OTP challenge is initiated. Use
        `methodId` when submitting the OTP.
  responses:
    BadRequest:
      description: Bad Request - The request was invalid or cannot be served.
      content:
        application/json:
          schema:
            type: object
            properties:
              success:
                type: boolean
                example: false
              message:
                type: string
                example: Invalid input parameters
              code:
                type: string
                example: BAD_REQUEST
              data:
                type: object
                example: {}
    GenericError:
      description: Generic Error - An unexpected error occurred.
      content:
        application/json:
          schema:
            type: object
            properties:
              success:
                type: boolean
                example: false
              message:
                type: string
                example: An unexpected error occurred
              code:
                type: string
                example: GENERIC_ERROR
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: API Key required to authenticate requests

````