Skip to content
API References
/
Mobile API
/
/
Save Faceauth Success

Mobile APIs (1.0.0)

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.

Download OpenAPI description
Mobile_Apis.json
Mobile_Apis.yaml
Overview
URL
https://ivalt.com/support
IVALT Support
support@ivalt.com
License
Apache 2.0
Languages
Servers
Mock server
https://api-docs.ivalt.com/_mock/products/mobile/mobile_apis/
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/

MobileApis

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

Operations

Register Mobile User

Request

Register a new mobile user with comprehensive device and profile information. Typically used during initial app onboarding or user registration workflow.

Security
ApiKeyAuth
Bodyapplication/jsonrequired

Complete user registration payload including personal details, device information, and platform context.

namestringrequired

Full name of the user.

Example: "Bikram"
country_codestring^\+[1-9]\d{0,3}$required

Country code in E.164 format.

Example: "+91"
user_codeintegerrequired

Unique user identification code.

Example: 4775
mobilestring^[0-9]{10,15}$required

Mobile number without country code.

Example: "62839xxxxx"
imeistringrequired

Device IMEI or unique device identifier.

Example: "ED9F012A-3991-4BF5-83EB-685F56FA57B7"
emailstring(email)required

User's email address.

Example: "bs863313@gmail.com"
device_tokenstringrequired

Push notification device token.

Example: "sdfsdfguiguiguigg"
platformstringrequired

Device platform (iOS, Android, etc.).

Enum"iOS""Android""ios""android"
Example: "iOS"
curl -i -X POST \
  https://api-docs.ivalt.com/_mock/products/mobile/mobile_apis/wp/register/mobile/user \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "name": "Bikram",
    "country_code": "+91",
    "user_code": 4775,
    "mobile": "6283974746",
    "imei": "ED9F012A-3991-4BF5-83EB-685F56FA57B7",
    "email": "bs863313@gmail.com",
    "device_token": "sdfsdfguiguiguigg",
    "platform": "iOS"
  }'

Responses

User registered successfully. The mobile user account is now created and ready for use.

Bodyapplication/json
statusstringrequired

Indicates request success. Always success in this schema.

Example: "success"
messagestringrequired

Short description of the successful operation outcome..

Example: "Operation completed successfully"
Response
application/json
{
  "status": "success",
  "message": "Successfully registered"
}

Send OTP SMS

Request

Send an OTP (One-Time Password) via SMS to the specified mobile number. Used for mobile verification during registration or authentication flows.

Security
ApiKeyAuth
Bodyapplication/jsonrequired

Mobile number to receive the OTP SMS. Must be a valid phone number.

mobilestring^\+[1-9]\d{7,14}$required

Mobile number to receive OTP.

Example: "+9162839xxxxx"
curl -i -X POST \
  https://api-docs.ivalt.com/_mock/products/mobile/mobile_apis/wp/send/sms \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "mobile": "+916283974746"
  }'

Responses

SMS sent successfully. The OTP has been delivered to the provided mobile number.

Bodyapplication/json
statusstringrequired

Indicates request success. Always success in this schema.

Example: "success"
messagestringrequired

Short description of the successful operation outcome..

Example: "Operation completed successfully"
Response
application/json
{
  "status": "success",
  "message": "Sms sent successfully"
}

Confirm Register

Request

Confirm and complete the user registration process after OTP verification. Updates user record with final details and activates the account.

Security
ApiKeyAuth
Bodyapplication/jsonrequired

Complete user registration confirmation payload. Must match the initial registration data.

namestringrequired

Full name of the user.

Example: "Bikramjeet Singh"
country_codestring^\+[1-9]\d{0,3}$required

Country code in E.164 format.

Example: "+91"
user_codeintegerrequired

Unique user identification code.

Example: 5630
mobilestringrequired

Mobile number without country code.

Example: "62839xxxxx"
device_tokenstringrequired

Push notification device token.

Example: "123456"
imeistringrequired

Device IMEI or unique device identifier.

Example: "ED9F012A-3991-4BF5-83EB-685F56FA57B7"
emailstring(email)required

