> ## Documentation Index
> Fetch the complete documentation index at: https://ownpay.org/docs/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> OwnPay is licensed under AGPL-3.0 and is completely free - no licensing fees.
> Production docs URL: https://ownpay.org/docs - append .md to any page URL for clean markdown.
> OwnPay requires PHP 8.3+, MySQL/MariaDB, and Redis.
> MCP server available at https://ownpay.org/docs/mcp for programmatic documentation queries.
> Use root-relative links (e.g. /quickstart) for internal navigation - do NOT include /docs prefix.
> Plugin development: consult /developer/plugin-types/ pages for correct interfaces and manifests.

# Mobile API Reference - Companion App and SMS Forwarding

> Mobile API endpoints used by the OwnPay Android companion app for device pairing, JWT authentication, SMS forwarding, and payment verification.

The Mobile API enables the OwnPay mobile companion app to pair devices, receive SMS notifications, and verify payments through mobile banking alerts.

## Base URL

```text theme={null}
https://{brand_domain}
```

## Authentication

Most endpoints require JWT authentication. Device pairing and token refresh are exempt.

```http theme={null}
Authorization: Bearer YOUR_JWT_TOKEN
```

## Key Endpoints

| Endpoint                           | Description                            |
| ---------------------------------- | -------------------------------------- |
| `POST /api/mobile/v1/devices`      | Pair a mobile device with pairing code |
| `GET /api/mobile/v1/devices`       | List paired devices                    |
| `POST /api/mobile/v1/sms/incoming` | Receive incoming SMS for verification  |
| `GET /api/mobile/v1/notifications` | Get pending notifications              |

## Device Pairing Flow

1. Generate a pairing code from the OwnPay admin dashboard
2. Enter the code in the mobile app
3. App receives an AES-256 encryption key and JWT tokens
4. Device is now paired and can receive SMS notifications

<Note>
  Full API documentation is auto-generated from the OpenAPI specification.
</Note>


## Related topics

- [Retrieve SMS Filter Rules](/docs/api-reference/retrieve-sms-filter-rules.md)
- [Submit Received SMS](/docs/api-reference/submit-received-sms.md)
- [Pair Mobile Companion Device](/docs/api-reference/pair-mobile-companion-device.md)
- [List Companion App Notifications](/docs/api-reference/list-companion-app-notifications.md)
- [List SMS Templates](/docs/api-reference/list-sms-templates.md)