Auth Routes

Register

POST api/register

on this endpoint register user

Fields

  • identification required
  • password required
  • password_confirmation required
  • first_name required
  • last_name required

Response

  • user
    • id
    • first_name
    • last_name
    • personal_number
    • phone
    • birth_date
    • email
    • avatar

Login

POST api/login

on this endpoint login user

Fields

  • login required
  • password required

Response

  • user
    • id
    • first_name
    • last_name
    • personal_number
    • phone
    • birth_date
    • email
    • avatar
  • access_token
  • refresh_token

Logout

POST api/logout

on this endpoint revoke current user token that causes log out

Fields

Response

  • status

Verify

Phone

POST api/phone/verify/{user_id}/{code}

endpoint is used for phone verification, passed parameters: user_id and code which was sent to phone

Fields

  • phone string, mandatory (should be phone)
  • code string, mandatory , max:4, min:4, numbers

Response

  • status boolean
  • message string
  • access_token token

Email

POST api/email/verify/{id}/{hash}

endpoint is used for email verification. user is automatically redirected to FE url after verification

Response

  • status success
  • access_token token

Forgot Password

POST api/forgot-password

This endpoint sends OTP if login is phone or reset link to email if login is email

Fields

  • login required

Response

  • status
  • phone
  • message

Update Password

Phone Password Reset

POST api/phone/reset-password

This endpoint is used to reset password with phone

Fields

  • phone - number, mandatory
  • code - string, mandatory
  • password - string, mandatory
  • password-confirmation - string, mandatory

Response

  • status

Update Password from FE link

POST api/email/reset-password

endpoint is used for update password after user goes from email to url.

Fields

  • email
  • password
  • password_confirmation
  • token

Response

  • status

OTP

Check OTP

check if OTP exist and correct

POST api/phone/check-otp

Fields

  • phone
  • code

Response

  • status
  • message

Check OTP

Resend OTP code

POST api/phone/resend-otp

Fields

  • phone

Response

  • phone
  • message