User's email address.

Example: "example@ivalt.com"
platformstringrequired

Device platform (iOS, Android, etc.).

Enum"iOS""Android""ios""android"
Example: "ios"
curl -i -X POST \
  https://api-docs.ivalt.com/_mock/products/mobile/mobile_apis/wp/confirm/register \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "name": "Jaskaran",
    "country_code": "+91",
    "user_code": 5630,
    "mobile": "62839xxxxx",
    "device_token": "123456",
    "imei": "ED9F012A-3991-4BF5-83EB-685F56FA57B7",
    "email": "bikramjeet@ivalt.com",
    "platform": "ios"
  }'

Responses

User registered/updated successfully. The account is now active and ready for use.

Bodyapplication/json
statusstringrequired

Indicates request success. Always success in this schema.

Example: "success"
messagestringrequired

Short description of the successful operation outcome..

Example: "Operation completed successfully"
Response
application/json
{
  "status": "success",
  "message": "User registered/updated successfully"
}

Refresh Mobile Token

Request

Refresh the authentication token for a mobile user. Used to maintain session validity and security.

Security
ApiKeyAuth
Bodyapplication/jsonrequired

Token refresh payload containing device identification and current token.

imeistringrequired

Device IMEI or unique device identifier.

Example: "ED9F012A-3991-4BF5-83EB-685F56FA57B7"
mobilestringrequired

Mobile number without country code.

Example: "62839xxxxx"
tokenstringrequired

Current authentication token to be refreshed.

Example: "4590-C4864D900D98-75"
curl -i -X POST \
  https://api-docs.ivalt.com/_mock/products/mobile/mobile_apis/wp/mobile/refresh/token \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "imei": "ED9F012A-3991-4BF5-83EB-685F56FA57B7",
    "mobile": "62839xxxxx",
    "token": "4590-C4864D900D98-75"
  }'

Responses

Token updated successfully. The user's session has been extended with a new token.

Bodyapplication/json
statusstringrequired

Indicates request success. Always success in this schema.

Example: "success"
messagestringrequired

Short description of the successful operation outcome..

Example: "Operation completed successfully"
Response
application/json
{
  "status": "success",
  "message": "Token updated successfully"
}

Contact Support

Request

Send a support message to IVALT support team. Includes user contact information for follow-up.

Security
ApiKeyAuth
Bodyapplication/jsonrequired

Support request payload containing user message and contact details.

mobilestringrequired

User's mobile number for contact.

Example: "62839xxxxx"
messagestringrequired

Support message or query.

Example: "This is api test message laravel apis"
emailstring(email)required

User's email address for follow-up.

Example: "bikramjeet@ivalt.com"
curl -i -X POST \
  https://api-docs.ivalt.com/_mock/products/mobile/mobile_apis/contact/support \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "mobile": "62839xxxxx",
    "message": "This is api test message laravel apis",
    "email": "bikramjeet@ivalt.com"
  }'

Responses

Support mail sent successfully. The message has been delivered to the support team.

Bodyapplication/json
statusstringrequired

Indicates request success. Always success in this schema.

Example: "success"
messagestringrequired

Short description of the successful operation outcome..

Example: "Operation completed successfully"
Response
application/json
{
  "status": "success",
  "message": "Mail sent successfully"
}

Save Faceauth Success

Request

Record a successful face authentication event. Typically called by authentication systems after successful biometric verification.

Security
ApiKeyAuth
Path
auth_tokenstringrequired

Unique authentication token identifying the face authentication session.

Example: faceauth_token_12345
curl -i -X GET \
  https://api-docs.ivalt.com/_mock/products/mobile/mobile_apis/save/faceauth/success/faceauth_token_12345 \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Face authentication successfully recorded in the system.

Bodyapplication/json
statusstringrequired

Indicates request success. Always success in this schema.

Example: "success"
messagestringrequired

Short description of the successful operation outcome..

Example: "Operation completed successfully"
Response
application/json
{
  "status": "success",
  "message": "Faceauth saved successfully"
}

Enrollment Status

Request

