Version Check

GET

/api/v1/mobile/version-check

• Production
• Local development

Check whether the mobile app needs an update.

Compares the client’s current version against the configured minimum version. Returns force_update=True when the client is below the minimum, signaling that the app must update before continuing.

This endpoint is unauthenticated — the app checks version before the user logs in.

Authorizations

• ApiKeyAuth

Parameters

Query Parameters

platform

required

Mobile platform (ios or android)

string

/^(ios|android)$/

Mobile platform (ios or android)

current_version

required

Current app version (semver)

string

/^\d+\.\d+\.\d+$/

Current app version (semver)

Responses

200

Successful Response

Response body for mobile version check.

Attributes: min_version: Minimum supported app version. latest_version: Latest available app version. force_update: Whether the app must update before use. update_url_ios: App Store URL for iOS updates. update_url_android: Play Store URL for Android updates.

object

force_update

required

boolean

latest_version

required

string

min_version

required

string

update_url_android

required

string

update_url_ios

required

string

422

Validation Error

object

detail

Array<object>

object

ctx

object

input

loc

required

Array

msg

required

string

type

required

string