Sign In (Soon)
Guide

Getting Started

A preview of the onboarding flow. These steps will work once the platform launches.

Work in Progress — The Villip API and Tenant Portal are under development. The steps below describe the intended onboarding flow and will become functional at launch.
1

Create an Account

Sign up at portal.villip.xyz. You will need a valid email address. No credit card is required to explore the dashboard.

2

Get Your API Key

Once logged in, navigate to Settings > API Keys in the portal. Click Create API Key, give it a name, and copy the Key ID and Key Secret. Store the Key Secret securely as it will not be shown again.

3

Top Up Your Balance

Go to Billing in the portal and add credit to your account. The minimum top-up is £5. Payments are processed via Stripe (card payments).

4

Send Your First SMS

Make an API call from your terminal:

curl -X POST https://api.villip.xyz/v1/sms/messages \
  -H "X-Villip-Key-ID: vk_live_YOUR_KEY_ID" \
  -H "X-Villip-Key-Secret: YOUR_KEY_SECRET" \
  -H "Content-Type: application/json" \
  -d '{"to":"+447700900000","from":"+447700900123","body":"Hello from Villip!"}'

Replace YOUR_KEY_ID and YOUR_KEY_SECRET with your actual credentials and use a real phone number. You should receive the message within seconds.

5

Check Delivery Status

The API response includes a message ID. Use it to check delivery status, or configure a webhook URL in your portal settings to receive real-time delivery receipts.

What Next?