Check the enrollment status of a mobile user. Returns current enrollment state and any pending requirements.

Security
ApiKeyAuth
Bodyapplication/jsonrequired

Mobile number to check enrollment status for.

mobilestringrequired

Mobile number to check enrollment status for.

Example: "62839xxxxx"
curl -i -X POST \
  https://api-docs.ivalt.com/_mock/products/mobile/mobile_apis/enrolstatus \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "mobile": "62839xxxxx"
  }'

Responses

Enrollment status retrieved successfully.

Bodyapplication/json
statusstringrequired

Outcome of the request.

Example: "success"
messagestringrequired

Summary of the result.

Example: "Enrollment status"
dataobjectrequired
data.​enrolledboolean
Example: true
data.​enrollment_datestring(date)
Example: "2024-01-15"
data.​statusstring
Example: "completed"
Response
application/json
{
  "status": "success",
  "message": "Enrollment status",
  "data": {
    "enrolled": true,
    "enrollment_date": "2024-01-15",
    "status": "completed"
  }
}

Check Enrollment

Request

Verify if a user is enrolled in the system. Returns boolean result indicating enrollment status.

Security
ApiKeyAuth
Bodyapplication/jsonrequired

Mobile number to check enrollment for.

mobilestringrequired

Mobile number to check enrollment for.

Example: "62839xxxxx"
curl -i -X POST \
  https://api-docs.ivalt.com/_mock/products/mobile/mobile_apis/is_enrolled \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "mobile": "62839xxxxx"
  }'

Responses

Enrollment check completed successfully.

Bodyapplication/json
statusstringrequired

Outcome of the request.

Example: "success"
messagestringrequired

Summary of the result.

Example: "Enrollment check result"
enrolledbooleanrequired

Indicates whether the user is enrolled.

Example: true
Response
application/json
{
  "status": "success",
  "message": "Enrollment check result",
  "enrolled": true
}

Check IMEI

Request

Validate and check the status of a device IMEI (International Mobile Equipment Identity). Used for device authentication and security.

Security
ApiKeyAuth
Bodyapplication/jsonrequired

IMEI number to validate and check.

imeistringrequired

IMEI number to validate.

Example: "ED9F012A-3991-4BF5-83EB-685F56FA57B7"
curl -i -X POST \
  https://api-docs.ivalt.com/_mock/products/mobile/mobile_apis/check-imei \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "imei": "ED9F012A-3991-4BF5-83EB-685F56FA57B7"
  }'

Responses

IMEI check completed successfully.

Bodyapplication/json
statusstringrequired

Outcome of the request.

Example: "success"
messagestringrequired

Summary of the IMEI check.

Example: "IMEI check result"
validbooleanrequired

True if the IMEI is valid and known.

Example: true
device_typestring

Classified type of the device for the IMEI (e.g., smartphone).

Example: "smartphone"
Response
application/json
{
  "status": "success",
  "message": "IMEI check result",
  "valid": true,
  "device_type": "smartphone"
}

Assign User to Organization

Request

Assign a mobile user to a specific organization. Links user account with organizational context and permissions.

Security
ApiKeyAuth
Bodyapplication/jsonrequired

Organization assignment payload containing user and organization details.

country_codestringrequired

Country code in E.164 format.

Example: "+91"
mobilestringrequired

Mobile number without country code.

Example: "62839xxxxx"
organization_codestringrequired

Unique organization identifier.

Example: "Ivalt"
curl -i -X POST \
  https://api-docs.ivalt.com/_mock/products/mobile/mobile_apis/user/assign-org \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "country_code": "+91",
    "mobile": "62839xxxxx",
    "organization_code": "Ivalt"
  }'

Responses

User assigned to organization successfully.

Bodyapplication/json
statusstringrequired

Indicates request success. Always success in this schema.

Example: "success"
messagestringrequired

Short description of the successful operation outcome..

Example: "Operation completed successfully"
Response
application/json
{
  "status": "success",
  "message": "User assigned successfully"
}

Check Organization Assignment

Request

Verify if a user is assigned to any organization and retrieve assignment details.

