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

# Request OTP for customer verification

> Send OTP code to customer's phone or email. Used when integration requires identity verification. Authentication via X-API-Key header (partner API key).



## OpenAPI

````yaml /api-reference/openapi.json post /api/v2/auth/request-otp/
openapi: 3.0.3
info:
  title: Zupy API v2
  version: 2.0.0
  description: >-
    Zupy API v2 — versioned, gateway-aware API with envelope responses, RFC 7807
    errors, and multi-auth support (JWT, API Key, Device Key).
servers:
  - url: https://api.zupy.com
    description: Production
security: []
tags:
  - name: Authentication
    description: OTP request and verification endpoints
  - name: Customers
    description: Customer management, points, history, and data operations
  - name: Loyalty Programs
    description: Loyalty program configuration and details
  - name: Rewards
    description: Loyalty reward catalog (definitions redeemed with points)
  - name: Companies
    description: Company information and loyalty configuration
  - name: Coupons
    description: >-
      Issued coupons (RewardRedemption) — both loyalty-reward redemptions and
      marketing claims
  - name: Wallet
    description: Apple Wallet pass generation and notifications
  - name: Webhooks
    description: Partner integration webhook endpoints
  - name: Webhook Management
    description: Configure and test outbound webhook delivery
paths:
  /api/v2/auth/request-otp/:
    post:
      tags:
        - Authentication
      summary: Request OTP for customer verification
      description: >-
        Send OTP code to customer's phone or email. Used when integration
        requires identity verification. Authentication via X-API-Key header
        (partner API key).
      operationId: auth_request_otp
      parameters:
        - in: header
          name: X-API-Key
          schema:
            type: string
          description: Partner API key
          required: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OTPRequestBody'
            examples:
              OTPRequest—Phone:
                value:
                  identifier: '+5511987654321'
                summary: OTP Request — Phone
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/OTPRequestBody'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/OTPRequestBody'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OTPRequestResponse'
              examples:
                OTPSent—WhatsApp:
                  value:
                    status: sent
                    channel: whatsapp
                    expires_in: 300
                  summary: OTP Sent — WhatsApp
          description: ''
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: ''
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: ''
      security:
        - apiKeyAuth: []
components:
  schemas:
    OTPRequestBody:
      type: object
      properties:
        identifier:
          type: string
          description: Phone (+5511...), email, or CPF
      required:
        - identifier
    OTPRequestResponse:
      type: object
      properties:
        status:
          type: string
          description: Always 'sent'
        channel:
          type: string
          description: 'Delivery channel: whatsapp, email, or sms'
        expires_in:
          type: integer
          description: OTP expiry in seconds
      required:
        - channel
        - expires_in
        - status
    Error:
      type: object
      description: RFC 7807 Problem Details error response.
      properties:
        type:
          type: string
          format: uri
        title:
          type: string
        status:
          type: integer
        detail:
          type: string
        instance:
          type: string
      required:
        - detail
        - instance
        - status
        - title
        - type
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        Per-company partner API key (zupy_pk_…). Validated by Zupy against the
        company integration key hash (Story 14.x); send it on every request as
        the X-API-Key header. Scoped read-write to the owning company's data.

````