UserSignInInitiated

v1.0.0

openapi: 3.0.0
info:
  version: "1.0.0"
  title: UserSignInInitiated
paths: {}
components:
  schemas:
    UserSignInInitiated:
      type: object
      required:
        - metadata
        - data
      properties:
        data:
          "$ref": "#/components/schemas/Data"
        metadata:
          "$ref": "#/components/schemas/Metadata"
    Data:
      type: object
      required:
        - userId
        - phoneNumber
        - email
        - channel
        - signInAt
      properties:
        userId:
          type: string
        phoneNumber:
          type: string
        email:
          type: string
        challenge:
          type: string
          description: OTP, hashed password, magic link 
        channel:
          type: string
          enum:
            - whatsapp
            - sms
            - magicLink
            - biometrics
        fallbackChannel:
          type: string
          enum:
            - whatsapp
            - sms
            - magicLink
            - biometrics
        signInAt: 
          type: string
          format: date-time
        userIp:
          oneOf:
            - type: string
              format: ipv4
            - type: string
              format: ipv6
          type: string
        userAgent:
          type: string

    Metadata:
      type: object
      required:
        - serviceFunction
        - version
      properties:
        serviceFunction:
          type: string
        version:
          type: string