Security
ApiKeyAuth
Bodyapplication/jsonrequired

User details to check organization assignment for.

country_codestringrequired

Country code in E.164 format.

Example: "+91"
mobilestringrequired

Mobile number without country code.

Example: "9530654704"
curl -i -X POST \
  https://api-docs.ivalt.com/_mock/products/mobile/mobile_apis/user/check-org-assignment \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "country_code": "+91",
    "mobile": "9530654704"
  }'

Responses

Organization assignment check completed successfully.

Bodyapplication/json
statusstringrequired
Example: "success"
messagestringrequired
Example: "Check org assignment result"
assignedbooleanrequired
Example: true
organization_codestring
Example: "Ivalt"
assigned_datestring(date)
Example: "2024-01-15"
Response
application/json
{
  "status": "success",
  "message": "Check org assignment result",
  "assigned": true,
  "organization_code": "Ivalt",
  "assigned_date": "2024-01-15"
}

Resend Email Verification

Request

Resend email verification link to user's email address. Used when initial verification email was not received or expired.

Security
ApiKeyAuth
Bodyapplication/jsonrequired

User details for email verification resend.

emailstring(email)required

Email address to resend verification to.

Example: "example@ivalt.com"
country_codestringrequired

Country code in E.164 format.

Example: "+91"
mobilestringrequired

Mobile number without country code.

Example: "62839xxxxx"
curl -i -X POST \
  https://api-docs.ivalt.com/_mock/products/mobile/mobile_apis/resend-email-verification \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "email": "bikramjeet@ivalt.com",
    "country_code": "+91",
    "mobile": "62839xxxxx"
  }'

Responses

Email verification resent successfully.

Bodyapplication/json
statusstringrequired

Indicates request success. Always success in this schema.

Example: "success"
messagestringrequired

Short description of the successful operation outcome..

Example: "Operation completed successfully"
Response
application/json
{
  "status": "success",
  "message": "Email verification resent"
}

Update Profile

Request

Update user profile information such as name and contact details.

Security
ApiKeyAuth
Bodyapplication/jsonrequired

Updated profile information for the user.

namestringrequired

Updated full name of the user.

Example: "Bikramjeet Singh"
country_codestringrequired

Country code.

Example: "+91"
mobilestringrequired

Mobile number without country code.

Example: "62839xxxxx"
curl -i -X POST \
  https://api-docs.ivalt.com/_mock/products/mobile/mobile_apis/update-profile \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "name": "Bikramjeet Singh",
    "country_code": "+91",
    "mobile": "62839xxxxx"
  }'

Responses

Profile updated successfully.

Bodyapplication/json
statusstringrequired

Indicates request success. Always success in this schema.

Example: "success"
messagestringrequired

Short description of the successful operation outcome..

Example: "Operation completed successfully"
Response
application/json
{
  "status": "success",
  "message": "Profile updated"
}

Get User

Request

Retrieve user details and profile information by mobile number.

Security
ApiKeyAuth
Bodyapplication/jsonrequired

Mobile number to retrieve user details for.

mobilestringrequired

Mobile number to retrieve user details for.

Example: "62839xxxxx"
curl -i -X POST \
  https://api-docs.ivalt.com/_mock/products/mobile/mobile_apis/getuser \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "mobile": "62839xxxxx"
  }'

Responses

User details retrieved successfully.

Bodyapplication/json
statusstringrequired

Outcome of the request.

Example: "success"
messagestringrequired

Summary of the result.

Example: "User details"
dataobjectrequired
data.​namestring
Example: "Bikramjeet Singh"
data.​emailstring
Example: "bikramjeet@ivalt.com"
data.​mobilestring
Example: "62839xxxxx"
data.​country_codestring
Example: "+91"
data.​enrolledboolean
Example: true
Response
application/json
{
  "status": "success",
  "message": "User details",
  "data": {
    "name": "Bikramjeet Singh",
    "email": "bikramjeet@ivalt.com",
    "mobile": "62839xxxxx",
    "country_code": "+91",
    "enrolled": true
  }
}