1. Auth
  • 01 - Overview
  • 02 - User Guide
  • 03 - Technical Guide
  • 04 - Operations
  • App
    • Get application hello response
      GET
  • Users
    • Kullanıcı profili
      GET
    • Update current user profile
      PATCH
    • Opsiyonel kimlik doğrulama
      GET
    • Tüm kullanıcıları listele
      GET
    • Get user by id (Admin)
      GET
    • Kullanıcı sil
      DELETE
    • Update user profile by id (Admin)
      PATCH
    • Update user email by id (Admin)
      PATCH
    • Update user role by id (Superadmin)
      PATCH
  • Auth
    • Token yenileme
      POST
    • Kullanıcı çıkışı
      POST
    • Request OTP (Login or Register)
      POST
    • Verify OTP (Login or Register)
      POST
    • Complete registration
      POST
    • Get registration status
      GET
  • Courses
    • Create a new course (Admin only)
      POST
    • Get all courses
      GET
    • Duplicate an existing course
      POST
    • Kurs detayını görüntüle
      GET
    • Update an existing course (Admin only)
      PATCH
    • Delete a course (Admin only)
      DELETE
  • Storage
    • Upload a file to storage
  • Proficiency Tests
    • Create a new proficiency test
    • List available proficiency tests
    • Duplicate an existing proficiency test
    • Update an existing proficiency test
    • Get test details
    • Delete proficiency test (Admin)
    • Get available target languages
    • Get detailed test result (Admin)
    • Delete test result (Admin)
    • Get all test results (Admin)
    • Get test results for a specific user (Admin)
    • Get current user results
    • Get detailed test result
    • Check if user has completed the test
    • Submit a proficiency test
  • Settings
    • Get setting by key
    • Create or update a setting (Admin)
  • Education Materials
    • Create a new education material with multiple PDFs and videos
    • List all education materials with optional locale filtering
    • Assign an education material to one or more users (Admin)
    • Get assigned education materials for current user
    • Get assigned education materials for a specific user (Admin)
    • Get detailed information about a specific education material
    • Update education material details and/or add new PDFs
    • Delete an education material
  • Contact
    • Submit a contact request
    • Get contact requests (Admin)
    • Reply to a contact request (Admin)
    • Delete a contact request (Admin)
    • Update contact status (Admin)
  • Admin Dashboard
    • Get aggregated dashboard metrics for admin panel
  • Schemas
    • UserDocument
    • BaseResponseDto
    • RequestOtpDto
    • VerifyOtpDto
    • HelloResponseDto
    • AuthResponseDto
    • UserProfileDto
    • UserProfileResponseDto
    • UserResponseDto
    • UpdateMeProfileDto
    • OptionalAuthResponseDto
    • PaginationDto
    • AdminUpdateUserProfileDto
    • AdminUpdateUserEmailDto
    • OtpResponseDto
    • UpdateUserRoleDto
    • DeleteResponseDto
    • RefreshTokenDto
    • LogoutResponseDto
    • RequestOtpUnifiedDto
    • VerifyOtpUnifiedDto
    • CompleteRegistrationResponseDto
    • CompleteRegistrationDto
    • RegistrationStatusResponseDto
    • CourseResponseDto
    • UploadFileResponseDto
    • LevelRangeResponseDto
    • ProficiencyOptionResponseDto
    • ProficiencyQuestionResponseDto
    • ProficiencyTestDetailResponseDto
    • OptionDto
    • QuestionDto
    • LevelRangeDto
    • CreateProficiencyTestDto
    • UpdateProficiencyTestDto
    • ProficiencyTestListResponseDto
    • TargetLanguagesResponseDto
    • UserTestAnswerResponseDto
    • UserTestResultUserSummaryDto
    • UserTestResultTestSummaryDto
    • UserTestResultResponseDto
    • DeleteUserTestResultResponseDto
    • UserTestResultListResponseDto
    • UserTestStatusSummaryDto
    • UserTestStatusResponseDto
    • DeleteProficiencyTestResponseDto
    • AnswerDto
    • SubmitTestDto
    • SettingValueResponseDto
    • SettingResponseDto
    • UpsertSettingDto
    • MaterialPdfResponseDto
    • MaterialVideoResponseDto
    • EducationMaterialResponseDto
    • CreateEducationMaterialDto
    • AssignEducationMaterialSummaryDto
    • AssignEducationMaterialDto
    • AssignedByResponseDto
    • AssignedEducationMaterialResponseDto
    • MyAssignedEducationMaterialsResponseDto
    • UserSummaryForAssignmentsDto
    • AdminUserAssignedMaterialsResponseDto
    • UpdateEducationMaterialDto
    • DeleteEducationMaterialResponseDto
    • ContactResponseDto
    • CreateContactRequestDto
    • ReplyContactRequestDto
    • UpdateContactStatusRequestDto
    • DashboardUsersOverviewDto
    • DashboardCoursesOverviewDto
    • DashboardTestsOverviewDto
    • DashboardContactsOverviewDto
    • DashboardMaterialsOverviewDto
    • DashboardOverviewDto
    • DashboardTrendDto
    • DashboardDistributionItemDto
    • DashboardLevelDistributionItemDto
    • DashboardLanguageDistributionItemDto
    • DashboardDistributionsDto
    • DashboardRecentContactDto
    • DashboardRecentResultDto
    • DashboardRecentActivityDto
    • AdminDashboardStatsResponseDto
  1. Auth

Request OTP (Login or Register)

POST
/auth/otp/request
Sends a 6-digit OTP code to the email address. Works for both login and registration. Supports multiple languages (tr, en, es, de).

Request

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200
application/json
OTP code has been sent successfully to the email address
Body

🟠400
🟠429
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/auth/otp/request' \
--header 'accept-language;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "user@example.com",
    "language": "tr"
}'
Response Response Example
200 - Example 1
{
    "isSuccess": true,
    "statusCode": 200,
    "data": {
        "message": "Verification code has been sent to your email address",
        "email": "user@example.com"
    },
    "errors": [
        "Error messages..."
    ],
    "timestamp": "2026-02-14T09:58:22.016Z"
}
Modified at 2026-02-14 10:03:30
Previous
Kullanıcı çıkışı
Next
Verify OTP (Login or Register)
Built with