# Mobile APIs

Mobile APIs for user registration, authentication, profile management, and support operations. This specification includes detailed summaries and descriptions for every operation, parameter, request/response body, and schema so clients can integrate without reading code. Examples and field-level constraints are provided wherever applicable.

Version: 1.0.0
License: Apache 2.0

## Servers

Development server. All endpoints require a valid `x-api-key` header as defined in `securitySchemes.ApiKeyAuth`.
```
https://dev.api.ivalt.com/admin/public/api
```

Production server. All endpoints require a valid `x-api-key` header as defined in `securitySchemes.ApiKeyAuth`.
```
https://api.ivalt.com/admin/public/api
```

## Security

### ApiKeyAuth

API key required for authorization. Include in every request to authenticated endpoints.

Type: apiKey
In: header
Name: x-api-key

## Download OpenAPI description

[Mobile APIs](https://api-docs.ivalt.com/_bundle/products/mobile/Mobile_Apis.yaml)

## MobileApis

Operations related to mobile user registration, authentication, profile management, and support services.

### Register Mobile User

 - [POST /wp/register/mobile/user](https://api-docs.ivalt.com/products/mobile/mobile_apis/mobileapis/registermobileuser.md): Register a new mobile user with comprehensive device and profile information. Typically used during initial app onboarding or user registration workflow.

### Send OTP SMS

 - [POST /wp/send/sms](https://api-docs.ivalt.com/products/mobile/mobile_apis/mobileapis/sendotpsms.md): Send an OTP (One-Time Password) via SMS to the specified mobile number. Used for mobile verification during registration or authentication flows.

### Confirm Register

 - [POST /wp/confirm/register](https://api-docs.ivalt.com/products/mobile/mobile_apis/mobileapis/confirmregister.md): Confirm and complete the user registration process after OTP verification. Updates user record with final details and activates the account.

### Refresh Mobile Token

 - [POST /wp/mobile/refresh/token](https://api-docs.ivalt.com/products/mobile/mobile_apis/mobileapis/refreshmobiletoken.md): Refresh the authentication token for a mobile user. Used to maintain session validity and security.

### Contact Support

 - [POST /contact/support](https://api-docs.ivalt.com/products/mobile/mobile_apis/mobileapis/contactsupport.md): Send a support message to IVALT support team. Includes user contact information for follow-up.

### Save Faceauth Success

 - [GET /save/faceauth/success/{auth_token}](https://api-docs.ivalt.com/products/mobile/mobile_apis/mobileapis/savefaceauthsuccess.md): Record a successful face authentication event. Typically called by authentication systems after successful biometric verification.

### Enrollment Status

 - [POST /enrolstatus](https://api-docs.ivalt.com/products/mobile/mobile_apis/mobileapis/enrollmentstatus.md): Check the enrollment status of a mobile user. Returns current enrollment state and any pending requirements.

### Check Enrollment

 - [POST /is_enrolled](https://api-docs.ivalt.com/products/mobile/mobile_apis/mobileapis/checkenrollment.md): Verify if a user is enrolled in the system. Returns boolean result indicating enrollment status.

### Check IMEI

 - [POST /check-imei](https://api-docs.ivalt.com/products/mobile/mobile_apis/mobileapis/checkimei.md): Validate and check the status of a device IMEI (International Mobile Equipment Identity). Used for device authentication and security.

### Assign User to Organization

 - [POST /user/assign-org](https://api-docs.ivalt.com/products/mobile/mobile_apis/mobileapis/assignusertoorganization.md): Assign a mobile user to a specific organization. Links user account with organizational context and permissions.

### Check Organization Assignment

 - [POST /user/check-org-assignment](https://api-docs.ivalt.com/products/mobile/mobile_apis/mobileapis/checkorganizationassignment.md): Verify if a user is assigned to any organization and retrieve assignment details.

### Resend Email Verification

 - [POST /resend-email-verification](https://api-docs.ivalt.com/products/mobile/mobile_apis/mobileapis/resendemailverification.md): Resend email verification link to user's email address. Used when initial verification email was not received or expired.

### Update Profile

 - [POST /update-profile](https://api-docs.ivalt.com/products/mobile/mobile_apis/mobileapis/updateprofile.md): Update user profile information such as name and contact details.

### Get User

 - [POST /getuser](https://api-docs.ivalt.com/products/mobile/mobile_apis/mobileapis/getuser.md): Retrieve user details and profile information by mobile number.