---
title: "Request SMS OTP"
method: POST
path: "/api/v1/mobile/auth/sms-request"
tags: ["Mobile - Authentication"]
---

# Request SMS OTP

`POST /api/v1/mobile/auth/sms-request`

## Request

- Base URL: `https://api.caresquare.com.au` (the document declares no server; this is the origin it was published from)
- URL: `https://api.caresquare.com.au/api/v1/mobile/auth/sms-request`
- Auth: none declared

Request SMS OTP to be sent to the provided phone number.

## Request body

- SmsRequestPayload: Request SMS OTP.
  - `phone_number` string, required: Phone number in international format (e.g., +61412345678)

## Response `200`

Successful Response

- SmsRequestResponse: SMS OTP request response.
  - `phone_number` string, required: Phone number OTP was sent to
  - `message` string, required: Status message

## Other responses

- `400`: Bad request
- `422`: Validation Error

---

[API](https://skmtc.dev/caresquare/apis/caresquare-api.md) - [All operations](https://skmtc.dev/caresquare/apis/caresquare-api/llms.txt) - [OpenAPI document](https://skmtc.dev/caresquare/apis/caresquare-api/revisions/d428fe38bf62?raw)